Skip to content

List employees

Request

Security
OAuth2 or OAuth2Sandbox
Query
filter[employment_status]string

Filter employees by employment status.

Value:"active"
includestring

Comma-separated list of related resources to include in the response. Supported values: active_employment.employment_group.

Value:"active_employment.employment_group"
curl -i -X GET \
  'https://api.fennoa.com/v2/payroll/employees?filter%5Bemployment_status%5D=active&include=active_employment.employment_group' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

List of employees.

Bodyapplication/json
dataArray of objects(PayrollEmployeeSimple)
metaobject
Response
{
  "data": [
    { … }
  ],
  "meta": {
    "next_cursor": "eyJpZCI6MX0="
  }
}