CHcheckhq

List employees

Changed on

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

get/employees

Request

Query parameters

companystring

Return employees for this company ID.

limitinteger

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

workplacestring

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

activeboolean

Include employees only with a certain active status

include_company_defined_attributesboolean

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.

idstring[]

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

metadataobject

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

200

Changes

  • 5a54f5eb888bRevision changes
    • info

      added the new optional query request parameter id

    • info

      added the new optional query request parameter include_company_defined_attributes

    • info

      added the new optional query request parameter metadata