v1

latestOpenAPI 3.0.1Apache 2.02026-07-26131220353.8 KB
Employees

Search for employees

Use this endpoint to search for multiple employees.

get/v2/employees

Query parameters

companyIdstring uuid

Enter the company ID of the employees you are searching for. This is not a mandatory parameter; hence, if you do not know the company ID, the response message contains details of all employees to which you have access. If you are searching for employees at the organisation level, ensure that the access token used for authentication has the correct permissions.

emailstring

The email of the Employee you are searching for.

codestring

The external ID of the Employee you are searching for.

beforestring

Lower bound of the page of data to return (cannot be used together with [after] or [offset]).

afterstring

Upper bound of the page of data to return (cannot be used together with [before] or [offset]).

offsetinteger

Offset of the page of data to return (cannot be used together with [before] or [after]).

limitinteger

The maximum amount of items to return.

sorting_keysstring[]

The keys to sort the results by.

sorting_orderPageOrder[]

The order to sort the results by. Must be the same length as [sortingKeys]; one order per key.

Response

Employee search successful