List employees

get

https://sandbox.checkhq.com/employees

Returns a list of all employees. Employees will be returned from the list endpoint in alphabetical order, sorted by last name, first name.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

company

string

Return employees for this company ID.

limit

int32

Defaults to 25

Number of employees returned per page. The maximum value is 100.

workplace

string

Return employees who work at these workplaces (can be comma-separated list of workplace IDs)

active

boolean

Include employees only with a certain active status

include_company_defined_attributes

boolean

Include each employee's company_defined_attributes in the response, in the same format returned by Get company-defined attributes. Pass true to include them. Leave the parameter out to omit them. Which attributes are returned depends on the company and employee, so find each attribute by its name rather than its position in the list.

array of strings

Filter the list to the specified IDs. For more details, check out the Bulk Get Requests guide.

metadata

object

Return only results whose metadata contains every given key and value, for example metadata[external_id]=123. Pass keys using bracket notation. Multiple keys are combined with AND. Brackets must be URL-encoded in request URLs (metadata%5Bkey%5D=value).

Response

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200