DEdeputy
Shifts

manager to get rosters; replacement of v1 getRosters

manager to get rosters; replacement of v1 getRosters.

post/management/v2/shifts:getRosters

Request

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

Request body

locationMode'ALL' | 'SELECTED'

LocationMode specifies how location filtering should be applied.

  • ALL: Include all locations accessible by the current user (no filtering)
  • SELECTED: Filter to only selected locations (requires locationIds to be provided)
locationIdsinteger[]
startstring
endstring
open'NOT_SPECIFIED' | 'TRUE' | 'ALL'
published'NOT_SPECIFIED' | 'TRUE' | 'ALL' | 'FALSE'
includeEmployeePhotoboolean
expandMetadataboolean

Response

A successful response.

successboolean

Changes

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