JUMP TOIntroductionGetting started with the shyftplan APIWhich method do I want? (Get, Post, Put, Delete)Use CasesAPI Structure and Object MapAbsences Data SyncAttendances Data SyncDemand-driven shift updatesHR Master Data SyncAPI - shyftplanabsences/api/v1/absencesget/api/v1/absencespost/api/v1/absences/employmentsget/api/v1/absences/employments/{id}get/api/v1/absences/employments/{id}/absence_infoget/api/v1/absences/employments/{id}/carry_over_infoget/api/v1/absences/{id}/withdrawpost/api/v1/absences/{id}delete/api/v1/absences/{id}get/api/v1/absences/{id}put/api/v1/absences/{id}/approvepost/api/v1/absences/{id}/attachmentpost/api/v1/absences/{id}/declinepostabsence_entitlements/api/v2/absence_entitlementsget/api/v2/absence_entitlementsputabsence_reasons/api/v1/absence_reasonsget/api/v1/absence_reasonspost/api/v1/absence_reasons/statsget/api/v1/absence_reasons/{id}delete/api/v1/absence_reasons/{id}get/api/v1/absence_reasons/{id}putassignment_groups/api/v1/assignment_groupsget/api/v1/assignment_groupspost/api/v1/assignment_groups/{id}delete/api/v1/assignment_groups/{id}get/api/v1/assignment_groups/{id}put/api/v1/assignment_groups/{id}/add_shiftput/api/v1/assignment_groups/{id}/assign_employmentpost/api/v1/assignment_groups/{id}/remove_shiftput/api/v1/assignment_groups/{id}/unassign_employmentpostavailabilities/api/v1/availabilitiesget/api/v1/availabilitiespost/api/v1/availabilities/exceptionsget/api/v1/availabilities/exceptions/{exception_id}delete/api/v1/availabilities/exceptions/{exception_id}get/api/v1/availabilities/{availability_id}delete/api/v1/availabilities/{availability_id}get/api/v1/availabilities/{availability_id}put/api/v1/availabilities/{availability_id}/exceptionsget/api/v1/availabilities/{availability_id}/exceptionspostavailability_aggregations/api/v1/availability_aggregationsgetbackground_jobs/api/v1/background_jobsget/api/v1/background_jobs/{id}getbulk_requests/api/v1/bulk_requestspost/api/v1/bulk_requests/{id}getchat_messages/api/v1/chat_messagesget/api/v1/chat_messagespost/api/v1/chat_messages/chatsget/api/v1/chat_messages/employmentsgetcalendar/api/v1/calendar/aggregationsgetcompanies/api/v1/companiesget/api/v1/companiespost/api/v1/companies/{id}getcustom_fields/api/v1/custom_fieldsget/api/v1/custom_fieldspost/api/v1/custom_fields/{id}delete/api/v1/custom_fields/{id}get/api/v1/custom_fields/{id}putemployee_evaluations/api/v1/employee_evaluations/{evaluation_id}/tagsget/api/v1/employee_evaluations/{evaluation_id}/tagspost/api/v1/employee_evaluations/{evaluation_id}/tags/{evaluation_tag_id}delete/api/v1/employee_evaluations/{staff_shift_id}delete/api/v1/employee_evaluations/{staff_shift_id}get/api/v1/employee_evaluations/{staff_shift_id}post/api/v1/employee_evaluations/{staff_shift_id}/acceptpost/api/v1/employee_evaluations/{staff_shift_id}/evaluation_breakpost/api/v1/employee_evaluations/{staff_shift_id}/evaluation_break/{evaluation_break_id}delete/api/v1/employee_evaluations/{staff_shift_id}/evaluation_break/{evaluation_break_id}put/api/v1/employee_evaluations/{staff_shift_id}/paymentsget/api/v1/employee_evaluations/{staff_shift_id}/paymentspost/api/v1/employee_evaluations/{staff_shift_id}/payments/{payment_id}get/api/v1/employee_evaluations/{staff_shift_id}/payments/{payment_id}putemployments/api/v2/employmentspost/api/v1/employmentsget/api/v1/employments/infoget/api/v1/employments/myget/api/v1/employments/potential_conflictsget/api/v1/employments/{id}delete/api/v1/employments/{id}get/api/v1/employments/{id}/availabilitiesget/api/v1/employments/{id}/destroy_employmentpost/api/v1/employments/{id}/live_infoget/api/v1/employments/{id}/notificationsget/api/v1/employments/{id}/yearly_bring_shiftsget/api/v1/employments/{id}/yearly_bring_shifts/for_yearput/api/v1/employments/{id}/restore_employmentpost/api/v1/employments/{id}/rightsget/api/v1/employments/{id}/paygradesget/api/v1/employments/{id}/paygradespost/api/v1/employments/{id}/paygrades/{paygrade_id}delete/api/v1/employments/{id}/paygrades/{paygrade_id}get/api/v1/employments/{id}/paygrades/{paygrade_id}put/api/v1/employments/{id}/ui_settingsget/api/v1/employments/{id}/ui_settingspostemployments_paygrades/api/v1/employments_paygradesgetemployments_positions/api/v1/employments_positionsget/api/v1/employments_positionspost/api/v1/employments_positions/{id}delete/api/v1/employments_positions/{id}getemployments_rotation_groups/api/v1/employments_rotation_groupsget/api/v1/employments_rotation_groupspost/api/v1/employments_rotation_groups/{id}delete/api/v1/employments_rotation_groups/{id}putemployments_surveys/api/v1/employments_surveys/{id}get/api/v1/employments_surveys/{id}postevaluations/api/v1/evaluationsget/api/v1/evaluations/{staff_shift_id}get/api/v1/evaluations/{staff_shift_id}post/api/v1/evaluations/{staff_shift_id}/did_not_showpost/api/v1/evaluations/{staff_shift_id}/did_showpost/api/v1/evaluations/{staff_shift_id}/evaluation_breakspost/api/v1/evaluations/{staff_shift_id}/evaluation_breaks/{evaluation_break_id}delete/api/v1/evaluations/{staff_shift_id}/evaluation_breaks/{evaluation_break_id}put/api/v1/evaluations/{staff_shift_id}/paymentsget/api/v1/evaluations/{staff_shift_id}/paymentspost/api/v1/evaluations/{staff_shift_id}/payments_calculationget/api/v1/evaluations/{staff_shift_id}/payments/{payment_id}delete/api/v1/evaluations/{staff_shift_id}/payments/{payment_id}get/api/v1/evaluations/{staff_shift_id}/payments/{payment_id}putevaluation_breaks/api/v1/evaluation_breaksgetindividual_rotations/api/v1/individual_rotationsget/api/v1/individual_rotationspost/api/v1/individual_rotations/{id}delete/api/v1/individual_rotations/{id}get/api/v1/individual_rotations/{id}putlanguages/api/v1/languagesgetlive_staff_shifts/api/v1/live_staff_shiftsgetlocations/api/v1/locationsget/api/v1/locationspost/api/v1/locations/{id}delete/api/v1/locations/{id}get/api/v1/locations/{id}put/api/v1/locations/{id}/destroy_locationpost/api/v1/locations/{id}/shiftplan_publish_settingsget/api/v1/locations/{id}/shiftplan_publish_settingsputlocations_positions/api/v1/locations_positionsget/api/v1/locations_positionspost/api/v1/locations_positions/{id}delete/api/v1/locations_positions/{id}getlogin/api/v1/loginpostnewsfeeds/api/v1/newsfeedsget/api/v1/newsfeedspostnotification_configurations/api/v1/notification_configurationsget/api/v1/notification_configurations/notification_filterget/api/v1/notification_configurations/notification_filterput/api/v1/notification_configurations/{id}get/api/v1/notification_configurations/{id}putpayments/api/v1/payments/{staff_shift_id}getpaygrade_types/api/v1/paygrade_typesget/api/v1/paygrade_types/{id}getpayslips/api/v1/payslipsget/api/v1/payslipspostpositions/api/v1/positionsget/api/v1/positionspost/api/v1/positions/{id}delete/api/v1/positions/{id}get/api/v1/positions/{id}put/api/v1/positions/{id}/add_employmentput/api/v1/positions/{id}/destroy_positionpost/api/v1/positions/{id}/remove_employmentputpunch_timings/api/v1/punch_timingsget/api/v1/punch_timings/fetch_locations_positionsget/api/v1/punch_timings/punch_timeget/api/v1/punch_timings/recordget/api/v1/punch_timings/shift_createpost/api/v1/punch_timings/startpost/api/v1/punch_timings/{id}put/api/v1/punch_timings/{punch_timing_id}/punch_breakspost/api/v1/punch_timings/{punch_timing_id}/punch_breaks/{id}putqualifications/api/v1/qualificationsgetreplaced_evaluations/api/v1/replaced_evaluationsgetreplace_requests/api/v1/replace_requests/{id}deleterequests/api/v1/requestsget/api/v1/requests/accept_swap_shiftpost/api/v1/requests/apply_shiftpost/api/v1/requests/change_shiftpost/api/v1/requests/confirm_apply_shiftpost/api/v1/requests/confirm_swap_shiftpost/api/v1/requests/joinpost/api/v1/requests/swap_shiftpost/api/v1/requests/replacepost/api/v1/requests/replace/acceptpost/api/v1/requests/replace/confirmpost/api/v1/requests/{id}get/api/v1/requests/{id}deleterights/api/v1/rightsget/api/v1/rights/locations_position_payment_manage_rightput/api/v1/rights/locations_position_payment_manage_rightdelete/api/v1/rights/locations_position_payment_show_rightdelete/api/v1/rights/locations_position_payment_show_rightput/api/v1/rights/locations_position_shift_manage_rightdelete/api/v1/rights/locations_position_shift_manage_rightput/api/v1/rights/locations_position_shift_show_rightdelete/api/v1/rights/locations_position_shift_show_rightput/api/v1/rights/location_payment_manage_rightdelete/api/v1/rights/location_payment_manage_rightput/api/v1/rights/location_payment_show_rightdelete/api/v1/rights/location_payment_show_rightput/api/v1/rights/location_shift_manage_rightdelete/api/v1/rights/location_shift_manage_rightput/api/v1/rights/location_shift_show_rightdelete/api/v1/rights/location_shift_show_rightput/api/v1/rights/myget/api/v1/rights/{id}delete/api/v1/rights/{id}putsessions/api/v1/sessions/refreshpostshiftplans/api/v1/shiftplansget/api/v1/shiftplanspost/api/v1/shiftplans/assign_employments_to_open_shiftspost/api/v1/shiftplans/{id}delete/api/v1/shiftplans/{id}get/api/v1/shiftplans/{id}patch/api/v1/shiftplans/{id}/assign_rotationpost/api/v1/shiftplans/{shiftplan_id}/copypost/api/v1/shiftplans/{shiftplan_id}/copy_to_existingpost/api/v1/shiftplans/{shiftplan_id}/day_notesget/api/v1/shiftplans/{shiftplan_id}/day_notespost/api/v1/shiftplans/{shiftplan_id}/day_notes/{id}delete/api/v1/shiftplans/{shiftplan_id}/day_notes/{id}put/api/v1/shiftplans/{id}/employments_infoget/api/v1/shiftplans/{shiftplan_id}/messagespost/api/v1/shiftplans/{shiftplan_id}/notificationsget/api/v1/shiftplans/{shiftplan_id}/notifications_messagespost/api/v1/shiftplans/{id}/publishpostshifts/api/v1/shiftsget/api/v1/shiftspost/api/v1/shifts/connectpost/api/v1/shifts/{id}delete/api/v1/shifts/{id}get/api/v1/shifts/{id}patch/api/v1/shifts/{id}put/api/v1/shifts/{id}/available_employmentsget/api/v1/shifts/{id}/clonepost/api/v1/shifts/{id}/disconnectpost/api/v1/shifts/{id}/evaluationsget/api/v1/shifts/{shift_id}/evaluation_tagsdelete/api/v1/shifts/{shift_id}/evaluation_tagsget/api/v1/shifts/{shift_id}/evaluation_tagspost/api/v2/shifts/{id}/paygradesput/api/v1/shifts/{shift_id}/paygradesget/api/v1/shifts/{shift_id}/paygradespost/api/v1/shifts/{shift_id}/paygrades/{id}delete/api/v1/shifts/{shift_id}/paygrades/{id}put/api/v1/shifts/{shift_id}/shift_breakspost/api/v1/shifts/{shift_id}/shift_breaks/{id}delete/api/v1/shifts/{shift_id}/shift_breaks/{id}patchshifts_tags/api/v1/shifts_tagsget/api/v1/shifts_tags/{id}getshift_assignment_groups/api/v1/shift_assignment_groupsgetshift_breaks/api/v1/shift_breaksgetshift_presets/api/v1/shift_presetsgetshift_rotations/api/v1/shift_rotationsget/api/v1/shift_rotationspost/api/v1/shift_rotations/{id}delete/api/v1/shift_rotations/{id}get/api/v1/shift_rotations/{id}put/api/v1/shift_rotations/{id}/shiftplanpostshift_rotation_groups/api/v1/shift_rotation_groupsget/api/v1/shift_rotation_groupspost/api/v1/shift_rotation_groups/{id}delete/api/v1/shift_rotation_groups/{id}put/api/v1/shift_rotation_groups/{id}/assign_employeepost/api/v1/shift_rotation_groups/{id}/assign_to_shiftspost/api/v1/shift_rotation_groups/{id}/unassign_employeepost/api/v1/shift_rotation_groups/{id}/unassign_from_shiftspostspecial_dates/api/v1/special_datesget/api/v1/special_datespost/api/v1/special_dates/{id}delete/api/v1/special_dates/{id}get/api/v1/special_dates/{id}putsso_settings/api/v1/sso_settings/sso_target_urlgetstaff_shifts/api/v1/staff_shiftsget/api/v1/staff_shiftspost/api/v1/staff_shifts/move_staffpost/api/v1/staff_shifts/replacepost/api/v1/staff_shifts/{id}delete/api/v1/staff_shifts/{id}getstaff_shifts_tags/api/v1/staff_shifts_tagsdelete/api/v1/staff_shifts_tagsget/api/v1/staff_shifts_tagspost/api/v1/staff_shifts_tags/{id}gettags/api/v1/tagsget/api/v1/tagspost/api/v1/tags/{id}delete/api/v1/tags/{id}get/api/v1/tags/{id}put/api/v1/tags/{id}/add_to_shiftput/api/v1/tags/{id}/remove_from_shiftputtranslations/api/v1/translationsget/api/v1/translationspost/api/v1/translations/{id}delete/api/v1/translations/{id}get/api/v1/translations/{id}putusers/api/v1/usersget/api/v1/userspost/api/v1/users/change_localepost/api/v1/users/update_passwordpost/api/v1/users/{id}get/api/v1/users/{id}putPowered by HR Master Data SyncMore details about how to synchronize the most relevant employee data between shyftplan and an external system are available on our FAQ page. To access this page you need to be logged in with your shyftplan account.
