List Employees

---

GET services/api/v1/employees

Returns a list of employees.

Optional Query Parameters

Parameter	Type	Description
employee_status_id	string	Only return employees that have the passed status.
has_active_employee_job	boolean	Filter by employees who either do, or do not have an active job.
has_active_or_future_employee_job	boolean	Filter by employees who either do, or do not have an active or future job.
created_at_since	timestamp	Only return employees that have been created since the specified timestamp.
updated_at_since	timestamp	Only return employees that have been updated since the specified timestamp.

Response

200

Results list.

Example

{
  "entries": [
    {
      "id": "A96ey16n",
      "email": "john.doe@privatemail.com",
      "company_email": "john.doe@randomcompany.org",
      "first_name": "John",
      "last_name": "Doe",
      ...
    },
    {
      "id": "xy6q5M6d",
      "email": "jane.doe@privatemail.com",
      "company_email": "jane.doe@randomcompany.org",
      "first_name": "Jane",
      "last_name": "Doe",
      ...
    }
  ],
  "current_page": 1,
  "per_page": 30,
  "total_entries": 2
}

Schema

Attribute	Type	Required	Description
id	string	readonly	Encoded employee id.
created_at	string	readonly	Employee creation date.
updated_at	string	readonly	Employee last updated at.
language	string	false	Language of the employee as ISO 639-1 code. By default the language will be set to the preferred language of the business.
employee_status_id	string	false	Employee status id.
location_id	string	readonly	Employee location id.
department_id	string	readonly	Employee department id.
has_active_employee_job	boolean	readonly	Describes if employee currently has an active employee job at the business.
has_active_or_future_employee_job	boolean	readonly	Describes if employee currently has an active employee job or will have one in the future.
first_employee_job_from	timestamp	readonly	The start date of the employees first employee job.
first_employee_job_to	timestamp	readonly	The end date of the employees first employee job.
last_employee_job_from	timestamp	readonly	The start date of the employees last employee job (can be in the future).
last_employee_job_to	timestamp	readonly	The end date of the employees last employee job (can be in the future).
current_employee_job_from	timestamp	readonly	The start date of the employees current employee job.
current_employee_job_to	timestamp	readonly	The end date of the employees current job.
current_or_last_employee_job_from	timestamp	readonly	The start date of the employees current or last employee job (if employee has no active job, but has one in the future, this can be a future date).
current_or_last_employee_job_to	timestamp	readonly	The end of the employees current or last employee job.

Note that the fields above are only the fixed fields. All custom fields are provided by the Employee Fields API endpoint.