API DescriptionSettingsFAQ
API Reference

Get all recipients

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

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

Query Params
int64
1 to 1000
Defaults to 1000

Maximum number of results to return. Allowed range: 1 to 1000. Defaults to 1000

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.

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.

string
enum
Defaults to asc

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

Allowed:
Responses

400

Invalid order or end_before or start_after or limit

Updated 4 months ago

Language
Credentials
Bearer
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 4 months ago