API Reference
Invitations
Create, list, and revoke team member invitations.
Create an Invitation
POST/invitations
Create an invitation
Request Body
| Field | Type | Description |
|---|
email* | string | |
role* | "admin" | "member" | |
Responses
201Invitation created
| Field | Type | Description |
|---|
id | string | |
org_id | string | |
email | string | |
role | "admin" | "member" | |
invited_by | string | null | |
token | string | |
expires_at | string | |
accepted_at | string | null | |
revoked_at | string | null | |
created_at | string | |
updated_at | string | |
400Validation error
| Field | Type | Description |
|---|
error* | object | |
401Unauthorized
| Field | Type | Description |
|---|
error* | object | |
403Forbidden or seat limit exceeded
| Field | Type | Description |
|---|
error* | object | |
409Already a member or duplicate invitation
| Field | Type | Description |
|---|
error* | object | |
List Invitations
GET/invitations
List invitations
Parameters
| Name | Type | In | Description |
|---|
limit | integer | query | |
offset | integer | query | |
status | "pending" | "accepted" | "revoked" | "expired" | "all" | query | |
Responses
200List of invitations
| Field | Type | Description |
|---|
data | object[] | |
pagination | object | |
401Unauthorized
| Field | Type | Description |
|---|
error* | object | |
403Forbidden
| Field | Type | Description |
|---|
error* | object | |
Revoke an Invitation
DELETE/invitations/{id}
Revoke an invitation
Parameters
| Name | Type | In | Description |
|---|
id* | string | path | |
Responses
200Revoked invitation
| Field | Type | Description |
|---|
id | string | |
org_id | string | |
email | string | |
role | "admin" | "member" | |
invited_by | string | null | |
token | string | |
expires_at | string | |
accepted_at | string | null | |
revoked_at | string | null | |
created_at | string | |
updated_at | string | |
400Invalid ID, already accepted, already revoked, or expired
| Field | Type | Description |
|---|
error* | object | |
401Unauthorized
| Field | Type | Description |
|---|
error* | object | |
403Forbidden
| Field | Type | Description |
|---|
error* | object | |
404Not found
| Field | Type | Description |
|---|
error* | object | |