Skip to main content
GET
/
locations
/
{locationId}
Retrieve a location
curl --request GET \
  --url https://api.openfiskal.com/v1/locations/{locationId} \
  --header 'Authorization: Bearer <token>'
{
  "name": "Berlin Mitte",
  "address": {
    "line1": "Friedrichstraße 42",
    "line2": "<string>",
    "city": "Berlin",
    "state": "<string>",
    "postal_code": "10117",
    "country": "DE"
  },
  "timezone": "Europe/Berlin",
  "metadata": {},
  "id": "loc_01HXYZ",
  "object": "<string>",
  "organization_id": "<string>",
  "created_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

Platform API key sent as Authorization: Bearer ofk_platform_.... Platform integrators also pass OpenFiskal-Organization: org_xxx to act on behalf of a merchant.

Headers

​
OpenFiskal-Organization
string

Merchant organization ID. Required for platform integrators acting on behalf of a specific merchant. Omit when using an organization-scoped API key directly.

Path Parameters

​
locationId
string
required

Response

Location retrieved

​
name
string
required
Example:

"Berlin Mitte"

​
address
object
​
timezone
string
Example:

"Europe/Berlin"

​
metadata
object
​
id
string
Example:

"loc_01HXYZ"

​
object
string
Allowed value: "location"
​
organization_id
string
​
created_at
string<date-time>