Jump to Content

API Reference GraphQL Changelog GraphQL Guide Changelog Policy Webhooks

v1.0

v1.0API Reference GraphQL Changelog GraphQL Guide Changelog Policy Webhooks

Introduction

Getting started with the shyftplan API
Which method do I want? (Get, Post, Put, Delete)

Use Cases

API Structure and Object Map
Absences Data Sync
Attendances Data Sync
Demand-driven shift updates
HR Master Data Sync

API - shyftplan

absences
absence_entitlements
- /api/v2/absence_entitlementsget
- /api/v2/absence_entitlementsput
absence_reasons
assignment_groups
availabilities
availability_aggregations
- /api/v1/availability_aggregationsget
background_jobs
- /api/v1/background_jobsget
- /api/v1/background_jobs/{id}get
bulk_requests
- /api/v1/bulk_requestspost
- /api/v1/bulk_requests/{id}get
calendar
- /api/v1/calendar/aggregationsget
chat_messages
companies
custom_fields
employee_evaluations
employments
employments_paygrades
- /api/v1/employments_paygradesget
employments_positions
employments_rotation_groups
employments_surveys
- /api/v1/employments_surveys/{id}get
- /api/v1/employments_surveys/{id}post
evaluations
evaluation_breaks
- /api/v1/evaluation_breaksget
individual_rotations
languages
- /api/v1/languagesget
live_staff_shifts
- /api/v1/live_staff_shiftsget
login
- /api/v1/loginpost
locations
locations_positions
newsfeeds
- /api/v1/newsfeedsget
- /api/v1/newsfeedspost
notification_configurations
paygrade_types
- /api/v1/paygrade_typesget
- /api/v1/paygrade_types/{id}get
payments
- /api/v1/payments/{staff_shift_id}get
payslips
- /api/v1/payslipsget
- /api/v1/payslipspost
positions
punch_timings
qualifications
- /api/v1/qualificationsget
replaced_evaluations
- /api/v1/replaced_evaluationsget
replace_requests
- /api/v1/replace_requests/{id}delete
requests
rights
sessions
- /api/v1/sessions/refreshpost
shiftplans
shifts
shifts_tags
- /api/v1/shifts_tagsget
- /api/v1/shifts_tags/{id}get
shift_assignment_groups
- /api/v1/shift_assignment_groupsget
shift_breaks
- /api/v1/shift_breaksget
shift_presets
- /api/v1/shift_presetsget
- /api/v1/shift_presetspost
shift_rotations
shift_rotation_groups
special_dates
sso_settings
- /api/v1/sso_settings/sso_target_urlget
staff_shifts
staff_shifts_tags
tags
users
evaluation_tags

Powered by

Introduction

Getting started with the shyftplan API
Which method do I want? (Get, Post, Put, Delete)

Use Cases

API Structure and Object Map
Absences Data Sync
Attendances Data Sync
Demand-driven shift updates
HR Master Data Sync

API - shyftplan

absences
absence_entitlements
- /api/v2/absence_entitlementsget
- /api/v2/absence_entitlementsput
absence_reasons
assignment_groups
availabilities
availability_aggregations
- /api/v1/availability_aggregationsget
background_jobs
- /api/v1/background_jobsget
- /api/v1/background_jobs/{id}get
bulk_requests
- /api/v1/bulk_requestspost
- /api/v1/bulk_requests/{id}get
calendar
- /api/v1/calendar/aggregationsget
chat_messages
companies
custom_fields
employee_evaluations
employments
employments_paygrades
- /api/v1/employments_paygradesget
employments_positions
employments_rotation_groups
employments_surveys
- /api/v1/employments_surveys/{id}get
- /api/v1/employments_surveys/{id}post
evaluations
evaluation_breaks
- /api/v1/evaluation_breaksget
individual_rotations
languages
- /api/v1/languagesget
live_staff_shifts
- /api/v1/live_staff_shiftsget
login
- /api/v1/loginpost
locations
locations_positions
newsfeeds
- /api/v1/newsfeedsget
- /api/v1/newsfeedspost
notification_configurations
paygrade_types
- /api/v1/paygrade_typesget
- /api/v1/paygrade_types/{id}get
payments
- /api/v1/payments/{staff_shift_id}get
payslips
- /api/v1/payslipsget
- /api/v1/payslipspost
positions
punch_timings
qualifications
- /api/v1/qualificationsget
replaced_evaluations
- /api/v1/replaced_evaluationsget
replace_requests
- /api/v1/replace_requests/{id}delete
requests
rights
sessions
- /api/v1/sessions/refreshpost
shiftplans
shifts
shifts_tags
- /api/v1/shifts_tagsget
- /api/v1/shifts_tags/{id}get
shift_assignment_groups
- /api/v1/shift_assignment_groupsget
shift_breaks
- /api/v1/shift_breaksget
shift_presets
- /api/v1/shift_presetsget
- /api/v1/shift_presetspost
shift_rotations
shift_rotation_groups
special_dates
sso_settings
- /api/v1/sso_settings/sso_target_urlget
staff_shifts
staff_shifts_tags
tags
users
evaluation_tags

Powered by

/api/v1/custom_fields

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

List all Custom Fields.

Language

Click Try It! to start a request and see the response here!