List Locations

List all locations.

get/v1/locations/location

Query parameters

cursorstring nullable

Pagination cursor. Mutually exclusive with other query parameters

external_idstring nullable

External location identifier to match exactly.

external_id:instring nullable

External location identifiers to match. Comma-separated list.

Response

Successful Response

next_cursorstring nullable

Example response

{
  "items": [
    {
      "latitude": 51.0543,
      "longitude": 3.7174,
      "code": "LOC123",
      "display_name": "Main Office",
      "address": "Gaston Crommenlaan 4",
      "city": "Ghent",
      "country": "BE",
      "postal_code": "9050",
      "name": "Qargo HQ",
      "opening_hours": {
        "monday": {
          "intervals": [
            {
              "start_time": "08:00",
              "end_time": "17:30"
            }
          ]
        },
        "tuesday": {
          "intervals": [
            {
              "start_time": "08:00",
              "end_time": "17:30"
            }
          ]
        },
        "wednesday": {
          "intervals": [
            {
              "start_time": "08:00",
              "end_time": "17:30"
            }
          ]
        },
        "thursday": {
          "intervals": [
            {
              "start_time": "08:00",
              "end_time": "17:30"
            }
          ]
        },
        "friday": {
          "intervals": [
            {
              "start_time": "08:00",
              "end_time": "17:30"
            }
          ]
        },
        "saturday": {
          "intervals": [
            {
              "start_time": "08:00",
              "end_time": "17:30"
            }
          ]
        },
        "sunday": {
          "intervals": [
            {
              "start_time": "08:00",
              "end_time": "17:30"
            }
          ]
        }
      }
    }
  ]
}

Changes

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