Sign in

v1

latestOpenAPI 3.1.02026-08-0662251219.8 KB
Offices

List offices of the legal entity

This endpoint list offices of given legal entity. If externalId is provided in query param, the office having the externalId is fetched.

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

Query parameters

externalIdstring

External id of the entity.

Response

OK

lengthinteger
totalNumResultsinteger

Total number of results

Example response

{
  "elements": [
    {
      "id": "b93dc51f-12dd-46c7-b7d6-1cb12cd3f5b3",
      "name": "Name"
    }
  ]
}