v1

latestOpenAPI 3.1.02026-08-0662251219.8 KB
Offices

List company offices

post/v2/companies/{companyId}/office-list

Request body

searchTextstring

Search text

Example request

{
  "sortParams": {
    "sortOrder": "DESC"
  },
  "filters": [
    {
      "countries": [
        "US",
        "IN"
      ]
    }
  ]
}

Response

OK

Example response

{
  "offices": [
    {
      "legalEntityRef": {
        "id": "b93dc51f-12dd-46c7-b7d6-1cb12cd3f5b3",
        "name": "Name"
      },
      "office": {
        "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"
      }
    }
  ]
}