Sign in
routes

Get Route

Get a route by its unique identifier, with its ordered stops embedded.

Each stop carries its sequence #, address, contact name, phone (+ secondary), box count, and a note_chain_id reference. Stops are sourced live from Location for upcoming routes and from frozen route_stop_snapshots for past routes. Notes are not embedded: fetch them via GET /note-chains/{id}/notes.

Parameters: route_id (UUID): The unique identifier of the route to GET. session (AsyncSession): The database session dependency.

Returns: The route with its ordered stops. Responds with HTTP 200 OK on success.

get/api/routes/{route_id}

Request

  • The document declares no server URL.
  • Auth: HTTP bearer

Path parameters

route_idstring uuid required

Response

Successful Response

cloned_from_route_idstring uuid nullable
delivery_typestring nullable
drive_datestring date required
driver_idstring uuid nullable
encoded_polylinestring nullable
ends_at_warehouseboolean
lengthnumber required
namestring
note_chain_idstring uuid nullable
notesstring
polyline_updated_atstring date-time nullable
route_group_idstring uuid required
route_idstring uuid required
start_timestring time nullable

Changes

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