Skip to content
/
List payroll employees

List payroll employees

Request

Requires scope: payroll.

Fetches all active employees and their contracts. Returns up to 100 employees per page.

Security
apiKey(Required scopes: payroll)
Query
pageinteger, >= 1

Page number of the paginated result set. The first page is 1.

Default:1
includeInactiveboolean

Also include inactive employees

Example:includeInactive=true
curl -i -X GET \
  'https://developer.dyflexis.com/_mock/openapi/api/payroll/v3/employees?page=1&includeInactive=true' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json
pageCountinteger

number of pages

Example:100
employeesArray of objects
Response
{
  "_links": {
    "self": { … },
    "next": { … },
    "prev": { … },
    "first": { … },
    "last": { … }
  },
  "pageCount": 100,
  "employees": [
    { … }
  ]
}