API Reference
Home

v1/shifts

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

Create a new shift

Body 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.

date-time
required
Defaults to 2024-01-01T09:00:00.000+01:00

End of the shift

int32
required
Defaults to 1234

ID of locations_positions object

int32
required
Defaults to 1234

ID of an Shiftplan

date-time
required
Defaults to 2024-01-01T09:00:00.000+01:00

Start of the shift

int32
required
Defaults to 0

Number of workers

assignment_group_ids
array of int32s

Array of assignment group IDs

assignment_group_ids
string
enum
Defaults to disabled

Auto accept shift requests as long as there are open slots on the shift

Allowed:
int32
Defaults to 30

Total duration of timed breaks in minutes (Required unless untimed_break_time is present)

boolean
Defaults to true

Can employees propose evaluations?

evaluation_tag_ids
array of int32s

Array of EvaluationTag IDs (including from shift presets)

evaluation_tag_ids
string
Defaults to true

Either true to ignore all conflicts listed below or an array of specific conflicts to ignore. Only warnings can be ignored, enforced conflicts will persist. Possible values are:

  • shifts_collision
  • absences_collision
  • locations_position_changed
  • minimum_break
  • maximum_working_hours
  • minimum_rest
  • maximum_earning
  • outside_employment_period
  • maximum_consecutive_working_days
  • restricted_shift_presets
  • unavailable
  • not_available
  • minimum_qualification_level
  • not_in_shift_preset

string

Manager note for the Shift

string

Shift metadata as json

string

Note for the shift

qualifications
array of objects

Collection of required qualifications

qualifications
shift_breaks
array of objects

Collection of timed shift breaks

shift_breaks
int32

ID of an exisiting shift preset

shift_rotation_group_ids
array of int32s

List of shift-system group IDs.

shift_rotation_group_ids
tag_ids
array of int32s

Array of Shift Tag IDs (including from shift presets)

tag_ids
boolean
Defaults to false

Is this a Standby shift?

int32

Duration of untimed breaks in minutes (Required unless break_time is present)

Responses

Updated 2 days ago

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

Updated 2 days ago