List offices of the legal entity

Request

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

Security

Bearer

Path

companyIdstring, (uuid)required

Identifier for company.

Example:4974a66b-7493-4f41-908c-58ba81093947

legalEntityIdstring, (uuid)required

Identifier for legal-entity.

Example:4974a66b-7493-4f41-908c-58ba81093946

Query

externalIdstring

External id of the entity.

Example:externalId=office-external-id

curl -i -X GET \
  'https://api-ext-sboxmeta.partners.spotnana.com/v2/companies/4974a66b-7493-4f41-908c-58ba81093947/legal-entities/4974a66b-7493-4f41-908c-58ba81093946/offices?externalId=office-external-id' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK

Bodyapplication/json

lengthinteger, (int32)

elementsArray of objects(Reference object containing uuid and name of the entity.)

List of references containing id and name.

totalNumResultsinteger, (int32)

Total number of results

Response

{
  "length": 0,
  "elements": [
    { … }
  ],
  "totalNumResults": 0
}