List legal-entities
Returns a paginated list of legal-entities.
Access
Access
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"10"2024-11-01"
Query Parameters
Filter out legal-entities on the country they belong to.
100Three letters ISO 3166-1 alpha-3 country code. Lucca uses restcountries.com to map these codes to the country names displayed in the UI.
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 3Cursor of the page to retrieve: links.next.cursor or links.prev.cursor of a previous response, which is also the page value of their href.
Cursors are opaque: don't build or modify them. An invalid cursor gets a 400 Bad Request.
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). Includes the download links of the files the resource references, underlinks.files.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
Collection of legal-entity objects.