Personnel

Employee directory

A snapshot from the employees table (not a live IdP call), with status + department filters. Manual employment-status overrides set by an admin in the People page are honored, and so are completed offboardings: either reads as terminated here even if the IdP still shows the account. terminationSignal: "unavailable" means completed offboardings could not be read, so active may include people who already left. Any query parameter other than these three returns 400.

Scope: personnel:read.

get/api/v1/companies/{companyId}/employees

Request

  • Base URL
    https://comply.strac.io
  • Auth
    HTTP bearer

Path parameters

companyIdstring required

Your organization id.

Query parameters

status'active' | 'terminated' | 'all'

Filter by employment status.

departmentstring

Exact, case-sensitive department match.

limitinteger

Max rows, 1 to 2000. A larger value returns 400.

Response

Employee directory

Changes

No recorded changes to this operation across all 1 revision of this API.