Skip to main content
POST
companies.workforce

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
domain
string

Company website domain.

profileUrl
string

The company's public professional profile URL.

Response

The result

company
object
required

Company identity.

roles
object[]
required

Role breakdown.

Maximum array length: 100
regions
object[]
required

Region breakdown.

Maximum array length: 100
growth
object[]
required

Headcount growth, by labelled period.

Maximum array length: 5
history
object[]
required

Total headcount history.

Maximum array length: 100
truncated
boolean
required

True when a source list exceeds the stated returned cap.

employeeCount
integer

Total employee count.

Required range: 0 <= x <= 9007199254740991
largestCountry
string

Country with the most employees.

Maximum string length: 2000