Skip to main content
GET
/
organization
/
structure
/
api
/
establishments
List establishments
curl --request GET \
  --url https://{host}/organization/structure/api/establishments \
  --header 'Authorization: <authorization>'
{
  "items": [
    {
      "id": 2,
      "name": "<string>",
      "legalUnitId": 2,
      "code": "<string>",
      "legalUnit": {
        "id": 2,
        "name": "<string>",
        "countryId": "<string>",
        "code": "<string>",
        "legalIdentificationNumber": "<string>",
        "activityCode": "<string>",
        "country": {
          "id": 2,
          "name": "<string>",
          "code": "<string>",
          "currencyCode": "<string>",
          "currency": {
            "code": "<string>",
            "englishName": "<string>",
            "symbol": "<string>"
          },
          "defaultTimeZone": "Europe/Paris"
        },
        "headquartersId": 123,
        "createdAt": "2023-11-07T05:31:56Z",
        "isArchived": true
      },
      "legalIdentificationNumber": "<string>",
      "activityCode": "<string>",
      "calendarId": 123,
      "address": {
        "street": "<string>",
        "zipCode": "<string>",
        "city": "<string>"
      },
      "timezoneId": "Europe/Paris",
      "usersCount": 1,
      "createdAt": "2023-11-07T05:31:56Z",
      "author": {
        "id": 2,
        "firstName": "<string>",
        "lastName": "<string>",
        "fullname": "<string>",
        "url": "<string>"
      },
      "isArchived": true
    }
  ],
  "prev": "<string>",
  "next": "<string>"
}

Headers

​
Authorization
string
required

API key. Value must be formatted like so: lucca application={api_key}.

Query Parameters

​
id
integer<int32>[]

Comma-separated list of establishment IDs.

Required range: x >= 1
​
legalUnitId
integer<int32>[]

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

Required range: x >= 1
​
search
string

Search based on the establishment name.

​
isArchived
enum<string>
default: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

Available options:
true,
false,
true,false
​
page
default:1

Page index (int - starts at 1) or cursor (string)

​
limit
integer<int32>
default:10

Page size.

Required range: 0 <= x <= 100
​
fields.root
enum<string>[]

Include prev and next pages cursors, as well as the number of all items across all pages (count).

Available options:
prev,
next,
count

Response

OK

​
items
establishment · object[]
​
prev
string | null

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

​
next
string | null

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