---
title: "Get all recipients"
method: GET
path: "/recipients"
tags: ["Recipients"]
---

# Get all recipients

`GET /recipients`

Retrieve a paginated list of all recipients. Use cursor parameters (start_after, end_before) for pagination.

## Query parameters

- `limit` integer — Maximum number of results to return. Allowed range: 1 to 1000. Defaults to 1000
- `start_after` string, uuid — The ID of the recipient to start the page after (exclusive). When provided, results will begin with the recipient immediately following this ID. Use this for standard forward pagination to get the next page of results. Cannot be combined with end_before.
- `end_before` string, uuid — The ID of the recipient to end the page before (exclusive). When provided, results will end just before this ID and work backwards. Use this for reverse pagination or to retrieve previous pages. Cannot be combined with start_after.
- `order` 'asc' | 'desc' — Sort order. Can be 'asc' or 'desc'. Defaults to 'asc'

## Response `200`

- RecipientsPaginatedResponse
  - `page` object, required — Pagination information including cursors for navigating to next/previous pages
    - `nextPage` string, uuid — ID for the recipient
    - `previousPage` string, uuid — ID for the recipient
  - `recipients` RecipientInfo[], required — List of recipients in the current page
    - `address` Address
      - `address1` string, required
      - `address2` string, nullable
      - `city` string, required
      - `country` string, required
      - `name` string, required
      - `postalCode` string, required
      - `region` string, required
    - `attachments` RecipientAttachment[], required
      - `fileName` string, required — Name of the uploaded file
      - `formType` 'w9' | 'w8BEN' | 'w8BENE' | 'unknown', nullable — The tax form type (W-9 for US persons, W-8BEN for foreign individuals, W-8BEN-E for foreign entities)
      - `uploadedAt` string, yyyy-mm-ddThh:MM:ssZ, required — Timestamp when the attachment was uploaded
      - `url` string, required — Presigned URL to download the attachment (valid for 12 hours)
    - `checkInfo` CheckInfo
      - `address` AddressWithoutName, required
        - `address1` string, required
        - `address2` string, nullable
        - `city` string, required
        - `country` string, required
        - `postalCode` string, required
        - `region` string, required
    - `contactEmail` string
    - `dateLastPaid` string, yyyy-mm-ddThh:MM:ssZ
    - `defaultAddress` AddressWithoutName
      - `address1` string, required
      - `address2` string, nullable
      - `city` string, required
      - `country` string, required
      - `postalCode` string, required
      - `region` string, required
    - `defaultPaymentMethod` 'ach' | 'check' | 'domesticWire' | 'internationalWire' | 'realTimePayment', required
    - `domesticWireRoutingInfo` DomesticWireRoutingInfo
      - `accountNumber` string, required
      - `address` AddressWithoutName
        - `address1` string, required
        - `address2` string, nullable
        - `city` string, required
        - `country` string, required
        - `postalCode` string, required
        - `region` string, required
      - `bankName` string, nullable
      - `routingNumber` string, required
    - `electronicRoutingInfo` ElectronicRoutingInfo
      - `accountNumber` string, required
      - `address` AddressWithoutName
        - `address1` string, required
        - `address2` string, nullable
        - `city` string, required
        - `country` string, required
        - `postalCode` string, required
        - `region` string, required
      - `bankName` string, nullable
      - `electronicAccountType` 'businessChecking' | 'businessSavings' | 'personalChecking' | 'personalSavings', required
      - `routingNumber` string, required
    - `emails` Email[], required
    - `id` string, uuid, required — ID for a Mercury account.
    - `internationalWireRoutingInfo` InternationalWireRoutingInfo
      - `address` AddressWithoutName
        - `address1` string, required
        - `address2` string, nullable
        - `city` string, required
        - `country` string, required
        - `postalCode` string, required
        - `region` string, required
      - `bankDetails` SwiftCodeData
        - `bankCityState` string, required
        - `bankCountry` string, required
        - `bankName` string, required
      - `correspondentInfo` InternationalWireCorrespondentInfo
        - `bankName` string, nullable
        - `routingNumber` string, nullable
        - `swiftCode` string, nullable
      - `countrySpecific` InternationalWireCountrySpecificData, required
        - `australia` InternationalWireAustraliaSpecificData
          - `bsbCode` string, required
        - `brazil` InternationalWireBrazilSpecificData
          - `legalId` string, required
        - `canada` InternationalWireCanadaSpecificData
          - `bankCode` string, required
          - `transitNumber` string, required
        - `chile` InternationalWireChileSpecificData
          - `legalId` string, required
        - `colombia` InternationalWireColombiaSpecificData
          - `legalId` string, required
        - `dominicanRepublic` InternationalWireDominicanRepublicSpecificData
          - `accountType` 'checking' | 'savings', required
          - `legalId` string, required
        - `honduras` InternationalWireHondurasSpecificData
          - `accountType` 'checking' | 'savings', required
          - `legalId` string, required
        - `india` InternationalWireIndiaSpecificData
          - `ifscCode` string, required
        - `kazakhstan` InternationalWireKazakhstanSpecificData
          - `legalId` string, required
        - `pakistan` InternationalWirePakistanSpecificData
          - `legalId` string, required
          - `legalIdType` 'CNIC' | 'SNIC' | 'Passport' | 'NTN', required
        - `paraguay` InternationalWireParaguaySpecificData
          - `legalId` string, required
        - `philippines` InternationalWirePhilippinesSpecificData
          - `routingNumber` string, required
        - `russia` InternationalWireRussiaSpecificData
          - `inn` string, required
        - `southAfrica` InternationalWireSouthAfricaSpecificData
          - `branchCode` string, required
      - `emailAddress` string, nullable
      - `iban` string, required
      - `phoneNumber` string, nullable
      - `swiftCode` string, required
    - `inviteId` string
    - `isBusiness` boolean, nullable
    - `name` string, required
    - `nickname` string, nullable
    - `realTimePaymentRoutingInfo` RealTimePaymentRoutingInfo
      - `accountNumber` string, required
      - `address` AddressWithoutName
        - `address1` string, required
        - `address2` string, nullable
        - `city` string, required
        - `country` string, required
        - `postalCode` string, required
        - `region` string, required
      - `bankName` string, nullable
      - `routingNumber` string, required
    - `status` 'active' | 'deleted', required
  - `total` integer, required — Total number of recipients in the current page

## Other responses

- `400` — Invalid `order` or `end_before` or `start_after` or `limit`

---

[API](https://skmtc.net/mercurytechnologies/apis/mercury-api.md) · [All operations](https://skmtc.net/mercurytechnologies/apis/mercury-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/mercurytechnologies/mercury-api/revisions/0bdf4a496e03/schema)