v3

latestOpenAPI 3.1.02026-07-311,4541,5202.3 MB

platformApi

Api Workspaces List List

GET/POST /api/workspaces/list/

Paginated, searchable list of the caller's workspaces (company orgs). "workspace" is the product term for CompanyOrganization. POST is the filtering/search verb (POST-for-Filtering convention; the /list/ suffix makes the permission stack treat POST as a read — no extra opt-in needed).

JWT-only (no API-key auth): user-centric switcher endpoint ("my workspaces"), like CompanyOrganizationsView. An org-scoped API key must not enumerate every workspace on the underlying user account.

get/api/workspaces/list/

Query parameters

pageinteger

A page number within the paginated result set.

page_sizeinteger

Number of results to return per page.

Headers

Authorizationstring required

JWT access token or Respan API key

Response

countinteger required

nextstring uri nullable

previousstring uri nullable

total_countinteger

current_filtersFilterParamDictPydantic

Pydantic model for FilterParamDict. A dictionary that maps metric names to their filter parameters.

Each key is a metric name (str), and each value can be:

A single MetricFilterParamPydantic (one condition)
A List[MetricFilterParamPydantic] (multiple conditions for same metric)
A FilterBundlePydantic (nested filter bundle with connector)

Note: Uses extra="allow" for dynamic metric name fields. The pydantic_extra annotation tells Pydantic what types to expect for extra fields, and generates typed additionalProperties in JSON Schema.

filters_dataPaginatedWorkspaceListListFiltersData