latestSwagger 2.02026-08-0982147352.7 KB

be66ed178abe

Employee

employees

Returns a list of paginated employees for the company.<p>Scopes: export_company_info</p>

get/v{version}/companies/{company_id}/employees

Path parameters

company_idstring required

The id of the company.

versionstring required

Query parameters

start_idstring

Optional. The object id to begin with, inclusive.

limitinteger

The maximum number of records to return, the default is 50 and the maximum is 250.

Response

Success

next_idstring

The id of the object next up after this set.

errorstring

Contains any error messages, if applicable.

Example response

{
  "data": [
    {
      "latest_hire_date": "yyyy-MM-dd",
      "compensation_start_date": "yyyy-MM-dd",
      "compensation_end_date": "yyyy-MM-dd",
      "status_effective_date": "yyyy-MM-dd",
      "birth_date": "yyyy-MM-dd",
      "hire_date": "yyyy-MM-dd"
    }
  ]
}