v2

latestOpenAPI 3.0.02026-07-26365590.3 KB

Workspaces

Get stats aggregated by workspace

Returns call, contact, and sequence stats per workspace. Scope is limited to the API key's accessible workspaces.

get/v1/workspaces/stats

Query parameters

period'day' | 'week' | 'month' | 'custom' required

Example:week

startDatestring

Example:2026-01-01

endDatestring

Example:2026-01-31

workspaceIdstring

Filter by workspace ID (must be within API key scope)

Response

Workspace stats response

Example response

{
  "aggregate": {
    "totalCalls": 1250,
    "totalCallDuration": 45000,
    "totalContacts": 3400,
    "activeSequences": 12
  },
  "workspaces": [
    {
      "workspaceId": "123e4567-e89b-12d3-a456-426614174000",
      "workspaceName": "Sales",
      "calls": 450,
      "callDuration": 15000,
      "contacts": 1200,
      "activeSequences": 4,
      "members": 5
    }
  ]
}