Skip to main content
GET
/
v1
/
location
Get a list of locations
curl --request GET \
  --url https://app.variable.global/api/v1/location \
  --header 'Authorization: Bearer <token>'
{
  "count": 1500,
  "page": 1,
  "pageSize": 100,
  "data": [
    {
      "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "Tokyo factory",
      "type": "factory",
      "owner": {
        "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "Name"
      },
      "address1": "1-1 Marunouchi",
      "address2": "<string>",
      "postCode": "100-0005",
      "city": "Tokyo",
      "state": "<string>",
      "country": "Japan",
      "geoLocation": {
        "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "googleMapsId": "ChIJA4UGSG_xNIgRNBuiWqEV-Y0",
        "name": "Syracuse, NY, USA",
        "countryCode": "US",
        "latitude": 43.0481,
        "longitude": -76.1474,
        "locationType": "APPROXIMATE"
      }
    }
  ]
}
Requires permission:

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
type
enum<string>

Filter by site type

Available options:
factory,
warehouse,
office,
port,
other
​
company
string<uuid>

Filter by owning company uuid (your own company or an unclaimed supplier of yours)

​
limit
integer

Limit the number of results

Example:

100

​
page
integer

The page number

Example:

1

Response

A list of locations

​
count
integer
Example:

1500

​
page
integer
Example:

1

​
pageSize
integer
Example:

100

​
data
object[]