v1

latestOpenAPI 3.1.0Apache 2.02026-07-22160175414.0 KB

Establishments

List establishments

Retrieve a list of establishments.

get/organization/structure/api/establishments

Query parameters

idinteger[]

Comma-separated list of establishment IDs.

legalUnitIdinteger[]

ID(s) of the legal-unit(s) establishments must belong to.

searchstring

Search based on the establishment name.

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

Filter out establishments based on their archival status. By default, archived establishments are not returned. To return both archived and non-archived establishments, use ?isArchived=true,false

pageinteger

Page number

limitinteger

Page size

fields.root'count'

Include collection properties.

Response

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": [
    {
      "legalUnit": {
        "country": {
          "defaultTimeZone": "Europe/Paris"
        }
      },
      "timezoneId": "Europe/Paris"
    }
  ]
}