locations

Get Locations

Changed on

Get all locations with pagination

get/api/locations/

Request

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

Query parameters

delivery_typestring[] nullable

Filter by one or more delivery types

statusLocationStatusEnum[] nullable

Filter by one or more location statuses

location_group_idstring[] nullable

Filter by one or more location groups

searchstring nullable

Case-insensitive filter across the address/postal code, location, contact and guardian names, food restrictions, delivery group, and phone numbers

pageinteger

Page number (1-indexed)

page_sizeinteger

Number of items per page

Response

Successful Response

pageinteger required
page_sizeinteger required
totalinteger required
total_pagesinteger required

Changes