List invitations
List invitations that have not been accepted yet, newest first.
GET
https://api.centerfy.ai/webhooks/inbound/invitations Headers
| Header | Required | Value | Description |
|---|---|---|---|
x-api-key | Yes | your sub-account API key (cfy_…) | Authenticates the request; or use Authorization: Bearer <key>. |
Query parameters
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
limit | integer | No | 50 | Page size; minimum 1, maximum 100 (larger values are rejected with 400). |
offset | integer | No | 0 | Number of records to skip for paging; minimum 0. |
include_expired | boolean | No | true | Set to false to list only invitations that have not expired. |
Example
curl -X GET "https://api.centerfy.ai/webhooks/inbound/invitations?limit=50&offset=0&include_expired=true" \
-H "x-api-key: $CENTERFY_API_KEY" import { CenterfyClient } from "@centerfy/sdk";
const centerfy = new CenterfyClient({ apiKey: process.env.CENTERFY_API_KEY! });
const result = await centerfy.users.listInvitations({
"limit": 50,
"offset": 0,
"include_expired": "true"
});
console.log(result); centerfy users invitations '{"limit":50,"offset":0,"include_expired":"true"}' MCP tool: centerfy_users_list_invitations (see MCP server)
Response
{
"status": "success",
"total": 1,
"limit": 50,
"offset": 0,
"has_more": false,
"invitations": [
{
"id": "5a1e2b3c-4d5e-4f60-8a7b-9c0d1e2f3a4b",
"email": "[email protected]",
"role": "sub_account_user",
"first_name": "Jamie",
"last_name": "Rivera",
"status": "pending",
"expires_at": "2026-10-13T10:00:00.000Z",
"accepted_at": null,
"created_at": "2026-10-06T10:00:00.000Z"
}
]
}Errors
401— if unauthenticated.
Notes
status is pending or expired (accepted invitations are not listed).