v1

latestOpenAPI 3.1.02026-08-0662251219.8 KB
Legal Entities

List legal entities

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.

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

Query parameters

pageNumberinteger
Example:2

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

pageSizeinteger
Example:20

Page size to be to fetch for the query.

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"
    }
  ]
}