Skip to content

Get availability

GET {{baseUrl}}/runners/{{userId}}/availability

Returns the driver’s saved weekly availability preferences. Source: models/runner_availability.ts findByUserId().

Response fields:

  • min_hours / max_hours / expected_hours — weekly hour preferences.
  • days_available — array of day-of-week ints (0 = Sunday … 6 = Saturday) the driver is available.
  • shifts_available — named shift blocks the driver prefers (breakfast/lunch/dinner/latenight per the RunnerShiftName enum — the seed data in this collection uses morning/evening, which aren’t in that enum; worth double-checking against your environment).
Terminal window
curl --request GET 'https://api.firstdelivery.com/api/runners/REPLACE_WITH_USER_ID/availability'
{
"id": "d4e5f6a7-2222-4a2b-9c3d-4e5f6a7b8c9d",
"user_id": "8e17d5db-da6e-453c-966f-bfc72c125094",
"min_hours": 10,
"max_hours": 40,
"expected_hours": 20,
"created_at": "2026-06-01T00:00:00.000Z",
"updated_at": "2026-06-20T00:00:00.000Z",
"days_available": [1, 2, 3, 4, 5],
"shifts_available": ["lunch", "dinner"]
}