Skip to main content
GET
/
v1
/
invitations
List invitations
curl --request GET \
  --url https://api.zavu.dev/v1/invitations \
  --header 'Authorization: Bearer <token>'
{
  "items": [
    {
      "id": "inv_abc123",
      "url": "https://dashboard.zavu.dev/invite/abc123xyz",
      "token": "<string>",
      "expiresAt": "2023-11-07T05:31:56Z",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "clientName": "<string>",
      "clientEmail": "<string>",
      "clientPhone": "<string>",
      "phoneNumberId": "<string>",
      "senderId": "<string>",
      "viewedAt": "2023-11-07T05:31:56Z",
      "startedAt": "2023-11-07T05:31:56Z",
      "completedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "nextCursor": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
status
enum<string>

Current status of the partner invitation.

Available options:
pending,
in_progress,
completed,
expired,
cancelled
​
limit
integer
default:50
Required range: x <= 100
​
cursor
string

Response

List of invitations.

​
items
object[]
required
​
nextCursor
string | null