Sign in

v1

latestOpenAPI 3.1.02026-07-26549156879.0 KB
Locations > Location

Reads a single Location

Reads a single Location

get/api/2026-07-01/resources/locations/locations/{id}

Path parameters

idstring required

The location IDs to filter the results.

Response

OK

idstring required

identifier of the location

company_idstring required

company identifier

namestring required

name of the location

timezonestring

timezone of the location

countrystring

country code of the location

statestring

State of the location

citystring

City of the location

address_line_1string

Address line 1 of the location

address_line_2string

Address line 2 of the location

postal_codestring

Postal code of the location

phone_numberstring

phone number of the location

mainboolean required

whether the location is the main one

latitudenumber

latitude of the location

longitudenumber

longitude of the location

radiusnumber

radius of the location

siretstring

siret of the location (only for France)

Example response

{
  "id": "1",
  "company_id": "1",
  "name": "Barcelona Office",
  "timezone": "Europe/Madrid",
  "country": "es",
  "state": "Barcelona",
  "city": "Barcelona",
  "address_line_1": "Carrer Mallorca",
  "address_line_2": "61 2A",
  "postal_code": "08005",
  "phone_number": "657483987",
  "latitude": 52.378,
  "longitude": 4.898,
  "radius": 5,
  "siret": "FR00123456789"
}