Organization
BETAEmployee Records
BETAEvents & Webhooks
BETAcurl --request GET \
--url https://{host}/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?limit=25",
"totalCount": 28,
"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": "franceSIRET",
"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",
"isArchived": false,
"lastArchivedAt": null,
"createdAt": "2024-05-23T13:45:26.0001Z",
"lastUpdatedAt": "2024-05-23T13:45:26.0001Z"
}
],
"links": {
"prev": null,
"next": {
"href": "https://example.ilucca.net/lucca-api/business-establishments?page=!sdk87Sdh&limit=25"
}
},
"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": "franceSIREN",
"value": "44163769100128"
},
"industryCode": {
"format": "franceAPE",
"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"
}
}
}
}
}
}List business-establishments
List business-establishments.
curl --request GET \
--url https://{host}/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?limit=25",
"totalCount": 28,
"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": "franceSIRET",
"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",
"isArchived": false,
"lastArchivedAt": null,
"createdAt": "2024-05-23T13:45:26.0001Z",
"lastUpdatedAt": "2024-05-23T13:45:26.0001Z"
}
],
"links": {
"prev": null,
"next": {
"href": "https://example.ilucca.net/lucca-api/business-establishments?page=!sdk87Sdh&limit=25"
}
},
"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": "franceSIREN",
"value": "44163769100128"
},
"industryCode": {
"format": "franceAPE",
"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"
}
}
}
}
}
}Security: OAuth 2.0
Security: OAuth 2.0
business-establishments.readonly
business-establishments.readwrite
Authorizations
The Lucca API implements the oAuth 2 protocol with the client-credentials-flow. Refer to RFC8725.
Headers
Set the API version.
2024-11-01 "2024-11-01"10Only execute the request if current cached version of the resource does not match the one given here.
Only execute the request if current cached version of the resource matches the one given here. Useful to avoid concurrency conflicts.
List of compression algorithms you support.
Query Parameters
Only return business-establishments belonging to one of the given legal-entity id.
1["1", "3"]
Filter business-establishments by their name and/or remoteId. The search is case insensitive and looks for partial matches.
1When omitted: return both archived and non-archived resources.
When true: only return archived resources.
When false: only return non-archived resources.
Cursor of the page to retrieve. Read more about pagination.
Number of items per page. Defaults to 25. Maximum is 100. Read more about pagination.
0 <= x <= 100Include 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 benullwhen 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.
embedded, links, totalCount Response
OK
A collection of business-establishment resources.
"business-establishments"100Show child attributes
Show child attributes
11"business-establishment"The third-party API ID of the matching object.
If this business-establishment is archived. Only possible if there are no more employees attached.
Reference to the legal-entity this business-establishment belongs to.
True when this business-establishment should be considered the headquarters of the legal-entity it belongs to. A legal-entity may only have a single one headquarters.
- France: SIRET (Système d'identification du répertoire des établissements). Must start with the same identifier than its legal-entity (SIREN).
The industry (classification) code identifies the main type of activity of this legal-entity.
- France: APE or NAF code.
- Spain: CNAE.
- Germany: WZ (Die Klassifikation der Wirtschaftszweige).
- U.S.A.: NAICS (North American Industry Classification System).
Representation of a postal address.
Show child attributes
Show child attributes
Unstructured ordered address lines describing the lower levels of an address.
11Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (e.g. city validation).
Optional. Generally refers to the city/town portion of the address. Examples: French city, IT comune, UK post town.
Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture.
Three letters ISO 3166-1 alpha-3 country code.
FRA, ESP, DEU, CHE, ITA, GBR, USA, BEL, CAN, AFG, ALA, ALB, DZA, ASM, AND, AGO, AIA, ATA, ATG, ARG, ARM, ABW, AUS, AUT, AZE, BHS, BHR, BGD, BRB, BLR, BLZ, BEN, BMU, BTN, BOL, BIH, BWA, BVT, BRA, VGB, IOT, BRN, BGR, BFA, BDI, KHM, CMR, CPV, CYM, CAF, TCD, CHL, CHN, HKG, MAC, CXR, CCK, COL, COM, COG, COD, COK, CRI, CIV, HRV, CUB, CYP, CZE, DNK, DJI, DMA, DOM, ECU, EGY, SLV, GNQ, ERI, EST, ETH, FLK, FRO, FJI, FIN, GUF, PYF, ATF, GAB, GMB, GEO, GHA, GIB, GRC, GRL, GRD, GLP, GUM, GTM, GGY, GIN, GNB, GUY, HTI, HMD, VAT, HND, HUN, ISL, IND, IDN, IRN, IRQ, IRL, IMN, ISR, JAM, JPN, JEY, JOR, KAZ, KEN, KIR, PRK, KOR, KWT, KGZ, LAO, LVA, LBN, LSO, LBR, LBY, LIE, LTU, LUX, MKD, MDG, MWI, MYS, MDV, MLI, MLT, MHL, MTQ, MRT, MUS, MYT, MEX, FSM, MDA, MCO, MNG, MNE, MSR, MAR, MOZ, MMR, NAM, NRU, NPL, NLD, NCL, NZL, NIC, NER, NGA, NIU, NFK, MNP, NOR, OMN, PAK, PLW, PSE, PAN, PNG, PRY, PER, PHL, PCN, POL, PRT, PRI, QAT, REU, ROU, RUS, RWA, BLM, SHN, KNA, LCA, MAF, SXM, SPM, VCT, WSM, SMR, STP, SAU, SEN, SRB, SYC, SLE, SGP, SVK, SVN, SLB, SOM, ZAF, SGS, SSD, LKA, SDN, SUR, SJM, SWZ, SWE, SYR, TWN, TJK, TZA, THA, TLS, TGO, TKL, TON, TTO, TUN, TUR, TKM, TCA, TUV, UGA, UKR, ARE, UMI, URY, UZB, VUT, VEN, VNM, VIR, WLF, ESH, YEM, ZMB, ZWE 3"FRA"
{
"addressLines": ["10 Place de la Joliette", "Atrium 10.2"],
"postalCode": "13002",
"locality": "Marseille",
"administrativeArea": "Bouches-du-Rhône",
"countryCode": "FRA"
}
IANA timezone identifier this business-establishment belongs to.
"Europe/Paris"
Read-only. UTC timestamp of the moment this object was last archived through its isArchived property.
Read-only. UTC timestamp of the moment this object was created.
Read-only. UTC timestamp of the moment this object was last updated. Set upon creation, update or deletion of the object.
Total number of business-establishment resources across all pages that satisfy query parameters.
x >= 0Show child attributes
Show child attributes
Dictionary of legal-entities indexed by ID.
Show child attributes
Show child attributes
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.
Show child attributes
Show child attributes
Must be unique. Legal name of the legal-entity.
1 - 255Three letters ISO 3166-1 alpha-3 country code.
FRA, ESP, DEU, CHE, ITA, GBR, USA, BEL, CAN, AFG, ALA, ALB, DZA, ASM, AND, AGO, AIA, ATA, ATG, ARG, ARM, ABW, AUS, AUT, AZE, BHS, BHR, BGD, BRB, BLR, BLZ, BEN, BMU, BTN, BOL, BIH, BWA, BVT, BRA, VGB, IOT, BRN, BGR, BFA, BDI, KHM, CMR, CPV, CYM, CAF, TCD, CHL, CHN, HKG, MAC, CXR, CCK, COL, COM, COG, COD, COK, CRI, CIV, HRV, CUB, CYP, CZE, DNK, DJI, DMA, DOM, ECU, EGY, SLV, GNQ, ERI, EST, ETH, FLK, FRO, FJI, FIN, GUF, PYF, ATF, GAB, GMB, GEO, GHA, GIB, GRC, GRL, GRD, GLP, GUM, GTM, GGY, GIN, GNB, GUY, HTI, HMD, VAT, HND, HUN, ISL, IND, IDN, IRN, IRQ, IRL, IMN, ISR, JAM, JPN, JEY, JOR, KAZ, KEN, KIR, PRK, KOR, KWT, KGZ, LAO, LVA, LBN, LSO, LBR, LBY, LIE, LTU, LUX, MKD, MDG, MWI, MYS, MDV, MLI, MLT, MHL, MTQ, MRT, MUS, MYT, MEX, FSM, MDA, MCO, MNG, MNE, MSR, MAR, MOZ, MMR, NAM, NRU, NPL, NLD, NCL, NZL, NIC, NER, NGA, NIU, NFK, MNP, NOR, OMN, PAK, PLW, PSE, PAN, PNG, PRY, PER, PHL, PCN, POL, PRT, PRI, QAT, REU, ROU, RUS, RWA, BLM, SHN, KNA, LCA, MAF, SXM, SPM, VCT, WSM, SMR, STP, SAU, SEN, SRB, SYC, SLE, SGP, SVK, SVN, SLB, SOM, ZAF, SGS, SSD, LKA, SDN, SUR, SJM, SWZ, SWE, SYR, TWN, TJK, TZA, THA, TLS, TGO, TKL, TON, TTO, TUN, TUR, TKM, TCA, TUV, UGA, UKR, ARE, UMI, URY, UZB, VUT, VEN, VNM, VIR, WLF, ESH, YEM, ZMB, ZWE 3ISO-4217 currency code
EUR, CHF, GBP, USD, CAD, JPY, BBD, XAF, AUD, PLN, STN, NOK, XBA, XBB, ADP, GWP, ITL, IEP, ILR, LUC, LUL, ROL, RUR, VEF, ZWN, DKK, PEN, XCD, XSU, TND, VUV, PEI, PLZ, ESA, BOB, KPW, MGA, OMR, RWF, SLL, SGD, XPF, RON, ZAL, ESP, VEB, VNC, BTN, CNY, SVC, HKD, LSL, MUR, ZAR, NZD, XAU, HRK, LAJ, BGN, GEL, KES, MNT, SHP, UAH, YUD, DJF, GTQ, ANG, BUK, FRF, MXP, NLG, UGW, YUN, BHD, CLF, ERN, GYD, PAB, XOF, XTS, ARP, LTT, MZM, PTE, CSD, ZMK, BZD, FKP, MXV, SBD, CHW, TWD, TTD, TRY, UYU, BEC, BEL, GRD, IDR, ZRZ, BYN, ISK, LRD, ARA, DDM, GHC, SDP, UAK, BSD, LAK, MDL, MZN, SSP, UYI, BYR, CSJ, GWE, LUF, HTG, KRW, QAR, NIC, SIT, SDG, CHC, AOA, PHP, WST, BAD, BRN, BRR, CYP, GNS, LTL, MTP, UYN, DZD, AWG, KYD, SYP, TZS, FIM, MVQ, SUR, USS, ZRN, KHR, CRC, INR, NIO, LKR, SRD, UYW, XAG, DEM, XFU, CVE, CLP, CDF, CUC, CHE, XBD, ALK, BGK, EEK, GEK, LVR, TRL, AZN, CZK, UGX, USN, XPT, BRB, BGL, LSM, PEH, UYP, XRE, BMD, BOV, BWP, BIF, DOP, KZT, RSD, ZMW, BEF, BRC, CSK, GQE, GHP, ISJ, LVL, TPE, UGS, XFO, MVR, PGK, AED, UZS, AYM, BOP, BGJ, SKK, AFN, KMF, GMD, IRR, ILS, KGS, NPR, SAR, VES, XXX, HRD, ROK, ALL, GNF, JOD, MWK, SEK, XPD, BRE, ECV, STD, TMM, CUP, MAD, NGN, AFA, ECS, PES, COU, KWD, LBP, ATS, BYB, ZWD, AMD, GIP, MKD, MYR, MXN, RUB, THB, TOP, TMT, ARY, XEU, ARS, ETB, XDR, IQD, XUA, NAD, PKR, TJS, YER, ZWL, AOK, RHD, YUM, BND, GHS, SOS, ZWR, BAM, COP, HUF, JMD, LYD, XBC, MLF, SDD, ZWC, EGP, SZL, MOP, MMK, VND, AON, MTL, MRO, MZE, SRG, YDD, BDT, BRL, FJD, HNL, MRU, PYG, SCR, AOR, AZM, GNE, ILP, MGF, ESB, TJR 1"legal-entity"The third-party API ID of the matching object.
1 - 50If this legal-entity is archived. Only possible if there are no more business-establishment attached.
Identifier of the legal-entity in its local jurisdiction.
- France: SIREN (Système d'identification du répertoire des entreprises)
- Germany: SN (Steuernummer).
- Spain: N.I.F (Número de Identificación Fiscal)
The industry (classification) code identifies the main type of activity of this legal-entity.
- France: APE or NAF code.
- Spain: CNAE.
- Germany: WZ (Die Klassifikation der Wirtschaftszweige).
- U.S.A.: NAICS (North American Industry Classification System).
Read-only. UTC timestamp of the moment this object was created.
Read-only. UTC timestamp of the moment this object was last updated. Set upon creation, update or deletion of the object.
Read-only. UTC timestamp of the moment this object was last archived through its isArchived property.
{
"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": "franceSIREN",
"value": "44163769100128"
},
"industryCode": { "format": "franceAPE", "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 to related resources
Show child attributes
Show child attributes
Was this page helpful?