API Reference

Retrieve an aggregated list of shifts

get
https://{subdomain}.{region}.deputy.com/api/management/v2/shifts:aggregated

Retrieve an aggregated list of shifts.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

Filters shifts starting at/after start e.g. 2023-03-11T13:45:00, default -7 days from today.

string

Filters shift starting before end exclusively e.g. 2023-03-11T18:45:00, default today at 00:00:00.

string

Filters shifts for an employee ID.

string

Filters shifts for matched or unmatched timesheet.

string
enum
Defaults to NOT_SPECIFIED

Filters shifts for published status.

  • NOT_SPECIFIED: Not specified
  • TRUE: Published
  • ALL: Both published and unpublished
  • FALSE: Unpublished only
Allowed:
string
enum
Defaults to DAILY

Aggregation frequency.

Allowed:
boolean

Omit empty periods in response array.

boolean

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

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?