Skip to content

Scheduling

List scheduled shifts and the audit trail of schedule mutations (creations, modifications, deletions). The mutation feed is a legacy v0 endpoint kept for existing Business Intelligence consumers, there is no v3 equivalent yet.

Operations

List scheduled shifts

Request

Requires scope: business.

Returns a list of available shifts

Security
apiKey(Required scopes: business)
Query
startDatestring(Date)

List shifts that start from this date

Example:startDate=2026-12-31
endDatestring(Date)

List shifts starting before this date (end date exclusive)

Example:endDate=2026-12-31
departmentIdinteger

The department the shifts should be scheduled in

Example:departmentId=3
departmentGroupIdinteger

the department group the shifts should be scheduled in

Example:departmentGroupId=2
officeIdinteger

The office the shifts should be scheduled in

Example:officeId=1
includeOpenShiftsboolean

When true, it also returns open shifts

Example:includeOpenShifts=true
pageinteger, >= 1

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

Default:1
curl -i -X GET \
  'https://beta-developer.dyflexis.com/_mock/openapi/api/business/v3/scheduled?startDate=2026-12-31&endDate=2026-12-31&departmentId=3&departmentGroupId=2&officeId=1&includeOpenShifts=true&page=1' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json
shiftsArray of objects

Collection of all shifts

pageCountinteger

amount of pages

Example:100
Response
{
  "_links": {
    "self": { … },
    "next": { … },
    "prev": { … },
    "first": { … },
    "last": { … }
  },
  "shifts": [
    { … }
  ],
  "pageCount": 100
}