List legal entities

Request

This endpoint lists legal entities of a company. If externalId is provided in the query param only the legal entity having the provided externalId is returned.

Security

Bearer

Path

companyIdstring, (uuid)required

Identifier for company.

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

Query

pageNumberinteger, (int32), >= 1

Page number to fetch for the query. Page number starts from 1.

Default:1

Example:pageNumber=2

pageSizeinteger, (int32), [ 1 .. 1000 ]

Page size to be to fetch for the query.

Default:1000

Example:pageSize=20

externalIdstring

External id of the entity.

Example:externalId=my-external-id

curl -i -X GET \
  'https://api-ext-sboxmeta.partners.spotnana.com/v2/companies/4974a66b-7493-4f41-908c-58ba81093947/legal-entities?pageNumber=2&pageSize=20&externalId=my-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
}