Agency workspaces
GET/workspaces
An agency's group: its own account and one workspace per client, all on the same subscription, with what each one consumed in the billing period — connected numbers, contacts and messages. It is what an integration uses to pass the cost on to each client.
Only the agency account's key without a number restriction reads the group. A key
limited to numbers gets 403, and a workspace's key gets 409 not_principal: a client
never learns about the others.
Creating, renaming and deleting workspaces happens in the panel, not through the API.
Responses
- 200
- 401
- 403
- 409
- 429
The group.
Missing, malformed, unknown or revoked token (authentication), or a suspended
account (tenant_inactive).
The resource does not belong to your account (forbidden), or the path is on the
mirror's block list (forbidden_endpoint), or your API key is limited to some numbers and
the operation covers the whole account (forbidden).
Conflicts with the current state of the account.
Rate limit exceeded (rate_limit).
Response Headers
Seconds to wait before retrying.
Which rate limit category applied — send, media or default.
Which bucket the other headers describe — key (the API key), session (the dashboard) or account (the account ceiling).
Request ceiling for this category in the current window.
Requests left in the current window.