Get employees, optionally narrowed by a search
Return your company’s employees as a paginated list. Pass search to turn a name or an email into the employee it refers to instead of paging: free text over first and last name, full name in either order, work email and personal email, ignoring case and accents, plus text and URL custom field values. Exactly one result is that person; several mean the name is ambiguous and nobody was found — ask which is meant, never take the first. id is the employee itself; managerId, deviceIds and accessoryIds name other records, never a search result. Items carry id, firstName, lastName, email, teams and jobs ({ id, name } — teams and job titles), groups, workLocation, legalEntity, managerId, startDate, terminationDate, onboardingStatus, offboardingStatus, deviceIds, accessoryIds, createdAt and updatedAt. It omits personal data such as the postal address and the personal email — getEmployee with an id returns the full record. Never conclude a field is empty from this list alone.
Authorizations
Use your Primo API key in the Authorization header as Bearer <API_KEY>.
Query Parameters
Page number
1 <= x <= 9007199254740991Number of items per page (max 100)
1 <= x <= 100Free-text search over first name, last name, full name in either order, work email and personal email, ignoring case and accents. Text and URL custom field values are also matched, case-insensitively and without accent folding.
1