Read the counts behind every settings screen
Counts for every settings screen, in one call.
/v1/workspace/overviewViewer- Operation id
- settings_overview
- Access
- Any workspace role can call this.
/v1/workspace/overviewCounts for every settings screen, in one call.
This is what fills in the numbers on the settings hub: how many members, how many teams, macros, SLA policies and so on. One round trip rather than one call per card.
Counts only. For the rows behind a number, call that screen's own operation.
Tenancy: the request is scoped to one workspace, and the credential presented is what selects it. A caller with no membership in that workspace is refused with 404, which is indistinguishable from a workspace that does not exist.
Authorisation: any workspace role, including viewer. Reads are open to every member.
Access: Authorization: Bearer carrying either a realm access token or an API key. A key must hold the workspace-admin:read scope, and the workspace role of the person who owns it must meet the floor above.
A realm-issued access token, presented as Authorization: Bearer <token>. It acts as the person who signed in, and every operation resolves their workspace role live from the membership record.
In: header
Response Body
application/json
application/json
curl -X GET "https://example.com/v1/workspace/overview"{}