Get Shift

GET {{base_url}}/api/v3/shifts/{{SHIFT_ID}}

Required scope: shifts:read

Returns one public shift record. Roles: admin, partner, or vendor. The shift must belong to the caller’s operator; missing and foreign-operator IDs both return 404. Internal rider, payout, and Toast fields are omitted.

Examples

cURL

curl --request GET '${base_url}/api/v3/shifts/550e8400-e29b-41d4-a716-446655440000'

Node.js

const response = await fetch("${base_url}/api/v3/shifts/550e8400-e29b-41d4-a716-446655440000", {
  "method": "GET",
  "headers": {}
})
const data = await response.json()

Python

import requests

response = requests.request(
    "GET",
    "${base_url}/api/v3/shifts/550e8400-e29b-41d4-a716-446655440000",
    headers={},
)
response.raise_for_status()

Saved responses

200 200 — Shift returned

{
  "type": "success",
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "retreat_point": "650e8400-e29b-41d4-a716-446655440000",
    "territory_id": "850e8400-e29b-41d4-a716-446655440000",
    "operator_id": 123,
    "start": "2026-10-20T13:00:00.000Z",
    "stop": "2026-10-20T17:00:00.000Z",
    "user_id": "1697c3af-450f-42f4-8609-669a4350c22f",
    "role": "car",
    "hourly_rate": 20,
    "bonus_pay": 10,
    "checked_in": null
  }
}

404 404 — Shift not found or not owned

{
  "type": "error",
  "message": "Shift not found",
  "status": 404
}