Get workspace details

Returns a consolidated, read-only summary of a partner-managed workspace. The payload includes basic workspace identity (workspace_id, display_name), seat allocation and utilization, messaging and API quotas, any non-recurring quota balance, the list of users in the workspace, WhatsApp accounts associated with the workspace, and currently active QR-code links. Only workspaces that are owned by the calling partner and are not -billing managed are eligible. If the workspace does not exist or is not linked to the partner, a 404 error is returned.

GET /workspaces/{workspace_id}

Get workspace details

cURL

curl --request GET \
  --url https://app.timelines.ai/partner/api/v1/workspaces/{workspace_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'X-TL-Partner-Id: <x-tl-partner-id>'

200

{
  "workspace_id": "ws_1234567890abcdef",
  "display_name": "my-first-workspace",
  "seats": {
    "total": 10,
    "used": 7,
    "period_start": "2024-01-01T00:00:00Z",
    "period_end": "2024-12-31T23:59:59Z"
  },
  "messages_quota": {
    "total": 10,
    "used": 7,
    "period_start": "2024-01-01T00:00:00Z",
    "period_end": "2024-12-31T23:59:59Z"
  },
  "api_calls_quota": {
    "total": 10,
    "used": 7,
    "period_start": "2024-01-01T00:00:00Z",
    "period_end": "2024-12-31T23:59:59Z"
  },
  "non_recurring_quota": {
    "remaining_balance": 50,
    "last_updated_at": "2024-01-10T12:00:00Z"
  },
  "users": [
    {
      "user_id": 42,
      "display_name": "John Doe",
      "email": "[e-mail]",
      "status": "active",
      "created_at": "2024-01-01T10:00:00Z",
      "role": "owner"
    }
  ],
  "whatsapp_accounts": [
    {
      "connected": true,
      "whatsapp_account_id": 987654321,
      "phone_number_e164": "[phone]",
      "connection_status": "connected",
      "user_id": "wa_abcdef123456",
      "connected_at": "2024-01-15T10:00:00Z"
    }
  ],
  "qr_links": [
    {
      "qr_link": "https://timelines.ai/qr/abcdef123456",
      "user_id": 42,
      "expires_at": "2024-01-02T10:00:00Z"
    }
  ]
}

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.

Response

200

application/json

Workspace details

Detailed summary of a partner-managed workspace. Combines core workspace identity with seat usage, messaging and Public API quotas, non-recurring quota balances, the list of users, WhatsApp accounts associated with the workspace, and active QR links. Used by partners to monitor utilization and operational health of a workspace in a single call.

workspace_id · string · required

Unique identifier for the workspace

Example:

"ws_1234567890abcdef"

display_name · string · required

Workspace display name

Example:

"my-first-workspace"

seats · object · required

Workspace quota details

Show child attributes

messages_quota · object · required

Workspace quota details

Show child attributes

api_calls_quota · object · required

Workspace quota details

Show child attributes

non_recurring_quota · object · required

Non-recurring quota information for a workspace. Represents an additional, non-recurring balance (for example, one-off purchased message packs) with the remaining_balance and the timestamp when it was last updated.

Show child attributes

users · object[] · required

Show child attributes

whatsapp_accounts · object[]

Show child attributes

qr_links · object[]

Show child attributes