Skip to main content
GET
Get headcount breakdown

Authorizations

Authorization
string
header
required

OAuth2 client-credentials flow against the Dealroom Auth0 tenant. Use the client_id / client_secret from a Programmatic API key. Tokens are valid for 24h — Swagger UI will reuse the same token across operations. Revoking or deactivating a key rejects it on the next request (within a ≤5-minute server-side cache window), not at token expiry.

Headers

API-Version
string<date>

Pin a Stripe-style date-based API version (YYYY-MM-DD). Omit to use the latest version (2026-09-01). A pinned version is supported for 30 days after it is superseded, after which it returns 400.

Example:

"2026-09-01"

Path Parameters

id
string<uuid>
required

Stable UUID of the entity. Numeric ids are not accepted.

Minimum string length: 1
Example:

"345d1ab6-33df-4759-9e17-0d0c0ec9ab1c"

Query Parameters

type
enum<string>

Restrict to a single breakdown dimension: country (employee distribution by country) or department. Omit to return both.

Available options:
country,
department
Example:

"country"

Response

Company monthly headcount breakdown series

data
object[]
required