Skip to main content
GET
Retrieve a location

Authorizations

Authorization
string
header
required

Bearer token obtained from POST /auth/tokens.

Path Parameters

location_id
string
required

Flatpeak Location ID.

Response

Location response.

A supply address.

id
string
required

Flatpeak Location ID.

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

"loc_641b90b758fb8e6293716e40"

object
enum<string>
default:location
required

Object type.

Available options:
location
Example:

"location"

live_mode
boolean
required

true for live data, false for test data.

user_id
string
required

Flatpeak ID of the user this location belongs to. Every location is owned by a user.

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

"usr_65e421d1daa4a24082b4f590"

reference_id
string

Your own reference, for example an ID from your system.

Example:

"LOC1234567890"

timezone
string

Timezone at the location, tz database name such as Europe/Berlin.

Example:

"Europe/London"

currency_code
string

Currency at the location in ISO 4217.

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

"EUR"

postal_address_verified
boolean

true when Flatpeak has verified the address and resolved its timezone, currency_code and geo_location.

postal_address
PostalAddress · object

Postal address of the location.

geo_location
GeoLocation · object

Geographic coordinates of the location.

device_ids
string[]

Flatpeak IDs of the devices at this location.

time_created
string<date-time>

Time when the object was created, in UTC.

account_id
string

Flatpeak Account ID.

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

"acc_661677911f2197045e6cf1b1"