DEdeputy
Shifts

Retrieve list of shifts

Retrieve list of shifts.

get/management/v2/shifts

Request

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

Query parameters

startstring

Filters shifts starting at or after this time. Format: ISO8601 datetime (e.g., "2023-03-11T13:45:00+11:00"). Default: 7 days ago from today.

endstring

Filters shifts starting before this time (exclusive). Format: ISO8601 datetime (e.g., "2023-03-11T18:45:00+11:00"). Default: today at 00:00:00.

employeestring int64

Mandatory field. Filters shifts for a specific employee ID.

timesheetstring int64

Not implemented.

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

Filters shifts by published status (PUBLISHED, UNPUBLISHED, etc.).

  • NOT_SPECIFIED: Not specified
  • TRUE: Published
  • ALL: Both published and unpublished
  • FALSE: Unpublished only
cursorstring

Pagination cursor from a previous response. Used to fetch the next page of results.

limitinteger

Maximum number of shifts to return in a single response. Used for pagination.

expandMetadataboolean

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

Response

A successful response.

successboolean

Indicates whether the request was successful.

nextCursorstring

Cursor to fetch the next page of results. Present only if more results are available.

Changes

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