DEdeputy
Shifts

Retrieve shift data by given Id

Retrieve shift data by given Id.

get/management/v2/shifts/{id}

Request

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

Path parameters

idinteger required

The ID of the shift to retrieve.

Query parameters

expandMetadataboolean

If true, includes additional metadata such as locations, areas, and employee profiles.

viewContext'EMPLOYEE' | 'MANAGER'

Determines the context of the viewer, affecting what data is returned and permissions checked.

  • EMPLOYEE: Employee context - returns data visible as an employee.
  • MANAGER: Manager context - returns full manager-level data and permissions.

Response

A successful response.

successboolean

Indicates whether the request was successful.

Changes

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