NEW - Shift Suggestions

Suggest employees for a shift

Suggest employees for a shift. This is a synchronous API that returns a list of employees who are either recommended or not recommended taking into account hard constraints such as overlapping shifts and soft constraints such as unavailability, leave, not trained, not preferred, stressed, and onboarding status. The request must include required fields such as start/end times, employee and area. If the list is greater than 100, a cursor will be returned to paginate the remaining results. Optional filters can be provided to filter the employees considered for the shift.

post/management/v2/shifts:suggestEmployees

Request

  • Base URL
    https://your-subdomain.deputy.deputy.com/api
  • URL
    https://your-subdomain.deputy.deputy.com/api/management/v2/shifts:suggestEmployees
  • Auth
    API key in header OAuth

Request body

areainteger
startstring
endstring
mealbreakDurationinteger
shiftIdinteger
cursorstring
limitinteger

Response

A successful response.

successboolean

Changes

No recorded changes to this operation across all 1 revision of this API.