Skip to main content
POST
Invite someone to the workspace

Authorizations

Authorization
string
header
required

Personal API key, e.g. Authorization: Bearer sajn_sk_.... Not scope-limited — acts as the issuing user.

Headers

Sajn-Version
enum<string>

API version for this request. Without it, the request uses the organization's default version; an organization without a default is pinned to the latest version by its first request.

Available options:
2026-09,
2026-10
Idempotency-Key
string

Makes retries safe. A retry with the same key and the same request replays the stored response for 24 hours (header Idempotent-Replayed: true); the same key with a different request returns 400.

Maximum string length: 255

Body

application/json

Body

Invite someone to the workspace

email
string<email>
required

Email address of the person to invite. They must not be a member of the organization.

Pattern: ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$
roleId
string
required

Workspace role ID the invitee gets on accepting. To list roles, call GET /api/v1/roles.

Response

An invitation to join the workspace

An invitation to join the workspace

id
string
required

Invitation ID

email
string
required
role
object
required

The workspace role the invitee gets on accepting

status
enum<string>
required

PENDING until the invitee accepts, then ACCEPTED

Available options:
DRAFT,
PENDING,
ACCEPTED,
DECLINED
invitedBy
object
required

The member who sent the invitation

createdAt
string<date-time>
required

When the invitation was created.

expiresAt
string<date-time> | null
required