Skip to main content
GET /v1/tenants/{product_slug}/limits returns every allocation currently set on a tenant, each with used/remaining for its own window.

Endpoint

Path Parameter

string
required
Your own tenant, or a direct child’s slug.

Example Request

Response

number
Always in natural units for type — contacts, accounts, or credits.
number
The same cap expressed in credits, so allocations of different types are comparable.
boolean
True once this allocation has stopped admitting new leads of the kind it governs. Always false when is_enforced is false. For a credits allocation this can be true while remaining is still positive — contacts pause once fewer credits remain than a single contact costs, so a single contact can never push usage past the limit. For contacts and accounts allocations, is_reached matches used >= value exactly, since each lead there costs one unit.
An empty data array means the tenant has no allocation set and is unlimited within its parent’s own pool.

Required Scope

Requires tenants:read.

Error Responses