---
title: "View recipients"
method: GET
path: "/payout/v3/recipient"
tags: ["Recipients"]
---

# View recipients

`GET /payout/v3/recipient`

Returns all recipients that meet the specified parameters (if any) and that are associated with the Nexio account used to [authenticate](https://docs.nexiopay.com/docs/authentication).

You may also request to return additional parameters and/or filter results using one or more [query parameters](https://docs.nexiopay.com/docs/filtering-using-query-parameters).

<!-- theme: info -->
> 📘 Notes
>
> For example, to return (filter) all recipients where the address' country is NL and also (request to include) the `recipientIdNumbers` object in the response, the request would look like this:
> <code>/payout/v3/recipient?recipientIdNumbers.&country=NL</code><br/><br/>To return (filter) only the recipient with the specified `recipientRef` parameter, the request would look like this:
> <code>/payout/v3/recipient?recipientRef=10524260</code><br/><br/>For a more detailed tutorial, see the [query parameters](https://docs.nexiopay.com/docs/filtering-using-query-parameters) section of Guides.

<!-- theme: warning -->
> ⚠️ Try It
>
> To use the Try It feature for this endpoint, you must use the credentials for your [Sandbox API user](https://docs.nexiopay.com/docs/sandbox-environments).


<div style="display:none;">

## Request parameters
- limit
- offset
- startDate
- endDate
- recipientId
- recipientRef
- providerRecipientRef
- providerType
- email
- firstName
- lastName
- phoneNumber
- mobileNumber
- addressLine1
- addressLine2
- city
- region
- postalCode
- country
- countryOfBirth
- countryOfNationality
- providerId
- payoutAccountId
- recipientIdNumbers
- recipientIdNumbers.governmentId
- recipientIdNumbers.passportId
- recipientIdNumbers.employerId
- recipientIdNumbers.driversLicenseId
- userType
- birthDate
- gender
- addressType
- phoneNumberCountry
- mobileNumberCountry
- governmentIdType
- createdAt
- updatedAt

## Response parameters
- offset
- limit
- rows
- rows.recipientRef
- rows.recipientId
- rows.payoutAccountId
- rows.providerId
- rows.providerType
- rows.providerRecipientRef
- rows.userType
- rows.firstName
- rows.lastName
- rows.gender
- rows.birthDate
- rows.countryOfBirth
- rows.countryOfNationality
- rows.addressLine1
- rows.addressLine2
- rows.city
- rows.region
- rows.postalCode
- rows.country
- rows.email
- rows.phoneNumber
- rows.mobileNumber
- rows.governmentIdType
- rows.recipientIdNumbers
- rows.recipientIdNumbers.governmentId
- rows.recipientIdNumbers.passportId
- rows.recipientIdNumbers.employerId
- rows.recipientIdNumbers.driversLicenseId
- rows.createdAt
- rows.updatedAt
- hasMore

</div>

## Query parameters

- `limit` integer
- `offset` integer
- `startDate` string
- `endDate` string
- `recipientId` integer
- `recipientRef` string
- `providerRecipientRef` string
- `providerType` 10 | 20 | 30 | 40
- `email` string
- `firstName` string
- `lastName` string
- `phoneNumber` string
- `mobileNumber` string
- `addressLine1` string
- `addressLine2` string
- `city` string
- `region` string
- `postalCode` string
- `country` string
- `countryOfBirth` string
- `countryOfNationality` string
- `providerId` integer
- `payoutAccountId` integer
- `recipientIdNumbers.` string
- `recipientIdNumbers.governmentId` string
- `recipientIdNumbers.passportId` string
- `recipientIdNumbers.employerId` string
- `recipientIdNumbers.driversLicenseId` string
- `userType` 'BUSINESS' | 'INDIVIDUAL'
- `birthDate` string
- `gender` 'FEMALE' | 'MALE'
- `addressType` 'BUSINESS' | 'RESIDENTIAL'
- `phoneNumberCountry` string
- `mobileNumberCountry` string
- `governmentIdType` string
- `createdAt` string
- `updatedAt` string

## Response `200`

OK

- object
  - `offset` integer — The offset indicates how many recipient records were skipped before beginning to return recipients in a response. If both `offset` and `limit` were used together, the offset recipients were skipped before starting to count the recipients to limit.
  - `limit` integer — The maximum number of recipients returned in a response (starting from the default or specified `offset` query parameter).
  - `rows` Schema[] — The `rows` array contains one or more sets of recipient parameters. — unresolved $ref
  - `hasMore` boolean — Will be `true` if there are more records after the current paged response. Use the `limit` and `offset` query parameters to display paged results.

## Other responses

- `401` — Unauthorized. For help with this error and other error codes, see [Common errors](https://docs.nexiopay.com/docs/common-errors) in the Guides area.

---

[API](https://skmtc.dev/nexiopay/apis/payments-api-reference.md) · [All operations](https://skmtc.dev/nexiopay/apis/payments-api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/nexiopay/payments-api-reference/revisions/b414b73979e5/schema)