GET
/
locations
List locations
curl --request GET \
  --url https://api.flatpeak.com/locations \
  --header 'Authorization: Bearer <token>'
{
  "object": "list",
  "url": "/locations",
  "has_more": true,
  "data": [
    {
      "id": "loc_641b90b758fb8e6293716e40",
      "object": "location",
      "reference_id": "LOC1234567890",
      "customer_id": "cus_65e421d1daa4a24082b4f590",
      "live_mode": true,
      "timezone": "Europe/London",
      "currency_code": "EUR",
      "postal_address": {
        "address_line1": "1-3",
        "address_line2": "Strand",
        "city": "London",
        "state": "Greater London",
        "post_code": "WC2N 5EH",
        "country_code": "GB"
      },
      "geo_location": {
        "lat": 50.12345,
        "lng": -1.23456
      },
      "tariff_status": {
        "commodity_import": "CONNECTED",
        "commodity_export": "ERROR",
        "non_commodity_import": "NOT_CONNECTED",
        "non_commodity_export": "NOT_SUPPORTED",
        "local": "NOT_SUPPORTED"
      },
      "tariff_elements": [
        "trf_66ba584eb6923d7c3b942ef6"
      ],
      "time_created": "2023-11-07T05:31:56Z",
      "account_id": "acc_661677911f2197045e6cf1b1"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Authenticate with bearer_token you obtained from /login endpoint.

Query Parameters

​
reference_id
string

A reference that is meaningful to you, for example, an ID from your system.

​
customer_id
string

Flatpeak customer_id.

Example:

"cus_65e421d1daa4a24082b4f590"

​
starting_after
string

Specifies a cursor for pagination use; provider_id defines the place in the list. To retrieve the next page in the list include starting_after where ID is the last ID in the currently retrieved list.

​
limit
integer

A limit on the number of objects to be returned. Can range between 1 and 100, and the default is 30.

​
ending_before
string

Specifies a cursor for pagination use; provider_id defines the place in the list. To retrieve the previous page in the list, include ending_before, which is the first ID in the currently retrieved list.

Response

Example response

The response is of type object.