Get Me Employees
GET {{baseUrl}}/v1/me/employees?order=<object>&begin_updated_at=<string>&end_updated_at=<string>&begin_created_at=<string>&end_created_at=<string>&status=<string>&external_id=<string>&limit=<integer>&batch_token=<string>
Provides summary information for all of a business's employees.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
order | string | The order in which employees are listed in the response, based on their created_at field. Default value: ASC | |
begin_updated_at | string | If filtering results by their updated_at field, the beginning of the requested reporting period, in ISO 8601 format | |
end_updated_at | string | If filtering results by there updated_at field, the end of the requested reporting period, in ISO 8601 format. | |
begin_created_at | string | If filtering results by their created_at field, the beginning of the requested reporting period, in ISO 8601 format. | |
end_created_at | string | If filtering results by their created_at field, the end of the requested reporting period, in ISO 8601 format. | |
status | string | If provided, the endpoint returns only employee entities with the specified status (ACTIVE or INACTIVE). | |
external_id | string | If provided, the endpoint returns only employee entities with the specified external_id. | |
limit | string | The maximum integer number of employee entities to return in a single response. Default 100, maximum 200. | |
batch_token | string | A pagination cursor to retrieve the next set of results for your | |
| original query to the endpoint. |