GET
/
lucca-api
/
business-establishments
curl --request GET \
  --url https://{account}-{sandboxName}.sandbox.{server}.luccasoftware.com/lucca-api/business-establishments \
  --header 'Api-Version: <api-version>' \
  --header 'Authorization: Bearer <token>'
{
  "type": "business-establishments",
  "url": "https://example.ilucca.net/lucca-api/business-establishments?page=32q5dsf465sdfet21&limit=10",
  "totalCount": 11,
  "items": [
    {
      "id": "5",
      "type": "business-establishment",
      "url": "https://example.ilucca.net/lucca-api/business-establishments/5",
      "name": "Lucca Marseille",
      "remoteId": "00004",
      "legalEntity": {
        "id": "123",
        "type": "legal-entity",
        "url": "https://example.ilucca.net/lucca-api/legal-entities/123"
      },
      "taxIdentificationNumber": {
        "format": "frenchSIRET",
        "value": "0000000000000"
      },
      "address": {
        "addressLines": [
          "Lucca",
          "10 Place de la Joliette",
          "Les Docks Atrium 10.2"
        ],
        "postalCode": "13002",
        "locality": "Marseille",
        "administrativeArea": "Bouches-du-Rhône",
        "countryCode": "FRA"
      },
      "timezoneId": "Europe/Paris",
      "holidaysCalendar": {
        "id": "45",
        "type": "holidays-calendar",
        "url": "https://example.ilucca.net/lucca-api/holidays-calendars/45"
      },
      "isArchived": false,
      "lastArchivedAt": null,
      "createdAt": "2024-05-23T13:45:26.0001Z",
      "lastUpdatedAt": "2024-05-23T13:45:26.0001Z"
    }
  ],
  "embedded": {
    "legal-entity": {
      "123": {
        "id": "123",
        "type": "legal-entity",
        "url": "https://example.ilucca.net/lucca-api/legal-entities/123",
        "legalName": "Lucca S.A.S.",
        "remoteId": "LE:83.2938",
        "countryCode": "FRA",
        "currencyCode": "EUR",
        "taxIdentificationNumber": {
          "format": "frenchSIREN",
          "value": "44163769100128"
        },
        "industryCode": {
          "format": "frenchAPE",
          "value": "7022Z"
        },
        "createdAt": "2024-01-01T08:34:23.0001Z",
        "lastUpdatedAt": "2024-01-01T08:34:23.0001Z",
        "lastArchivedAt": "null",
        "links": {
          "businessEstablishments": {
            "href": "https://example.ilucca.net/lucca-api/business-establishments?legalEntity.id=123"
          }
        }
      }
    }
  },
  "links": {
    "prev": null,
    "next": {
      "href": "https://example.ilucca.net/lucca-api/{resource-type}?page=!sdk87Sdh&limit=25"
    }
  }
}

Authorizations

​
Authorization
string
header
required

The Lucca API implements the oAuth 2 protocol with the client-credentials-flow. Refer to RFC8725.

Headers

​
Api-Version
enum<string>
required

Set the API version.

Available options:
2024-11-01
Example:

"2024-11-01"

​
If-None-Match
string

Only execute the request if current cached version of the resource does not match the one given here.

Example:

"W/q5sd4w2x1c1gfdg"

​
If-Match
string

Only execute the request if current cached version of the resource matches the one given here. Useful to avoid concurrency conflicts.

Example:

"W/q5sd4w2x1c1gfdg"

​
Accept-Encoding
string

List of compression algorithms you support.

Query Parameters

​
include
enum<string>[]

Include metadata:

  • embedded: the partial or complete representations of related resources (e.g. the employee the resource belongs to).
  • links: links to related resources or actions (e.g. approving a leave-request). May be null when you do not have access to the resource (or action).
  • totalCount: only applicable on collections (i.e. lists of resources), gives the total number of items across all pages.

Read more about expanding responses.

Available options:
embedded,
links,
totalCount
​
legalEntity.id
string[]

Only return business-establishments belonging to one of the given legal-entity id.

Example:
["1", "3"]
​
isArchived
boolean

When omitted: return both archived and non-archived resources. When true: only return archived resources. When false: only return non-archived resources.

​
page
string

Cursor of the page to retrieve. Read more about pagination.

​
limit
integer
default:25

Number of items per page. Defaults to 25. Maximum is 100. Read more about pagination.

Required range: 0 <= x <= 100

Response

200
application/json
OK

A collection of business-establishment resources.

​
type
string
required
Allowed value: "business-establishments"
​
url
string
required
​
items
object[]
required

A business-establishment is a geographically localized unit of the organization structure. It belongs to a legal-entity. A legal-entity may have one (and only one) business-establishment set as its headquarters.

Business-establishments are an essential resource of the enterprise model, as they are the fundamental units of access rights scoping. As such, most objects are either directly or indirectly attached to a business-establishment.

Employees are attached to a business-establishment through their job-position.

​
totalCount
integer | null

Total number of business-establishment resources across all pages that satisfy query parameters.

Required range: x >= 0
​
embedded
object | null
​
links
object | null

Links to related resources

Was this page helpful?