Skip to main content
GET
Get Workspace Capacity

Authorizations

X-API-Key
string
header
required

API Key for authentication

Query Parameters

campaignId
string<uuid>

Campaign the call is being planned for. Optional. While planState is TRIAL the limits are stated per campaign owner, so naming the campaign measures the pools for that campaign's owner — the same scope the operation itself will be admitted in. Omit it to measure your own scope; an API key, which names no user, then reads the workspace's busiest owner. The campaign must belong to your workspace.

Response

status
string
required

Response status

Allowed value: "success"
data
object
required

Capacity pools of the workspace and the plan state they were resolved under.

message
string
required

Success message

Example:

"Operation completed successfully"