Emails an invitation to join the organisation. The link is valid for 14 days. Inviting an address again replaces the earlier invitation.
HTTP
POST /org/invitesAccess: Session token only. API keys get 403 with insufficient_scope.
Role: Organisation owner or admin.
Request body #
JSON.
| Field | Type | Required | Description |
|---|---|---|---|
email | string | yes | The address to invite. |
role | string | no | admin or member. Default member. |
JSON
{ "email": "grace@example.com", "role": "member" }Response 201 #
The open invitations.
JSON
[
{
"id": "0197a3c3-1f20-7d11-a4c8-6e0b2f7d9a31",
"email": "grace@example.com",
"role": "member",
"sentAt": "2026-10-16T09:30:00+00:00",
"ageMinutes": 5
}
]Response fields #
| Field | Type | Description |
|---|---|---|
id | string | The id of the invitation. |
email | string | The address it was sent to. |
role | string | admin or member. |
sentAt | string | When it was sent. |
ageMinutes | integer | Minutes since it was sent. |
Errors #
| Status | error | When |
|---|---|---|
| 401 | unauthenticated | The token is missing or not valid. |
| 403 | forbidden | You are not an owner or admin. |
| 402 | plan_limit | The plan has no room for another member. Pending invitations count. |
| 422 | invalid_request | email is invalid, already_member, or domain_not_allowed (when the organisation only allows some domains). |
| 429 | rate_limited | Too many requests, see Rate limiting. |
See Errors for the error format.