v1

latestOpenAPI 3.1.0Apache 2.02026-07-22160175414.0 KB
Legal-Units

List legal-units

Retrieve a paginated list of legal-units.

get/organization/structure/api/legal-units

Query parameters

idinteger[]

Comma-separated list of legal-unit IDs.

searchstring

Search legal-units based on their name.

isArchived'true' | 'false' | 'true,false'

Filter on the "isArchived" status. By default, is equal to "false", thus archived legal-units are not returned. To return both archived and non-archived legal units, use ?isArchived=true,false.

pageinteger

Page number

limitinteger

Page size

fields.root'count'

Include collection properties.

Response

OK

prevstring nullable

Cursor of the previous page (used with the ?page={{cursor}} query parameter).

nextstring nullable

Cursor of the next page (used with the ?page={{cursor}} query parameter).

Example response

{
  "items": [
    {
      "country": {
        "defaultTimeZone": "Europe/Paris"
      }
    }
  ]
}