Recipients
Get all recipients
Retrieve a paginated list of all recipients. Use cursor parameters (start_after, end_before) for pagination.
get/recipients
Query parameters
limitinteger
Maximum number of results to return. Allowed range: 1 to 1000. Defaults to 1000
start_afterstring 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_beforestring 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
Example response
{
"recipients": [
{
"attachments": [
{
"uploadedAt": "2016-07-22T00:00:00Z"
}
],
"dateLastPaid": "2016-07-22T00:00:00Z"
}
]
}