Recipient Invites
List recipient invites
Retrieve a paginated list of all recipient invites for your organization. Supports filtering by status.
get/recipients/invites
Query parameters
limitinteger
Maximum number of results to return. Allowed range: 1 to 1000. Defaults to 1000
start_afterstring
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_beforestring
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
Example response
{
"invites": [
{
"createdAt": "2016-07-22T00:00:00Z",
"expiresAt": "2016-07-22T00:00:00Z"
}
]
}