Organization Invites
Send, resend, and revoke team invitations
Invite new members to your organization by email. Invites can be resent or revoked before they are accepted.
Send Invite
POST /api/v1/organization/:orgId/invitesMinimum role: admin
Sends an email invitation to join the organization.
Request Body
| Field | Type | Required | Description |
|---|---|---|---|
email | string | Yes | Email address of the invitee |
role | string | No | Role to assign on acceptance. Defaults to member |
Example Request
{
"email": "carol@example.com",
"role": "viewer"
}Response
{
"id": "inv_abc123",
"email": "carol@example.com",
"role": "viewer",
"status": "pending",
"created_at": "2026-04-10T08:00:00.000Z",
"expires_at": "2026-04-17T08:00:00.000Z"
}Accept Invite
POST /api/v1/organization/invites/acceptMinimum role: any authenticated user
Accepts a pending invitation using the token from the invite email. The caller is added to the organization with the role specified in the invite.
Request Body
| Field | Type | Required | Description |
|---|---|---|---|
token | string | Yes | The invitation token from the email link |
Example Request
{
"token": "inv_token_xxxxxxxxxxxxxxxx"
}Response
{
"org_id": "org_abc",
"role": "viewer",
"status": "active"
}Revoke Invite
DELETE /api/v1/organization/:orgId/invites/:inviteIdMinimum role: admin
Revokes a pending invitation. The invite link becomes invalid immediately.
Path Parameters
| Parameter | Type | Description |
|---|---|---|
inviteId | string | The invite identifier |
Response
{
"success": true
}Resend Invite
POST /api/v1/organization/:orgId/invites/:inviteId/resendMinimum role: admin
Resends the invitation email for a pending invite.
Path Parameters
| Parameter | Type | Description |
|---|---|---|
inviteId | string | The invite identifier |
Response
{
"success": true
}