Sign in
locations

Get Location

Get a single location by ID

get/api/locations/{location_id}

Request

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

Path parameters

location_idstring uuid required

Response

Successful Response

addressstring required
assigned_routestring nullable
contact_namestring required
delivery_typestring required
dietary_restrictionsstring
guardian_namestring nullable
halalboolean
has_future_routeboolean
in_rosterboolean
last_delivery_datestring date-time nullable
latest_notestring nullable
latitudenumber nullable
location_group_idstring uuid required
location_group_namestring required
location_idstring uuid required
longitudenumber nullable
namestring required
note_chain_idstring uuid nullable
num_childreninteger
phone_primarystring required
phone_secondarystring nullable
place_idstring nullable
status'Active' | 'Unscheduled' | 'Inactive' required

Derived status surfaced on LocationRead. Not stored — computed from Location.in_roster + whether the location appears in a present/future route. Precedence: any present/future route → ACTIVE (regardless of roster); otherwise in_roster → UNSCHEDULED; otherwise → INACTIVE.

total_deliveriesinteger

Changes

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