List Clerk invitations

List application invitations in a connected Clerk instance.

← All Clerk endpoints · Capability overview

GET/v1/clerk/invitations

https://api.vee3.io/v1/clerk/invitations

5 tokens

List application invitations in a connected Clerk instance.

Authorization

Send your API key in the Authorization header:

Authorization: Bearer YOUR_API_KEY

MCP

The same capability is available as an MCP tool on Vee3 hosted MCP.

Tool name

clerk.list_invitations

Parameters4 fields

clerk_instance_idstringOptional

Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.

limitintegerOptional

Maximum number of invitations to return (1–500).

Default: 10

offsetintegerOptional

Number of invitations to skip before returning results.

Default: 0

statusstringOptional

Optional status filter: "pending", "accepted", "revoked", or "expired".

Response7 fields

invitationsarrayitems

5 fields

Invitations returned for the requested page.

idstring

Clerk invitation id (inv_...).

email_addressstring

Email address the invitation was sent to.

statusstring

Invitation status: "pending", "accepted", "revoked", or "expired".

created_atinteger

Unix timestamp in milliseconds when the invitation was created.

revokedboolean

Whether the invitation has been revoked.

total_countinteger

Total number of invitations returned on this page.

HTTP errors: clerk_connection_required, clerk_connection_not_found, clerk_connection_invalid, validation_error, unauthorized, payment_required

Example request

Python

import requests

url = "https://api.vee3.io/v1/clerk/invitations"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
}
params = {
    "limit": 10,
    "offset": 0,
    "status": "example"
}

response = requests.get(url, headers=headers, params=params)
response.raise_for_status()
data = response.json()
print(data)

Example responses1 example

200First page of invitations from a connected Clerk instance.

invitation_page.json

{
  "invitations": [
    {
      "id": "inv_2abc123",
      "email_address": "ada@example.com",
      "status": "pending",
      "created_at": 1710000000000,
      "revoked": false
    }
  ],
  "total_count": 1
}