List Locations

Retrieve a list of locations. The list can be filtered, sorted, and paginated using the parameters below.

GET /locations

List Locations

cURL

curl --request GET \
  --url https://api.loopreturns.com/api/v1/locations \
  --header 'X-Authorization: <api-key>'

200

{
  "locations": [
    {
      "id": 123,
      "external_id": "<string>",
      "channel": "<string>",
      "name": "<string>",
      "address": {
        "address1": "<string>",
        "city": "<string>",
        "country_code": "<string>",
        "name": "<string>",
        "company": "<string>",
        "address2": "<string>",
        "region": "<string>",
        "postal_code": "<string>"
      }
    }
  ],
  "next_page_url": "<string>",
  "previous_page_url": "<string>"
}

Authorizations

X-Authorization · string · header · required

API Scope: "Locations (read)"

Query Parameters

external_id · string

An external_id used to filter the locations.

limit · integer · default: 50

The maximum number of locations returned.

Required range: 1 <= x <= 250

sort_order · enum<string> · default: asc

The sort order for the results.

Available options: asc, desc

cursor · string

The cursor to return the next page of results.

Response

200

application/json

Success

locations · object[]

Show child attributes

next_page_url · string

previous_page_url · string