DEdeputy
Shifts

Retrieve an aggregated list of shifts

Retrieve an aggregated list of shifts.

get/management/v2/shifts:aggregated

Request

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

Query parameters

startstring

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

endstring

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

employeestring int64

Filters shifts for an employee ID.

timesheetstring int64

Filters shifts for matched or unmatched timesheet.

published'NOT_SPECIFIED' | 'TRUE' | 'ALL' | 'FALSE'

Filters shifts for published status.

  • NOT_SPECIFIED: Not specified
  • TRUE: Published
  • ALL: Both published and unpublished
  • FALSE: Unpublished only
frequency'DAILY' | 'WEEKLY'

Aggregation frequency.

omitEmptyPeriodboolean

Omit empty periods in response array.

expandMetadataboolean

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

Response

A successful response.

successboolean

Changes

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