API Reference

My schedule

post
https://{subdomain}.{region}.deputy.com/api/schedule/v2/me/shifts:search

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.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
enum
Defaults to ALL

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)
Allowed:
locationIds
array of int32s
this is required when locationMode is SELECTED
string
string
boolean

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

Response

Updated 3 months ago

Did this page help you?
Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 3 months ago

Did this page help you?