---
title: "Retrieve a paginated list of Recipients by query parameter(s)"
method: GET
path: "/recipients"
tags: ["Recipients"]
---

# Retrieve a paginated list of Recipients by query parameter(s)

`GET /recipients`

## Query parameters

- `payerId` string, uuid, required
- `offset` integer
- `limit` integer

## Headers

- `Trace-Id` string
- `End-User-Agent` string
- `End-User-Ip` string
- `End-User-OS` string
- `End-User-Device-Id` string
- `End-User-Device-Manufacturer` string
- `End-User-Device-Model` string

## Response `200`

A list of Recipients

- object
  - `data` Recipient[]
    - `id` string, uuid
    - `externalId` string — Consumer defined ID that will be attached to this resource
    - `businessName` string
    - `categoryId` string, uuid
    - `businessAddress` RecipientAddress
      - `line1` string, required — Address line 1 (e.g., street, PO Box, or company name).
      - `line2` string — Address line 2 (e.g., apartment, suite, unit, or building).
      - `city` string, required — City, district, suburb, town, or village.
      - `state` string, required — State, county, province, or region.
      - `postalCode` string, required — ZIP or postal code.
      - `country` string, required — Two-letter country code (ISO 3166-1 alpha-2).
    - `contact` object
      - `firstName` string
      - `lastName` string
      - `email` string
      - `phone` string
    - `payer` PayerId
      - `id` string, uuid, required
    - `metadata` RecipientMetadata — Additional Recipient information to support operational requirements
      - `accountSettings` AccountSettingsMetadata
        - `emailConfirmation` boolean — Whether or not the associated entity has confirmed its email.
        - `phoneConfirmation` boolean — Whether or not the associated entity has confirmed its phone number.
        - `singleSignOn` boolean — Whether or not the associated entity uses single-sign-on.
        - `singleSignOnType` string — The single-sign-on service the associated entity uses.
        - `twoFactor` boolean — Whether or not the associated entity uses two-factor authentication.
        - `multiFactor` boolean — Whether or not the associated entity uses multi-factor authentication.
      - `beneficialOwners` BeneficialOwner[]
        - `firstName` string
        - `lastName` string
    - `receivingMethod` union
      - object
        - `type` 'ACH', required
        - `accountNumber` string, required — Bank ACH account number
        - `routingNumber` string, required — 9 digit bank routing number
        - `beneficiaryName` string, required
      - AddressWithNormalization
        - `line1` string, required — Address line 1 (e.g., street, PO Box, or company name).
        - `line2` string — Address line 2 (e.g., apartment, suite, unit, or building).
        - `city` string, required — City, district, suburb, town, or village.
        - `state` string, required — State, county, province, or region.
        - `postalCode` string, required — ZIP or postal code.
        - `country` string, required — Two-letter country code (ISO 3166-1 alpha-2).
        - `normalize` boolean — Normalize address and validate deliverability
      - object
        - `type` 'EFT', required
        - `accountNumber` string, required — Bank EFT account number
        - `routingNumber` string, required — 9 digit routing number (Example Canada EFT: 0IIIBBBBB)
        - `beneficiaryName` string, required
    - `createdAt` string, date-time
    - `status` 'ACTIVE' | 'INACTIVE' | 'UNKNOWN' — The status of an object
  - `pagination` PaginationObject
    - `offset` integer
    - `limit` integer
    - `total` integer
    - `hasNextPage` boolean

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `403` — Forbidden
- `404` — Not found
- `500` — Internal Server Error

---

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