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

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

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

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

items

establishment · object[]

Show child attributes

items.id

integer<int32>

required

Required range: x >= 1

items.name

string

required

Required string length: 0

items.legalUnitId

integer<int32>

required

Required range: x >= 1

items.code

string | null

Required string length: 0

items.legalUnit

legal-unit · object

Show child attributes

items.legalUnit.id

integer<int32>

required

Required range: x >= 1

items.legalUnit.name

string

required

Required string length: 0

items.legalUnit.countryId

string

required

ISO 3166 alpha-2 code for the country this legal-unit belongs to.

Required string length: 2

items.legalUnit.code

string | null

Required string length: 0

items.legalUnit.legalIdentificationNumber

string | null

Depends on the country:

SIREN in France
NIF code in Spain

Required string length: 0

items.legalUnit.activityCode

string | null

France only: NAF code. Null otherwise.

Required string length: 0

items.legalUnit.country

object

Show child attributes

items.legalUnit.country.id

integer<int32>

Required range: x >= 1

items.legalUnit.country.name

string

items.legalUnit.country.code

string

ISO 3166 alpha-2 code.

items.legalUnit.country.currencyCode

string

ISO 4217 code.

Required string length: 3

items.legalUnit.country.currency

object

Show child attributes

items.legalUnit.country.currency.code

string

ISO 4217 code.

Required string length: 3

items.legalUnit.country.currency.englishName

string

Human readable name for this currency.

items.legalUnit.country.currency.symbol

string

e.g. "€" for euros.

Minimum string length: 1

items.legalUnit.country.defaultTimeZone

string

Identifier of the timezone this legal-unit resides in.

Example:

"Europe/Paris"

items.legalUnit.headquartersId

integer<int32>

Identifier of the establishment that belongs to this legal-unit and should be considered headquarters for the whole group.

items.legalUnit.createdAt

string<date-time>

Timestamp of the moment this legal-unit was created.

items.legalUnit.isArchived

boolean

Is this legal-unit archived and thus should no longer be used?

items.legalIdentificationNumber

string | null

NIF code for Spanish establishment, Siret code for French establishment. Null otherwise.

items.activityCode

string | null

In France, NAF code. Null otherwise.

items.calendarId

integer<int32>

Default holidays calendar for employees in this establishment.

items.address

object

Show child attributes

items.address.street

string

items.address.zipCode

string

items.address.city

string

items.timezoneId

string

Identifier of the timezone this establishment belongs to.

Example:

"Europe/Paris"

items.usersCount

integer

Total number of employees working in this establishment as of today.

Required range: x >= 0

items.createdAt

string<date-time>

Timestamp of the moment this establishment was created.

items.author

object

Show child attributes

items.author.id

integer<int32>

Required range: x >= 1

items.author.firstName

string

items.author.lastName

string

items.author.fullname

string

items.author.url

string<uri>

items.isArchived

boolean

string | null

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

string | null

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

The establishment resource

The user resource

⌘I

Documentation

Files

Organization Structure API

Core HR API

Expenses API

Invoices API

Absences API

Office API

Project API

Schedule API

Timesheet API

Mealvouchers API

Compensation API

Training API

List establishments

Headers

Query Parameters

Response