moovexDocs

Get locations

Retrieve paginated list of locations.

GET/locations

Query Parameters

ParameterTypeRequiredDescription
sortstringNoSort by field:asc/desc Allowed: asc, desc
typestring[]NoFilter by location types
facilityType"school""work"No
limitnumberYes-
pagenumberYes-
searchstringNo-

Example Response

{
  "page": 1,
  "limit": 20,
  "totalPages": 1,
  "totalResults": 2,
  "records": [
    {
      "id": 10,
      "name": "Main Depot",
      "type": "location",
      "address": "123 Main St",
      "lat": 32.0853,
      "lng": 34.7818,
      "waitingTime": 15,
      "isWaitAndReturn": true
    }
  ]
}

On this page