v3

latestSwagger 2.02026-08-067506752.0 MB
person

Compute top-N + Other subcounts for one or more fields, for persons in the organization

get/v2/org/{orgId}/person/subcounts

Path parameters

orgIdstring required

Org identifier (either id or slug)

Query parameters

scenarioIdstring

Scenario id to query

datestring date

Date to search as of

startDatestring date

Start date, if counting persons employed between two dates (inclusive)

endDatestring date

End date, if counting persons employed between two dates (inclusive)

qstring

Search query

fieldsstring required

Comma-separated list of fields to compute subcounts for

topNinteger

Number of top values to return per field; remainder is rolled into an Other bucket (default 10, max 25)

includeAllboolean

Include all persons in the system, including ex-employees or persons who were never in jobs

Response

successful operation

countsobject required