Sign in

v1

latestOpenAPI 3.1.0raw.githubusercontent.com2026-06-25173140700.7 KB
Invitation

Create invitations

Invite the given email addresses, skipping ones already invited or registered.

post/invitations/

Query parameters

cookie_namestring nullable

Request body

emailsstring[] required

Email addresses to invite; already-invited or existing users are skipped.

tenant_idinteger nullable

Tenant to invite into; defaults to the caller's tenant.

project_idinteger nullable

Optional project to grant the invitees access to.

adminboolean nullable

Whether invitees should be granted tenant admin privileges.

Example request

{
  "emails": [
    "jane.doe@example.com",
    "john.smith@example.com"
  ],
  "tenant_id": 1,
  "project_id": 10
}

Response

Successful Response

idinteger required

Unique identifier of the invitation.

emailstring required

Email address the invitation was sent to.

tenant_idinteger required

Identifier of the tenant the invite belongs to.

project_idinteger nullable required

Project the invite grants access to, if any.

statusstring required

Current invitation status.

created_atstring date-time required

UTC timestamp when the invitation was created.

accepted_atstring date-time nullable required

UTC timestamp when the invitation was accepted, if it was.

revoked_atstring date-time nullable required

UTC timestamp when the invitation was revoked, if it was.

creator_user_idinteger required

Identifier of the user who created the invitation.

Example response

[
  {
    "id": 100,
    "email": "jane.doe@example.com",
    "tenant_id": 1,
    "project_id": 10,
    "status": "PENDING",
    "created_at": "2026-01-15T09:30:00Z",
    "accepted_at": "2026-01-16T12:00:00Z",
    "creator_user_id": 42
  }
]