List establishments

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

integer

required

Required range: x > 1

items.name

string

required

items.activityCode

string | null

In France, NAF code. Null otherwise.

items.address

object | null

items.author

object

items.calendarId

integer

Default holidays calendar for employees in this establishment.

items.code

string | null

items.createdAt

string

Timestamp of the moment this establishment was created.

items.isArchived

boolean

items.legalIdentificationNumber

string | null

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

items.legalUnit

object

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

string | null

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

string | null

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

Introduction

Files

Organization Structure API

Core HR API

Cleemy Expenses API

Timmi Absences API

Timmi Office API

Timmi Project API

Timmi Settings API

Timmi Timesheet API

Pagga Mealvouchers API

Pagga Remuneration API

Poplee Training API

List establishments

Query Parameters

Response