API Reference
Home

v1/shifts

get
https://shyftplan.com/api/v1/shifts

List all Shifts

Query Params
string
required

This is a testing sandbox. We advise against using credentials for production accounts here.

E-mail address of the API user.

string
required

This is a testing sandbox. We advise against using credentials for production accounts here.

Authentication token - can be fetched by login action.

int32
required
≥ 1

ID of a shyftplan account.

assignment_group_ids[]
array of int32s

Filter by an array of Assignment Groups IDs

assignment_group_ids[]
int32

Filter by connected group ID

date-time

Return all records which are created after

date-time

Return all records which are created before

int32

Filter by Employment ID. Cannot be used with employment_ids

employment_ids[]
array of int32s

Filter by an array of Employment IDs. Cannot be used with employment_iPd

employment_ids[]
date-time
boolean
Defaults to false

Include fields "can_manage", "staff_shifts_count", "staff_shifts_needs_evaluation_count" in the response

int32

Filter by Shift ID

ids[]
array of int32s

Filter by an array of Shift IDs

ids[]
int32

Filter by LocationsPosition ID

locations_position_ids[]
array of int32s

Filter by an array of LocationsPosition IDs

locations_position_ids[]
not_in_shift_rotation_group_ids[]
array of int32s

Filter shifts that do not belong to shift-system groups

not_in_shift_rotation_group_ids[]
boolean
Defaults to false

Include only open shifts

string
enum
Defaults to asc

Sort direction

Allowed:
string
enum
Defaults to id

Sort by key

Allowed:
int32
≥ 1
Defaults to 1

Number of the page of responses to retrieve. First page: 1.

int32
1 to 1000
Defaults to 500

Number of responses on each page.

int32

Filter by Shiftplan ID

shiftplan_ids[]
array of int32s

Filter by an array of Shiftplan IDs

shiftplan_ids[]
shift_preset_ids[]
array of int32s

Filter by an array of shift presets. Use 0 or -1 for shifts with custom presets

shift_preset_ids[]
shift_rotation_group_ids[]
array of int32s

Filter by shift-system group IDs

shift_rotation_group_ids[]
date-time
tag_ids[]
array of int32s

Filter by an array of Shift Tag IDs

tag_ids[]
date-time

Return all records which are updated after

date-time

Return all records which are updated before

boolean
Defaults to false

Include only shifts without conflicts, only_open must be true and current user must be an employee only

boolean
Defaults to false

Include shifts with custom presets, can be used with shift_preset_ids

boolean

Filter shifts without Shift Tags

Responses

Updated 3 months ago

Did this page help you?
Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 3 months ago

Did this page help you?