Skip to main content
GET
Get Workforce Verification Data
← Own Workforce API Return every employee identifier in the organization together with the date ranges of their contracts. Its purpose is narrow: it lets an uploader check, before submitting, that the employees named in a trainings or absences file exist and that the dates fall inside a contract.
Support endpoint, not recommended for new integrations. It exists to back the in-app import screen and its response is shaped for that screen, so it may change with the importer. For validation in your own pipeline, prefer the Imports API: create a session and call validate, which applies the same employee and contract-range rules server-side and returns them as per-row errors. Use this endpoint only if you need the raw ranges for something the importer cannot express.

Request

Headers

string
required
Your API key for authenticationExample: sk_live_1234567890abcdef
string
required
Your organization UUIDExample: a8315ef3-dd50-43f8-b7ce-d839e68d51fa

Response

A bare JSON array, one entry per employee.
string
The identifier from your HR system, the same value the trainings and absences import templates key on
array[object]
Unlike List Workforce Countries and List Workforce Job Categories, which walk the organization tree, this endpoint returns the header organization’s employees only. A holding using it to pre-validate a group-wide import would reject every subsidiary employee. It takes no filters and does not paginate.

Example

Successful Response

Common Errors

401 Unauthorized

Cause: the key is invalid, or it does not belong to the organization in x-organization-id — the two are looked up as a pair. A request carrying no credentials at all answers AUTH_REQUIRED instead.

403 Forbidden

Cause: the key’s owner is not an enabled member of the organization in x-organization-id.

Own workforce import templates

The rules this data helps you satisfy

Validate an import

The recommended way to check a file