Skip to main content
POST
Invite a team member

Authorizations

Authorization
string
header
required

Your API key, sent as a bearer token. Create one in the control panel under API Keys, give it only the permissions the integration needs, and copy it when it is created. It cannot be shown again. Each key is restricted to one owned team. The key determines the team for every request.

Path Parameters

team
string
required

The team UUID

Example:

"fbb31f5f-bd6f-4019-a3ed-1062a28f56f7"

Body

application/json

Send a JSON object containing the fields below. Required fields are marked in the schema.

email
string<email>
required

The email address.

Maximum string length: 191
role_id
string
required

The role id ID.

Required string length: 36

Response

The record, as a JSON object. There is no envelope.

An offer of a place in a team, waiting for the invited account to answer.

id
string
required

The id ID.

Example:

"72623989-f7f9-4390-87ec-80f42b04b793"

email
string
required

The address as it was invited. Kept rather than read back off the account so the row still reads correctly if the account has changed its email since.

Example:

"isaac.kleiner@blackmesa.example.com"

team
TeamInvitationTeamData · object | null
required

The destination team UUID.

Example:
role
TeamInvitationRoleData · object | null
required

The value of role.

Example:
invited_by
TeamInviterData · object | null
required

The value of invited_by.

Example:
expires_at
string | null
required

When this action or checkout expires, in UTC.

Example:

"2026-09-16T10:05:37+00:00"

has_expired
boolean
required

Whether the resource has expired.

Example:

false

created_at
string | null
required

The date and time for created at, in UTC.

Example:

"2026-09-13T10:05:37+00:00"