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.

assignment_group_ids
array of objects

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
≥ 1
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 objects

Array of EvaluationTag IDs (including from shift presets)

evaluation_tag_ids
string

Optional MCP-safety idempotency key. When present with API-token auth, repeated calls with the same fingerprint within the TTL window replay the cached response instead of re-creating the shift preset. Ignored for session auth.

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
  • punch_timing_reassignment

int32
required
≥ 1

ID of a locations-position, which is the link between a position and a location. (These IDs are returned by GET /locations_positions.)

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
≥ 1

ID of a shift preset.

shift_rotation_group_ids
array of objects

List of shift-system group IDs.

shift_rotation_group_ids
int32
required
≥ 1

ID of the shift schedule.

date-time
required

Date-time (ISO 8601) for the begin of the object's span.

date-time
required

Date-time (ISO 8601) for the end of the object's span.

tag_ids
array of objects

Array of Shift Tag IDs (including from shift presets)

tag_ids
boolean
Defaults to false

Is this a Standby shift?

int32
≥ 1

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

int32
required
≥ 0
Defaults to 0

Number of workers

Responses

Updated 4 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 4 months ago

Did this page help you?