v9

latestOpenAPI 3.0.3raw.githubusercontent.com2026-07-2181734.3 KB
workspaces
users

Create users in workspace

Bulk-creates placeholder agent users in a partner-managed workspace. Each request specifies a count of users to create. For every user the platform: assigns the agent role and activated status, creates a non-login, system-managed email <user_id>-<workspace-id>@partners.timelines.ai, assigns the user to the workspace's Default group, consumes one seat from the workspace. The operation is all-or-nothing: if there are not enough available seats to satisfy count, the request fails with a seats_full error and no users are created. On success the response returns updated seat counters and the list of created users, including their identifiers and metadata needed for downstream QR-link generation.

post/workspaces/{workspace_id}/users

Path parameters

workspace_idstring required

The unique identifier for the workspace.

Headers

X-TL-Partner-Idstring required

The unique identifier for the partner.

Request body

countinteger required

Number of users to create

Example request

{
  "count": 3
}

Response

Users created

workspace_idstring required

Unique identifier for the workspace

seats_totalinteger required

Total number of seats in the workspace

seats_availableinteger required

Number of available seats in the workspace

Example response

{
  "workspace_id": "my-first-workspace",
  "seats_total": 3,
  "seats_available": 2,
  "users": [
    {
      "user_id": 42,
      "display_name": "John Doe",
      "role": "owner",
      "email": "admin@timelines.ai",
      "status": "active",
      "created_at": "2024-01-01T10:00:00Z"
    }
  ]
}