Skip to main content

Get Shift

Retrieve a single staff shift by ID.

Endpointโ€‹

GET /v1/staff/shifts/{id}

Authenticationโ€‹

Requires an API key with the staff:read scope.

Path Parametersโ€‹

ParameterTypeDescription
idintegerThe shift ID

Responseโ€‹

Success (200 OK)โ€‹

{
"data": {
"id": 1,
"staff": {
"id": 5,
"first_name": "Jane",
"last_name": "Smith"
},
"staff_id": 5,
"location": {
"id": 2,
"name": "Beach Location"
},
"location_id": 2,
"shift_date": "2026-03-15",
"start_time": "09:00:00",
"end_time": "17:00:00",
"duration_calculation": "8 hours",
"break_setting": true,
"break_type": "lunch_break",
"break_time": "30",
"break_payment": "paid",
"shift_notes": "Morning briefing at 8:45",
"status": "Published",
"publish_type": null,
"created_at": "2026-03-10T08:00:00+00:00",
"updated_at": "2026-03-10T08:00:00+00:00"
},
"meta": {
"request_id": "req_abc123",
"timestamp": "2026-03-10T12:00:00+00:00"
}
}

Errorsโ€‹

StatusCodeDescription
401authentication_requiredNo API key provided
401invalid_api_keyInvalid API key
403insufficient_scopeAPI key lacks staff:read scope
403forbiddenShift belongs to a different supplier
404not_foundShift not found

Example Requestโ€‹

curl -X GET "https://app.equipdash.com/api/v1/staff/shifts/1" \
-H "Authorization: Bearer eqd_live_abc123xyz789..."