List recipient invites

get

https://api.mercury.com/api/v1/recipients/invites

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

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

limit

int64

1 to 1000

Defaults to 1000

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

string

enum

Defaults to asc

Sort order. Can be 'asc' or 'desc'. Defaults to 'asc'

Allowed:

status

string

enum

Allowed:

Responses

400

Invalid status or order or end_before or start_after or limit

Language

Credentials

Bearer

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200