v1

latestOpenAPI 3.1.02026-08-0662251219.8 KB
Offices

Get office

This endpoint gets an office by ID.

get/v2/companies/{companyId}/legal-entities/{legalEntityId}/offices/{officeId}

Response

OK

idstring uuid
namestring
externalIdstring
taxIdstring

Example response

{
  "address": {
    "addressLines": [
      "Golden Gate Bridge"
    ],
    "administrativeArea": "CA",
    "administrativeAreaName": "California",
    "description": "San Francisco Home",
    "isDefault": true,
    "languageCode": "en",
    "locality": "San Francisco",
    "locationCode": "LAX",
    "organization": "Spotnana",
    "postalCode": "94130",
    "continentCode": "AF",
    "regionCode": "US",
    "regionName": "America",
    "revision": 1,
    "sortingCode": "Jamaica",
    "timezone": "America/Los_Angeles",
    "coordinates": {
      "latitude": 77.1025,
      "longitude": 28.7041
    }
  },
  "name": "Office",
  "latlng": {
    "latitude": 77.1025,
    "longitude": 28.7041
  },
  "externalId": "external-id",
  "taxId": "123232"
}