Docs
OverviewGuidesZero & MCPAPI referenceChangelog
Workspaces

Create Invite

Create a single-use invite link for a role (admin+; `owner` only by owners). The link (`url`, with its `token`) is in this response only. It expires after `expires_in_days` (default 7). 409 if `email_hint` already belongs to a member or the workspace has `INVITE_MAX_PENDING` pending invites. Signed-in users only: an API key gets 403.

API key access

Not available to API keys or connected apps: only a signed-in person can call this route.
POST/api/v1/workspaces/current/invites

Authorization

AuthorizationBearer <token>

Access token from /api/v1/auth/login, or an API key (ro_pat_..., RO-176) from /api/v1/workspaces/current/api-keys: the key implies its workspace and needs the route's scope. MCP connectors (/api/v1/mcp only) may use an OAuth access token (ro_oat_..., RO-284).

In: header

Header Parameters

X-Workspace-Id?string | null

Id of the workspace to act on (must be a member).

Request Body

roleMembershipRole

owner needs the owner role.

Value in"owner" | "admin" | "member"
email_hint?string | null

The invitee's email, as a hint for them and the team.

Lengthlength <= 320
expires_in_days?integer | null

Days the link works (default INVITE_TTL_DAYS, 7).

Formatint64
Range1 <= value <= 30

Response Body

curl -X POST "http://localhost:8000/api/v1/workspaces/current/invites" \  -H "X-Workspace-Id: string" \  -H "Content-Type: application/json" \  -d '{    "role": "owner"  }'
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "role": "owner",
  "email_hint": "string",
  "created_by_email": "string",
  "created_by_name": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "expires_at": "2019-08-24T14:15:22Z",
  "token": "string",
  "url": "string",
  "delivery": "link"
}
Empty
Empty
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

Update Webhook Endpoint

Change the URL, event types, description or enabled flag. Enabling a disabled endpoint resets its failure count.

Create Workspace

Create another workspace; you become its owner (send its id as `X-Workspace-Id` to act in it). At most `WORKSPACES_MAX_OWNED_PER_USER` (10) owned workspaces: 409 `workspace_limit` past it. Signed-in users only: an API key gets 403.