Reference / Invitations

Create + send an invitation.

POST /v1/invitations

Secret API key operationId: create

Authorization

Server-to-server. Send a secret key as a Bearer token plus the x-application-id header.

Request body · required

email string required
organization_id string<uuid> uuid

Set for an organization invite; omit for an application-level invite.
role string

Role for an org invite (defaults to `member`).

Responses

201 Invitation created

{
  "data": {
    "accepted_user_id": "018f3c4a-7b2e-7c1d-9e0a-1f2b3c4d5e6f",
    "created_at": "2026-01-15T09:30:00Z",
    "email": "string",
    "expires_at": "2026-01-15T09:30:00Z",
    "id": "018f3c4a-7b2e-7c1d-9e0a-1f2b3c4d5e6f",
    "organization_id": "018f3c4a-7b2e-7c1d-9e0a-1f2b3c4d5e6f",
    "role": "string",
    "status": "string",
    "token": "string"
  },
  "error": {
    "code": "string",
    "message": "string"
  },
  "meta": {
    "timestamp": "string"
  },
  "success": false
}

404 Organization not found

409 A pending invite already exists

422 Invalid email/role

Request

curl -X POST "http://localhost:8080/v1/invitations" \
  -H "Content-Type: application/json" \
  -d '{
  "email": "new.user@example.com",
  "organization_id": "018f3c4a-7b2e-7c1d-9e0a-1f2b3c4d5e6f",
  "role": "string"
}'

Try it

live request

POST http://localhost:8080/v1/invitations

Request body

application/json