---
title: "List recipient invites"
method: GET
path: "/recipients/invites"
tags: ["Recipient Invites"]
---

# List recipient invites

`GET /recipients/invites`

Retrieve a paginated list of all recipient invites for your organization. Supports filtering by status.

## Query parameters

- `limit` integer — Maximum number of results to return. Allowed range: 1 to 1000. Defaults to 1000
- `start_after` string — The ID of the recipient invite to start the page after (exclusive). When provided, results will begin with the recipient invite 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 — The ID of the recipient invite 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'
- `status` 'created' | 'completed' | 'expired'

## Response `200`

- RecipientInviteApiPaginatedResponse — API response for listing recipient invites with pagination.
  - `invites` RecipientInviteApiResponse[], required — List of invites in the current page.
    - `contactEmail` string, required — Recipient contact email the invite was created for.
    - `createdAt` string, yyyy-mm-ddThh:MM:ssZ, required — When the invite was created.
    - `expiresAt` string, yyyy-mm-ddThh:MM:ssZ, nullable — When the invite expires, if it has an expiry.
    - `id` string, required — The invite's id, also embedded in 'onboardingUrl'.
    - `name` string, required — Recipient name the invite was created for.
    - `notes` string, nullable — Notes shown to the recipient, if any.
    - `onboardingUrl` string, required — URL where the recipient submits their payment details.
    - `paymentMethods` PaymentMethod[], required — Payment methods the recipient may submit details for.
    - `recipientId` string, uuid, nullable — The existing recipient this invite is for, if any.
    - `requireTaxDocument` boolean, required — Whether the recipient must upload a tax document.
    - `status` 'created' | 'completed' | 'expired', required — Status of the invite.
  - `page` object, required — Pagination cursors (inviteId) for navigating to next/previous pages.
    - `nextPage` string — ID for the invite
    - `previousPage` string — ID for the invite

## Other responses

- `400` — Invalid `status` or `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)