workspaces
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}
Path parameters
workspace_idstring required
The unique identifier for the workspace.
Headers
X-TL-Partner-Idstring required
The unique identifier for the partner.
Response
Workspace details
Example response
{
"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"
},
"whatsapp_accounts": [
{
"connected": true,
"whatsapp_account_id": 987654321,
"phone_number_e164": "+1234567890",
"connection_status": "connected",
"connected_at": "2024-01-15T10:00:00Z"
}
],
"non_recurring_quota": {
"remaining_balance": 50,
"last_updated_at": "2024-01-10T12:00:00Z"
},
"users": [
{
"user_id": 42,
"display_name": "John Doe",
"role": "owner",
"email": "admin@timelines.ai",
"status": "active",
"created_at": "2024-01-01T10:00:00Z"
}
],
"qr_links": [
{
"qr_link": "https://timelines.ai/qr/abcdef123456",
"user_id": 42,
"expires_at": "2024-01-02T10:00:00Z"
}
]
}