Skip to main content
Once your employees are in, you can read them back for any date, by our ID or by your own key.

Read one employee

Add ?valid_at= to read the employee as of another date, past or future: for example to check a change you sent for a future date, or to see the data a past payroll used. A satellite with no edition on that date is null.
Request
The edition of each satellite is the value you send in If-Match when you change it (see Changing data).

List employees

Each item in the list holds the hub with core, job and tax only. Read the employee for the other satellites. The list is paginated (see Pagination). Sort the list with sort, for example sort=-created_at for the newest first. Keep the same sort while you follow the cursors.

Read an employee by your own key

If you sent an external_ref when you created the employee, use it in the path with the ext: prefix instead of the id:
Request
This works for every employee call, including PUT on a satellite (see Conventions). There is no search by name or NI number.