DEdeputy
Shifts

My schedule

Gets the schedule for the current user. The schedule includes information about the shifts for the current user such as the shifts, the bids, and the metadata.

post/schedule/v2/me/shifts:search

Request

  • Base URL
    https://your-subdomain.deputy.deputy.com/api
  • URL
    https://your-subdomain.deputy.deputy.com/api/schedule/v2/me/shifts:search
  • 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
expandMetadataboolean

If true, includes additional metadata such as custom field definitions.

Response

A successful response.

successboolean

Changes

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