Reads all Employees

Only admins can see all the employees' information, regular users will get a restricted version of the payload as a response based on the permission set by the admin

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
ids[]
array of strings

Return only the employees with these ids. Ids outside what the reader may see are dropped, rather than failing the whole read.

ids[]
access_ids[]
array of strings

filter by employee access ids.

access_ids[]
emails[]
array of strings

filter by employee emails.

emails[]
string

filter by employee name.

string

Filter employees by their latest update timestamp (updated_at), on or after this date. Only the date is considered; any time component is ignored (matching starts at 00:00:00 of the given date). Note: updated_at only stores the most recent update, so an employee updated multiple times is matched solely by its latest update, not by earlier ones.

string

filter by employee company identifier.

identifiers[]
array of strings

Return only the employees whose identity document (the identifier field: national ID, NIE, passport…) is one of these. Dots, dashes, spaces, letter case and leading zeros are ignored, so 12.345.678-z and 0012345678Z both find an employee stored as 12345678Z. At most 100 values. Combined with social_security_numbers, an employee has to match both. Terminated employees you can see are matched too; add only_active to leave them out. Only employees whose personal information you can read are matched.

identifiers[]
social_security_numbers[]
array of strings

Return only the employees whose social security number (the social_security_number field; in Spain, the NUSS or NAF) is one of these. Anything other than a digit is ignored, and so are leading zeros, so 08/08511662/35 finds an employee stored as 080851166235. At most 100 values. Combined with identifiers, an employee has to match both. Terminated employees you can see are matched too; add only_active to leave them out. Only employees whose personal information you can read are matched.

social_security_numbers[]
boolean
required

Set to true to keep only the employees not terminated as of today: those with no termination date, or one still in the future. Passing false has no effect, and it is ignored altogether when include_active_and_terminated is set.

team_ids[]
array of strings

Return only the employees who belong to these teams.

team_ids[]
location_ids[]
array of strings

Return only the employees whose default workplace is one of these locations.

location_ids[]
boolean
required

Set to true to return only the employees who have at least one direct report. Passing false has no effect.

string

filter by employee names that start with the given text.

Responses

Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json