Jump to Content
API Reference
Changelog
Changelog Policy
Webhooks
API Support
v1.0
Home
API Reference
Home
v1.0
API Reference
Changelog
Changelog Policy
Webhooks
API Support
v1/login
Search
All
Pages
Start typing to search…
JUMP TO
Introduction
Getting started with the shyftplan API
Which method do I want? (Get, Post, Put, Delete)
GraphQL Guide
Use Cases
API Structure and Object Map
Absences Data Sync
Attendances Data Sync
Demand-driven shift updates
HR Master Data Sync
shyftplan API
absences
v1/absences
get
v1/absences
post
v1/absences/{id}
delete
v1/absences/{id}
get
v1/absences/{id}
put
v1/absences/{id}/approve
post
v1/absences/{id}/attachment
post
v1/absences/{id}/decline
post
v1/absences/{id}/withdraw
post
v1/absences/employments
get
v1/absences/employments/{id}
get
v1/absences/employments/{id}/absence_info
get
v2/absences/employments/{id}/absence_info
get
v1/absences/employments/{id}/carry_over_info
get
v1/absences/locations
get
v1/absences/stats
get
absence_entitlements
v2/absence_entitlements
get
v2/absence_entitlements
put
absence_reasons
v1/absence_reasons
get
v1/absence_reasons
post
v2/absence_reasons
post
v1/absence_reasons/{id}
delete
v1/absence_reasons/{id}
get
v1/absence_reasons/{id}
put
v2/absence_reasons/{id}
patch
v1/absence_reasons/stats
get
assignment_groups
v1/assignment_groups
get
v1/assignment_groups
post
v1/assignment_groups/{id}
delete
v1/assignment_groups/{id}
get
v1/assignment_groups/{id}
put
v1/assignment_groups/{id}/add_shift
put
v1/assignment_groups/{id}/assign_employment
post
v1/assignment_groups/{id}/remove_shift
put
v1/assignment_groups/{id}/unassign_employment
post
availabilities
v1/availabilities
get
v1/availabilities
post
v1/availabilities/{availability_id}
delete
v1/availabilities/{availability_id}
get
v1/availabilities/{availability_id}
put
v1/availabilities/{availability_id}/exceptions
get
v1/availabilities/{availability_id}/exceptions
post
v1/availabilities/exceptions
get
v1/availabilities/exceptions/{exception_id}
delete
v1/availabilities/exceptions/{exception_id}
get
availability_aggregations
v1/availability_aggregations
get
available_global_qualifications
v1/available_global_qualifications
get
background_jobs
v1/background_jobs
get
v1/background_jobs/{id}
get
bulk_requests
v1/bulk_requests
post
v1/bulk_requests/{id}
get
calendar
v1/calendar/aggregations
get
chat_messages
v1/chat_messages
get
v1/chat_messages
post
v1/chat_messages/chats
get
v1/chat_messages/employments
get
companies
v1/companies
get
v1/companies/{id}
get
v1/companies/{id}/shift_schedule_settings
get
v1/companies/{id}/ui_settings
get
v1/companies/{id}/ui_settings
post
custom_fields
v1/custom_fields
get
v1/custom_fields
post
v1/custom_fields/{id}
delete
v1/custom_fields/{id}
get
v1/custom_fields/{id}
put
employee_evaluations
v1/employee_evaluations/{evaluation_id}/tags
get
v1/employee_evaluations/{evaluation_id}/tags
post
v1/employee_evaluations/{evaluation_id}/tags/{evaluation_tag_id}
delete
v1/employee_evaluations/{staff_shift_id}
delete
v1/employee_evaluations/{staff_shift_id}
get
v1/employee_evaluations/{staff_shift_id}
post
v1/employee_evaluations/{staff_shift_id}/accept
post
v1/employee_evaluations/{staff_shift_id}/evaluation_break
post
v1/employee_evaluations/{staff_shift_id}/evaluation_break/{evaluation_break_id}
delete
v1/employee_evaluations/{staff_shift_id}/evaluation_break/{evaluation_break_id}
put
v1/employee_evaluations/{staff_shift_id}/payments
get
v1/employee_evaluations/{staff_shift_id}/payments
post
v1/employee_evaluations/{staff_shift_id}/payments/{payment_id}
get
v1/employee_evaluations/{staff_shift_id}/payments/{payment_id}
put
employments
v1/employments
get
v2/employments
get
v2/employments
post
v1/employments/available_for_qualification_matrix
get
v1/employments/info
get
v1/employments/my
get
v1/employments/potential_conflicts
get
v1/employments/{id}
delete
v1/employments/{id}
get
v1/employments/{id}/availabilities
get
v1/employments/{id}/destroy_employment
post
v1/employments/{id}/live_info
get
v1/employments/{id}/notifications
get
v1/employments/{employment_id}/master_location_position
put
v1/employments/{id}/yearly_bring_shifts
get
v1/employments/{id}/yearly_bring_shifts/for_year
put
v1/employments/{id}/restore_employment
post
v1/employments/{id}/rights
get
v1/employments/{id}/paygrades
get
v1/employments/{id}/paygrades
post
v1/employments/{id}/paygrades/{paygrade_id}
delete
v1/employments/{id}/paygrades/{paygrade_id}
get
v1/employments/{id}/paygrades/{paygrade_id}
put
v1/employments/{id}/ui_settings
get
v1/employments/{id}/ui_settings
post
employments_paygrades
v1/employments_paygrades
get
employments_positions
v1/employments_positions
get
v1/employments_positions
post
v1/employments_positions/{id}
delete
v1/employments_positions/{id}
get
employments_qualifications
v1/employments_qualifications
get
v1/employments_qualifications
post
v1/employments_qualifications
put
v1/employments_qualifications/{id}
delete
v1/employments_qualifications/{id}/approve_planned
post
employments_rotation_groups
v1/employments_rotation_groups
get
v1/employments_rotation_groups
post
v1/employments_rotation_groups/{id}
delete
v1/employments_rotation_groups/{id}
put
employments_surveys
v1/employments_surveys/{id}
get
v1/employments_surveys/{id}
post
employment_time_accounts
v1/employment_time_accounts
get
v1/employment_time_accounts
patch
evaluations
v1/evaluations
get
v1/evaluations/{staff_shift_id}
get
v1/evaluations/{staff_shift_id}
post
v1/evaluations/{staff_shift_id}/did_not_show
post
v1/evaluations/{staff_shift_id}/did_show
post
v1/evaluations/{staff_shift_id}/evaluation_breaks
post
v1/evaluations/{staff_shift_id}/evaluation_breaks/{evaluation_break_id}
delete
v1/evaluations/{staff_shift_id}/evaluation_breaks/{evaluation_break_id}
put
v1/evaluations/{staff_shift_id}/payments
get
v1/evaluations/{staff_shift_id}/payments
post
v1/evaluations/{staff_shift_id}/payments_calculation
get
v1/evaluations/{staff_shift_id}/payments/{payment_id}
delete
v1/evaluations/{staff_shift_id}/payments/{payment_id}
get
v1/evaluations/{staff_shift_id}/payments/{payment_id}
put
evaluation_breaks
v1/evaluation_breaks
get
evaluation_tags
v1/evaluation_tags
get
v1/evaluation_tags
post
v1/evaluation_tags/{id}
delete
v1/evaluation_tags/{id}
put
external_record_mappings
v1/external_record_mappings
get
v1/external_record_mappings
post
v1/external_record_mappings/{id}
delete
v1/external_record_mappings/{id}
get
v1/external_record_mappings/{id}
put
hour_accounts
v1/hour_accounts
get
v1/hour_accounts
post
v1/hour_accounts/corrections
post
v1/hour_accounts/corrections/{id}
put
v1/hour_accounts/corrections/{id}
delete
v1/hour_accounts/employments
get
v1/hour_accounts/export
get
v1/hour_accounts/{employment_id}
delete
v1/hour_accounts/{employment_id}/breakdown
get
v1/hour_accounts/{employment_id}/export
get
v1/hour_accounts/{employment_id}/previous_months
get
v1/hour_accounts/{employment_id}/stats
get
individual_rotations
v1/individual_rotations
get
v1/individual_rotations
post
v1/individual_rotations/{id}
delete
v1/individual_rotations/{id}
get
v1/individual_rotations/{id}
put
languages
v1/languages
get
live_staff_shifts
v1/live_staff_shifts
get
locations
v1/locations
get
v1/locations
post
v1/locations/{id}
delete
v1/locations/{id}
get
v1/locations/{id}
put
v1/locations/{id}/destroy_location
post
v1/locations/{id}/shiftplan_publish_settings
get
v1/locations/{id}/shiftplan_publish_settings
put
locations_positions
v1/locations_positions
get
v1/locations_positions
post
v1/locations_positions/{id}
delete
v1/locations_positions/{id}
get
v1/locations_positions/{id}
put
locations_positions_tags
/api/v1/locations_positions_tags
get
/api/v1/locations_positions_tags
post
/api/v1/locations_positions_tags/{id}
put
/api/v1/locations_positions_tags/{id}
delete
locations_position_qualifications
v1/locations_position_qualifications
post
v1/locations_position_qualifications
put
v1/locations_position_qualifications/{id}
delete
login
v1/login
post
newsfeeds
v1/newsfeeds
get
v1/newsfeeds
post
notification_configurations
v1/notification_configurations
get
v1/notification_configurations/notification_filter
get
v1/notification_configurations/notification_filter
put
v1/notification_configurations/{id}
get
v1/notification_configurations/{id}
put
paygrade_types
v1/paygrade_types
get
v1/paygrade_types/{id}
get
payments
v1/payments/{staff_shift_id}
get
payslips
v1/payslips
get
v1/payslips
post
positions
v1/positions
get
v1/positions
post
v1/positions/{id}
delete
v1/positions/{id}
get
v1/positions/{id}
put
v2/positions
get
v1/positions/{id}/add_employment
put
v1/positions/{id}/destroy_position
post
v1/positions/{id}/remove_employment
put
punch_timings
v1/punch_timings
get
v1/punch_timings/fetch_locations_positions
get
v1/punch_timings/punch_time
get
v1/punch_timings/record
get
v1/punch_timings/shift_create
post
v1/punch_timings/start
post
v1/punch_timings/{id}
put
v1/punch_timings/{punch_timing_id}/punch_breaks
post
v1/punch_timings/{punch_timing_id}/punch_breaks/{id}
put
qualifications
v1/qualifications
get
v1/qualifications/categories
get
v1/qualifications/categories/employments_qualifications
put
v1/qualifications/categories/rotation_groups/stats
get
v1/qualifications/categories/stats
get
v1/qualifications/employments
get
v1/qualifications/expirations
get
v1/qualifications/grouped_by_category
get
v1/qualifications/inheritances
get
v1/qualifications/inheritances
post
v1/qualifications/inheritances/available_locations_positions
get
v1/qualifications/inheritances/{id}
delete
v1/qualifications/locations_positions
get
v1/qualifications/locations_positions
post
v1/qualifications/locations_positions/available_qualifications
get
v1/qualifications/locations_positions/stats
get
v1/qualifications/positions/rotation_groups/stats
get
v1/qualifications/positions/stats
get
replaced_evaluations
v1/replaced_evaluations
get
replace_requests
v1/replace_requests/{id}
delete
requests
v1/requests
get
v1/requests/accept_swap_shift
post
v1/requests/apply_shift
post
v1/requests/change_shift
post
v1/requests/confirm_apply_shift
post
v1/requests/confirm_swap_shift
post
v1/requests/join
post
v1/requests/swap_shift
post
v1/requests/replace
post
v1/requests/replace/accept
post
v1/requests/replace/confirm
post
v1/requests/{id}
get
v1/requests/{id}
delete
rights
v1/rights
get
v1/rights/locations_position_payment_manage_right
put
v1/rights/locations_position_payment_manage_right
delete
v1/rights/locations_position_payment_show_right
delete
v1/rights/locations_position_payment_show_right
put
v1/rights/locations_position_shift_manage_right
delete
v1/rights/locations_position_shift_manage_right
put
v1/rights/locations_position_shift_show_right
delete
v1/rights/locations_position_shift_show_right
put
v1/rights/location_payment_manage_right
delete
v1/rights/location_payment_manage_right
put
v1/rights/location_payment_show_right
delete
v1/rights/location_payment_show_right
put
v1/rights/location_shift_manage_right
delete
v1/rights/location_shift_manage_right
put
v1/rights/location_shift_show_right
delete
v1/rights/location_shift_show_right
put
v1/rights/my
get
v1/rights/{id}
delete
v1/rights/{id}
put
sessions
v1/sessions/refresh
post
shiftplans
v1/shiftplans
get
v1/shiftplans
post
v1/shiftplans/assign_employments_to_open_shifts
post
v1/shiftplans/{id}
delete
v1/shiftplans/{id}
get
v1/shiftplans/{id}
patch
v1/shiftplans/{id}/assign_rotation
post
v1/shiftplans/{id}/copy
post
v1/shiftplans/{shiftplan_id}/copy_to_existing
post
v1/shiftplans/{shiftplan_id}/day_notes
get
v1/shiftplans/{shiftplan_id}/day_notes
post
v1/shiftplans/{shiftplan_id}/day_notes/{id}
delete
v1/shiftplans/{shiftplan_id}/day_notes/{id}
put
v1/shiftplans/{id}/employments_info
get
v1/shiftplans/{shiftplan_id}/messages
post
v1/shiftplans/{shiftplan_id}/notifications
get
v1/shiftplans/{shiftplan_id}/notifications_messages
post
v1/shiftplans/{id}/publish
post
shifts
v1/shifts
get
v1/shifts
post
v2/shifts
get
v1/shifts/automation
post
v1/shifts/connect
post
v1/shifts/{id}
delete
v1/shifts/{id}
get
v1/shifts/{id}
patch
v1/shifts/{id}
put
v1/shifts/{id}/available_employments
get
v1/shifts/{id}/clone
post
v1/shifts/{id}/disconnect
post
v1/shifts/{id}/evaluations
get
v1/shifts/{shift_id}/evaluation_tags
delete
v1/shifts/{shift_id}/evaluation_tags
get
v1/shifts/{shift_id}/evaluation_tags
post
v2/shifts/{id}/paygrades
put
v1/shifts/{shift_id}/paygrades
get
v1/shifts/{shift_id}/paygrades
post
v1/shifts/{shift_id}/paygrades/{id}
delete
v1/shifts/{shift_id}/paygrades/{id}
put
v1/shifts/{shift_id}/shift_breaks
post
v1/shifts/{shift_id}/shift_breaks/{id}
delete
v1/shifts/{shift_id}/shift_breaks/{id}
patch
shifts_tags
v1/shifts_tags
get
v1/shifts_tags/{id}
get
shift_assignment_groups
v1/shift_assignment_groups
get
shift_breaks
v1/shift_breaks
get
shift_presets
v1/shift_presets
get
v1/shift_presets
post
shift_rotations
v1/shift_rotations
get
v1/shift_rotations
post
v1/shift_rotations/{id}
delete
v1/shift_rotations/{id}
get
v1/shift_rotations/{id}
put
v1/shift_rotations/{id}/shiftplan
post
shift_rotation_groups
v1/shift_rotation_groups
get
v1/shift_rotation_groups
post
v1/shift_rotation_groups/{id}
delete
v1/shift_rotation_groups/{id}
put
v1/shift_rotation_groups/{id}/assign_employee
post
v1/shift_rotation_groups/{id}/assign_to_shifts
post
v1/shift_rotation_groups/{id}/unassign_employee
post
v1/shift_rotation_groups/{id}/unassign_from_shifts
post
v1/shift_rotation_groups/required_fully_qualified_employees
put
v1/shift_rotation_groups/required_fully_qualified_employees/{id}
delete
special_dates
v1/special_dates
get
v1/special_dates
post
v1/special_dates/{id}
delete
v1/special_dates/{id}
get
v1/special_dates/{id}
put
sso_settings
v1/sso_settings/sso_target_url
get
staff_shifts
v1/staff_shifts
get
v1/staff_shifts
post
v1/staff_shifts/move_staff
post
v1/staff_shifts/replace
post
v1/staff_shifts/{id}
delete
v1/staff_shifts/{id}
get
staff_shifts_tags
v1/staff_shifts_tags
delete
v1/staff_shifts_tags
get
v1/staff_shifts_tags
post
v1/staff_shifts_tags/{id}
get
tags
v1/tags
get
v1/tags
post
v1/tags/{id}
delete
v1/tags/{id}
get
v1/tags/{id}
put
v1/tags/{id}/add_to_shift
put
v1/tags/{id}/remove_from_shift
put
users
v1/users
get
v1/users
post
v1/users/change_locale
post
v1/users/update_password
post
v1/users/{id}
get
v1/users/{id}
put
Powered by
v1/login
post
https://shyftplan.com/api/v1/login
Language
Shell
Node
Ruby
PHP
Python
RESPONSE
Click
Try It!
to start a request and see the response here!
