Skip to main content
GET
Retrieve a location

Authorizations

Authorization
string
header
required

Authenticate with the bearer_token obtained from the authentication endpoint.

Path Parameters

location_id
string
required

Flatpeak Location ID, from the Device object.

Response

Location response.

The property a device sits behind, as far as the customer's consents let you see it. The OEM creates locations. Read one for its timezone, currency, metering and your devices there.

id
string
required

Flatpeak Location ID.

Pattern: ^[a-z]{2,4}_[A-Za-z0-9]+$
Example:

"loc_65e42ce4d3b813479b252160"

object
enum<string>
required

Object type, location.

Available options:
location
Example:

"location"

live_mode
boolean
required

true for live data, false for test data.

oem_id
string
required

Flatpeak OEM ID: the OEM whose account holds the location. A household with devices from two OEMs has a location under each. See list all OEMs.

Pattern: ^oem_[A-Za-z0-9]+$
Example:

"oem_6a3a8dada72cd0a249ff9528"

timezone
string
required

IANA timezone at the location.

Example:

"Europe/London"

currency_code
string
required

ISO 4217 currency of the location's market.

Pattern: ^[A-Z]{3}$
Example:

"GBP"

postal_address
PostalAddress · object | null
required

Postal address of the location. Populated only when a device there has granted you the LOCATION consent scope; null otherwise.

geo_location
GeoLocation · object | null
required

Geographic coordinates of the location. Populated only when a device there has granted you the LOCATION consent scope; null otherwise.

metering
LocationMetering · object
required
read-only

Who meters the location's grid connection point, as the OEM declares it.

device_ids
string[]
required

Flatpeak Device IDs at the location that are connected to your account. Devices connected to other accounts are never listed.

Example:
time_created
string<date-time>
required

Time when the object was created, in UTC.

Example:

"2026-07-08T11:25:39Z"