v3

latestSwagger 2.02026-08-067506752.0 MB
person

Count persons in an org

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

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

includeAllboolean

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

Response

successful operation

jobCountinteger required
personCountinteger required
startingCountinteger required
departingCountinteger required
groupCountinteger