quotas

List workspace quotas

Changed on

Returns each resource and value quota as it applies to the current workspace: the organization limit shared by all workspaces, the workspace's own limit when one is set, and this workspace's current usage. Organization usage and shared remaining capacity are withheld: organization_used, organization_remaining and remaining are always null on this endpoint.

A workspace limit is a ceiling, not reserved capacity. Each quota's enforcement says how both limits apply: create refuses a creation that would pass either one, outbound_send refuses outbound sends once the bytes already held reach either one, and value bounds a setting when it is chosen. usage is null for a value quota. When usage cannot be read, usage.status is unavailable and the counts are null.

get/v1/workspace/quotas

Request

  • Base URL: https://us1.platform.bird.com
  • URL: https://us1.platform.bird.com/v1/workspace/quotas
  • Auth: one of:
    • HTTP bearer
    • API key in cookie bird_session

Headers

X-Workspace-Idstring

Workspace context for the request. Required for dashboard authentication and master keys. Workspace keys and access tokens already identify their workspace; send that workspace or omit the header. A different one is rejected.

X-Organization-Idstring

Organization context for the request. Required for dashboard authentication. An API key or access token carries its own organization, so send either that organization or no header at all; a different one is rejected.

Response

The workspace's quotas.

configuration'available' | 'unavailable' required

Whether workspace limits can be set.

  • available: workspace limits can be set and changed.
  • unavailable: new workspace limits cannot be set in this region yet. Existing workspace limits still apply and can be removed.

Example response

{
  "data": [
    {
      "key": "email_mailboxes_max",
      "unit": "mailboxes"
    }
  ]
}

Changes