Skip to main content
GET
List all invites

Authorizations

Authorization
string
header
required

Username = api_key_id, Password = api_key_secret

Query Parameters

status
string

Filter invites by status.

Multiple status values can be searched at once using either method:

  1. /v2/invites?status=sent,initiated
  2. /v2/invites?status=sent&status=initiated
reply_to
string

Filter invites for a specific reply_to email.

limit
integer

Number of invite objects returned per page. Default: 10. Maximum: 200.

cursor
string

The URL returned in next or previous used to retrieve another page of results.

Response

200 - application/json
next
string<uri> | null

URL for the next page of results, if available.

previous
string<uri> | null

URL for the previous page of results, if available.

results
object[]