Skip to content

Employees

Employees are the people working in your organisation. Use these endpoints to list employees; to map a Dyflexis employee to an external personnel number; and to create or update an external employee record from your own HR or payroll system.

Three list endpoints are exposed under different token scopes so each consumer sees only the data its scope is allowed to read: business, clock, and payroll.

Operations

List employees

Request

Requires scope: business.

Fetches all active employees, their labels, and their card numbers.

Security
apiKey(Required scopes: business)
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://beta-developer.dyflexis.com/_mock/openapi/api/business/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": [
    { … }
  ]
}