> ## Documentation Index > Fetch the complete documentation index at: https://docs.slash.com/llms.txt > Use this file to discover all available pages before exploring further. # List recipients > List the selected legal entity's recipients, the people and businesses it pays. ## OpenAPI ````yaml /openapi-v2.json get /v2/recipients openapi: 3.1.0 info: title: Slash Public API V2 description: >- Send money for a Slash legal entity. Every request uses an API key. Transfer creation returns a Transfer that links its resulting transactions. version: 0.0.1 servers: - url: https://api.slash.com description: production security: - api_key: [] paths: /v2/recipients: parameters: - name: x-legal-entity in: header required: true description: >- The legal entity to act on. Required on every request; a user API key can act on any legal entity its user has access to. schema: type: string pattern: ^le_[a-zA-Z0-9]+$ get: summary: List recipients description: >- List the selected legal entity's recipients, the people and businesses it pays. parameters: - name: cursor in: query required: false description: >- The opaque `metadata.nextCursor` value from the previous page. It carries that page's filters, page size and ordering, so pass it on its own; see [Pagination](/docs/v2/get-started/pagination). schema: type: string - name: limit in: query required: false description: >- Number of items per page, from 1 to 100. The page size is carried inside `metadata.nextCursor`, so later pages keep the same size unless `limit` is passed again to change it. schema: type: integer minimum: 1 maximum: 100 - name: sort in: query required: false description: >- Field to order the page by. Each value has its own default direction, used unless `sortDirection` is passed. See [Sorting](/docs/v2/get-started/pagination#sorting). - `createdAt` (default) — descending - `name` — ascending - `lastPaidAt` — the most recent payment to the recipient, with recipients that have never been paid last; descending schema: type: string enum: - createdAt - name - lastPaidAt default: createdAt - name: sortDirection in: query required: false description: >- Direction of the ordering selected by `sort`. When omitted, each `sort` value uses its own default; see [Sorting](/docs/v2/get-started/pagination#sorting). schema: type: string enum: - asc - desc - name: recipientType in: query required: false description: Return only people (`contact`) or only businesses (`vendor`). schema: type: string enum: - contact - vendor - name: includeArchived in: query required: false description: Include archived recipients. Defaults to false. schema: type: boolean default: false responses: '200': description: A page of recipients. content: application/json: schema: type: object properties: items: type: array items: $ref: '#/components/schemas/recipient' metadata: $ref: '#/components/schemas/pagination-metadata' required: - items - metadata additionalProperties: false '400': $ref: '#/components/responses/PublicApiV2Error400RecipientsList' '401': $ref: '#/components/responses/PublicApiV2Error401Unauthorized' '403': $ref: >- #/components/responses/PublicApiV2Error403ForbiddenLegalEntityNotAvailableUserApiKeyRequired '404': $ref: '#/components/responses/PublicApiV2Error404NotFound' '429': $ref: '#/components/responses/PublicApiV2RateLimited' '500': $ref: '#/components/responses/PublicApiV2Error500Internal' security: - api_key: [] components: schemas: recipient: title: Recipient description: >- A person or business you pay, and the owner of the destinations you pay them at. type: object properties: id: type: string description: Recipient id. name: type: string description: Display name visible to your organization. recipientType: type: string description: >- `contact` is a person (shown as "Person" in the Slash dashboard); `vendor` is a business. enum: - contact - vendor recipientLegalName: type: string recipientEmail: type: string address: $ref: '#/components/schemas/address' status: type: string enum: - active - archived createdAt: type: string format: date-time archivedAt: type: string format: date-time required: - id - name - recipientType - recipientLegalName - status - createdAt additionalProperties: false pagination-metadata: title: PaginationMetadata type: object properties: nextCursor: type: string description: Opaque cursor for the next page. Omitted on the final page. count: type: integer minimum: 0 description: Number of items in this page. required: - count additionalProperties: false address: title: Address type: object properties: line1: type: string minLength: 1 line2: type: string city: type: string minLength: 1 state: type: string postalCode: type: string countryCode: type: string minLength: 2 maxLength: 2 description: ISO 3166-1 alpha-2 country code. required: - line1 - city additionalProperties: false PublicApiV2ErrorInvalidRequestShape: title: PublicApiV2ErrorInvalidRequestShape description: >- The body, query, or headers failed validation, or a required header is missing. `details` has one entry per failing location, keyed by JSON pointer or header name. allOf: - $ref: '#/components/schemas/Error' - type: object properties: code: type: string enum: - invalid_request details: type: object properties: {} additionalProperties: type: string required: - code - details PublicApiV2ErrorUnauthorized: title: PublicApiV2ErrorUnauthorized description: API key authentication is missing or invalid. allOf: - $ref: '#/components/schemas/Error' - type: object properties: code: type: string enum: - unauthorized details: type: object properties: {} additionalProperties: false required: - code - details PublicApiV2ErrorForbiddenLegalEntity: title: PublicApiV2ErrorForbiddenLegalEntity description: The credential is not permitted to act for the selected legal entity. allOf: - $ref: '#/components/schemas/Error' - type: object properties: code: type: string enum: - forbidden details: type: object properties: {} additionalProperties: false required: - code - details PublicApiV2ErrorNotAvailable: title: PublicApiV2ErrorNotAvailable description: >- Public API v2 is not yet available. Use [Public API v1](https://docs.slash.com/introduction) in the meantime. allOf: - $ref: '#/components/schemas/Error' - type: object properties: code: type: string enum: - not_available details: type: object properties: {} additionalProperties: false required: - code - details PublicApiV2ErrorUserApiKeyRequired: title: PublicApiV2ErrorUserApiKeyRequired description: >- The API key is scoped to a legal entity rather than a user. Every v2 request needs a user API key, created under Settings → API keys in the Slash dashboard, together with the `x-legal-entity` header. allOf: - $ref: '#/components/schemas/Error' - type: object properties: code: type: string enum: - user_api_key_required details: type: object properties: {} additionalProperties: false required: - code - details PublicApiV2ErrorNotFound: title: PublicApiV2ErrorNotFound description: >- No resource matches the identifier. When the identifier is a field of the request, `details` names that `field` and the `id` it received. allOf: - $ref: '#/components/schemas/Error' - type: object properties: code: type: string enum: - not_found details: type: object properties: field: type: string description: Dot path of the request field at fault. id: type: string description: The identifier that field carried, when it is one. additionalProperties: false required: - code - details PublicApiV2ErrorInternal: title: PublicApiV2ErrorInternal description: >- Slash could not complete the request. Quote `referenceId` when contacting Slash support. allOf: - $ref: '#/components/schemas/Error' - type: object properties: code: type: string enum: - internal details: type: object properties: {} additionalProperties: false required: - code - details Error: type: object properties: code: type: string description: >- Machine-readable reason; branch on this, not on `message`. Every code an endpoint can return is listed on its reference page; the ones shared by all endpoints are explained in the Errors guide. example: invalid_request message: type: string description: >- Human-readable explanation, safe to show to an operator. Wording may change; use `code` and `details` programmatically. details: type: object description: >- The values behind `message`, keyed per `code`. For example `insufficient_funds` carries `available` and `requested`; `invalid_request` from contract validation carries one entry per failing field, keyed by JSON pointer. Empty when the code has no variable data. additionalProperties: type: string example: available: $120.00 requested: $500.00 referenceId: type: string description: Unique id of this failure. Quote it when contacting Slash support. example: 4001-2alj5if required: - code - message - details - referenceId additionalProperties: false title: Error responses: PublicApiV2Error400RecipientsList: description: >- - `invalid_request (request shape)` — The body, query, or headers failed validation, or a required header is missing. `details` has one entry per failing location, keyed by JSON pointer or header name. content: application/json: schema: $ref: '#/components/schemas/PublicApiV2ErrorInvalidRequestShape' examples: invalid_request_request_shape: summary: invalid_request (request shape) value: code: invalid_request message: >- Invalid `cursor`: The pagination cursor is not one this API issued. details: /cursor: The pagination cursor is not one this API issued. referenceId: 4001-2alj5if PublicApiV2Error401Unauthorized: description: '- `unauthorized` — API key authentication is missing or invalid.' content: application/json: schema: $ref: '#/components/schemas/PublicApiV2ErrorUnauthorized' examples: unauthorized: summary: unauthorized value: code: unauthorized message: API key authentication is missing or invalid. details: {} referenceId: 4011-2alj5if PublicApiV2Error403ForbiddenLegalEntityNotAvailableUserApiKeyRequired: description: >- - `forbidden (legal entity)` — The credential is not permitted to act for the selected legal entity. - `not_available` — Public API v2 is not yet available. Use [Public API v1](https://docs.slash.com/introduction) in the meantime. - `user_api_key_required` — The API key is scoped to a legal entity rather than a user. Every v2 request needs a user API key, created under Settings → API keys in the Slash dashboard, together with the `x-legal-entity` header. content: application/json: schema: anyOf: - title: forbidden (legal entity) allOf: - $ref: '#/components/schemas/PublicApiV2ErrorForbiddenLegalEntity' - title: not_available allOf: - $ref: '#/components/schemas/PublicApiV2ErrorNotAvailable' - title: user_api_key_required allOf: - $ref: '#/components/schemas/PublicApiV2ErrorUserApiKeyRequired' examples: forbidden_legal_entity: summary: forbidden (legal entity) value: code: forbidden message: This credential is not permitted to do that. details: {} referenceId: 4031-2alj5if not_available: summary: not_available value: code: not_available message: >- Public API v2 is not yet available. Use Public API v1 (https://docs.slash.com/introduction) in the meantime. details: {} referenceId: 4031-2alj5if user_api_key_required: summary: user_api_key_required value: code: user_api_key_required message: >- Public API v2 requires a user API key. Create one under Settings → API keys in the Slash dashboard. details: {} referenceId: 4031-2alj5if PublicApiV2Error404NotFound: description: >- - `not_found` — No resource matches the identifier. When the identifier is a field of the request, `details` names that `field` and the `id` it received. content: application/json: schema: $ref: '#/components/schemas/PublicApiV2ErrorNotFound' examples: not_found: summary: not_found value: code: not_found message: The requested resource was not found. details: {} referenceId: 4041-2alj5if PublicApiV2RateLimited: description: >- The request exceeded the applicable rate limit. The response body is plain text, not the error object; clients must not depend on its wording. content: text/plain: schema: type: string example: You are rate limited PublicApiV2Error500Internal: description: >- - `internal` — Slash could not complete the request. Quote `referenceId` when contacting Slash support. content: application/json: schema: $ref: '#/components/schemas/PublicApiV2ErrorInternal' examples: internal: summary: internal value: code: internal message: >- An unexpected error occurred. If this keeps happening, contact Slash support with the reference id below. details: {} referenceId: 5001-2alj5if securitySchemes: api_key: type: apiKey name: X-API-Key in: header description: >- User API key authentication. Create a key under Settings → API keys in the Slash dashboard (https://app.slash.com/global-settings/api-keys) and send the `x-legal-entity` header naming the legal entity to act on with every request. Keys scoped to a legal entity are rejected with `403 user_api_key_required`. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.