Skip to main content
GET
Get workspace details

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

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

messages_quota
object
required

Workspace quota details

api_calls_quota
object
required

Workspace quota details

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.

users
object[]
required
whatsapp_accounts
object[]