GET
/
lucca-api
/
legal-entities
curl --request GET \
  --url https://{host}/lucca-api/legal-entities \
  --header 'Api-Version: <api-version>' \
  --header 'Authorization: Bearer <token>'
{
  "type": "legal-entities",
  "url": "https://example.ilucca.net/lucca-api/legal-entities?page=2qs1dqsd45&limit=1",
  "totalCount": 11,
  "items": [
    {
      "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,
  "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
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.

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.

​
countryCode
enum<string>[]

Filter out legal-entities on the country they belong to.

Maximum length: 100
Examples:
["FRA", "DEU", "ESP"]
​
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

Collection of legal-entity objects. Embedded resources on a legal-entity(s) response. Links on a collection. A collection of legal-entity resources.