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

Create users in workspace

cURL

curl --request POST \
  --url https://app.timelines.ai/partner/api/v1/workspaces/{workspace_id}/users \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-TL-Partner-Id: <x-tl-partner-id>' \
  --data '{
  "count": 3
}'

201

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

Authorizations

Authorization · string · header · required

JWT bearer authentication. The token payload must include partner_id, nbf (not-before) and exp (expiry) claims. All Partner API requests must be authenticated with Authorization: Bearer .

Headers

X-TL-Partner-Id · string · required

The unique identifier for the partner.

Path Parameters

workspace_id · string · required

The unique identifier for the workspace.

Body

application/json

User creation request payload

Request payload for bulk-creating placeholder agent users in a workspace. The count field specifies how many users to provision in a single all-or-nothing operation, subject to available seats in the workspace.

count · integer · required

Number of users to create

Required range: 1 <= x <= 99

Example:

3

Response

201

application/json

Users created

Response payload for bulk user creation. Contains the workspace_id, updated seat counters (seats_total and seats_available), and the list of created users with their identifiers and metadata. This response is typically consumed to track which agents were provisioned for QR-link generation.

workspace_id · string · required

Unique identifier for the workspace

Example:

"my-first-workspace"

seats_total · integer · required

Total number of seats in the workspace

Example:

3

seats_available · integer · required

Number of available seats in the workspace

Example:

2

users · object[] · required

Show child attributes