GET
/
lucca-api
/
legal-entities
/
{id}
curl --request GET \
  --url https://{host}/lucca-api/legal-entities/{id} \
  --header 'Api-Version: <api-version>' \
  --header 'Authorization: Bearer <token>'
{
  "id": "123",
  "type": "legal-entity",
  "url": "https://example.ilucca.net/lucca-api/legal-entities/123",
  "legalName": "Lucca S.A.S.",
  "remoteId": "LE:83.2938",
  "isArchived": false,
  "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"
    }
  },
  "embedded": null
}

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
Examples:

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

Examples:

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

Examples:

"W/q5sd4w2x1c1gfdg"

​
Accept-Encoding
string

List of compression algorithms you support.

Path Parameters

​
id
string
required

Unique id of the legal-entity.

Minimum length: 1

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.

Response

200
application/json

Representation of the requested legal-entity.

Representation of a legal entity, i.e. an organization that is subject to legal responsibilities in a given jurisdiction (country).

A legal-entity may be comprised of several business-establishments which represent geographically localized structures where the actual work is done. One of which is marked as the legal-entity headquarters. Embedded resources on a legal-entity(s) response. A legal-entity resource.