GET
/
locations
/
{id}
curl --request GET \
  --url https://api.flatpeak.com/locations/{id} \
  --header 'Authorization: Bearer <token>'
{
  "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.

Path Parameters

​
id
string
required

FlatPeak location_id

Query Parameters

​
include_tariff
boolean

Set to true if you want to include tariff data.

Response

200
application/json
Example response

This object represents a supply address.

​
id
string
required

FlatPeak unique location Id

​
object
string
required

Represents the object’s type. I.e. location.

​
live_mode
boolean
required

Has the value true if the object exists in live mode or the value false if the object exists in test mode.

​
time_created
string
required

Time when the object was created, in UTC.

​
account_id
string
required

FlatPeak account ID.

​
reference_id
string

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

​
customer_id
string

FlatPeak customer ID.

​
timezone
string

The timezone at the location, in 'tz database format'. I.e. 'Europe/Berlin'.

​
currency_code
string

Currency at the location in ISO 4217.

​
postal_address
object

Information on the postal address.

​
geo_location
object

Latitude and longitude of the location. FlatPeak resolves this automatically using the postal_adddess that you provide. This information is used to determine market price and carbon regions.

​
tariff_status
object

Health status of tariff elements.

​
tariff_elements
string[]

An array of tariff IDs that apply to this location. To manage tariffs for a location, use /tariffs/elements endpoint. NOTE: This field is in beta and is not currently generally supported. Check back in early September 2024.

Was this page helpful?

Suggest editsRaise issue
List locationsRetrieve a location status