Create Invitation

Create an invitation link for the given workspace.

The plaintext token is returned exactly once in the response. The caller delivers it however they want (link, email, Slack).

post/v1/workspaces/{workspace}/invitations

Request

The document declares no server URL.
Auth
HTTP bearer
TypeScript
https://skmtc.dev/agentarea/apis/agentarea-api/docs/v1/workspaces/:workspace/invitations/post.ts
A function with typed inputs. Its response is checked against the schema.

workspacestring required

Slug of the workspace the request acts in

emailstring nullable

Address the invitation is for; omit for an open link anyone can accept

expires_in_daysinteger nullable

Successful Response

accepted_atstring date-time nullable required

accepted_by_user_idstring nullable required

created_atstring date-time required

emailstring nullable required

email_delivery'sent' | 'not_requested' | 'not_configured' | 'failed' required

expires_atstring date-time required

idstring uuid required

invited_bystring required

invited_by_display_namestring nullable required

statusstring required

tokenstring required

workspace_idstring required

Oct 9, 2026565ab1da2abb Revision changes
- breaking
  added the pattern ^[^\s@]+@[^\s@]+\.[^\s@]+$ to the request property /
- warning
  the / request property's maxLength was set to 320