List establishments

Status

Introduction

Files

Organization Structure API

Axis-sections
Departments
Legal-Units
Establishments
- The establishment resource
- GET
  List establishments

Core HR API

Employees Directory
Guides

Cleemy Expenses API

Expense-temp-items
Expense-claims
Expense-claim-items

Timmi Absences API

Leaves
Leave-requests
Sick-leaves
Imports
Guides

Timmi Office API

User-locations
Work-locations

Timmi Project API

Clients
Projects
Project services
Organizations
Financials

Timmi Settings API

UserDates
Workcycle-exceptions
Working-time-arrangement

Timmi Timesheet API

Time-entries
Timesheets
Reports
Guides

Pagga Mealvouchers API

Statutory
Computation

Pagga Remuneration API

Fixed-natures
Fixed-items
Variable-natures
Variable-items

Poplee Training API

Training-demands
Realized-trainings

GET

organization

structure

api

establishments

curl --request GET \
  --url https://{account}-{sandboxName}.sandbox.{server}.luccasoftware.com/organization/structure/api/establishments

{
  "items": [
    {
      "id": 2,
      "name": "<string>",
      "code": "<string>",
      "legalUnitId": 2,
      "legalUnit": {
        "id": 2,
        "name": "<string>",
        "code": "<string>",
        "legalIdentificationNumber": "<string>",
        "activityCode": "<string>",
        "countryId": "<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>"
}

Query Parameters

integer[]

Comma-separated list of establishment IDs.

legalUnitId

integer[]

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

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:

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

limit

integer

default:

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

200

application/json

items

object[]

items.id

integer

required

Required range: x > 1

items.name

string

required

items.legalUnitId

integer

required

Required range: x > 1

items.code

string | null

items.legalUnit

object

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

Default holidays calendar for employees in this establishment.

items.address

object | null

items.timezoneId

string

Identifier of the timezone this establishment belongs to.

items.usersCount

integer

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

Required range: x > 0

items.createdAt

string

Timestamp of the moment this establishment was created.

items.author

object

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).

Was this page helpful?

The establishment resource The user resource

curl --request GET \
  --url https://{account}-{sandboxName}.sandbox.{server}.luccasoftware.com/organization/structure/api/establishments

{
  "items": [
    {
      "id": 2,
      "name": "<string>",
      "code": "<string>",
      "legalUnitId": 2,
      "legalUnit": {
        "id": 2,
        "name": "<string>",
        "code": "<string>",
        "legalIdentificationNumber": "<string>",
        "activityCode": "<string>",
        "countryId": "<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>"
}