v3

latestSwagger 2.02026-08-067506752.0 MB
person

Compute aggregated totals for persons matching a query

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

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 retrieving persons that existed between two dates (inclusive)

endDatestring date

End date, if retrieving persons that existed between two dates (inclusive)

qstring

Search query

includeAllboolean

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

columnsstring required

Fields to aggregate with their aggregation function, comma-separated

Response

successful operation