> ## Documentation Index
> Fetch the complete documentation index at: https://developers.luccasoftware.com/llms.txt
> Use this file to discover all available pages before exploring further.

# The Lucca API

> The reference of the `2024-11-01` version of the Lucca API.

The Lucca API is our unified public API. It provides a **stable, versioned contract** you can rely on to integrate
your tools — HRIS, ERP, internal applications — with the Lucca platform.

The API conforms to REST conventions: predictable resource-oriented URLs, JSON-encoded request and response bodies,
standard HTTP methods, response codes, and OAuth 2.0 authentication.

<Info>
  A few endpoints are still marked with a **BETA** badge in the reference below. These are newer endpoints
  where we are still finalizing the feature set. Once promoted to stable, they become subject to our
  [versioning and deprecation policy](/documentation/using-api/versioning#deprecation-policy) — meaning no
  breaking changes without advance notice and a migration path. Any new version released is supported for
  at least one year.

  Check the [lifecycle recap](/api-reference/latest/lifecycle) for the up-to-date status of each endpoint.
</Info>

<Tip>
  Some endpoints may not be immediately available to you, as it requires opting in. In order to gain access to these features, please contact our support.
</Tip>

<Card title="Download the OpenAPI specification" icon="file-arrow-down" href="/openapi-specs/lucca-api@2024-11-01.json" arrow="true" cta="Download">
  The OpenAPI specification of the Lucca API is available for download. It can be used to generate client libraries, create API documentation, and more.
</Card>

***

## Getting started

<Steps>
  <Step title="Pick an environment">
    You can use the Lucca API either in any environment. (production, sandbox, demo, etc.)
    You should first test out your integration on a sandbox, then deploy it in production.
    [Learn about environments](/documentation/get-started/environments).
  </Step>

  <Step title="Authenticate">
    Authentication is OAuth 2.0 based. [Learn how to authenticate](/documentation/using-api/authentication).
  </Step>

  <Step title="Send your HTTP requests following the API reference below." />
</Steps>

## Good to know

* [This API is versioned](../../documentation/using-api/versioning). Version is set through the `Api-Version` HTTP header.
* The Lucca API doesn't support bulk updates. You can only change the state of a single resource per request.
* Better many small requests than a few large ones. The Lucca API is [rate and size limited](../../documentation/limits).
* If you plan to issue HTTP requests for multiple customer accounts: each one has its own API URL (subdomain) and access token.
* All collection endpoints enforce [pagination](../../documentation/using-api/paging). Make sure your script is ready for this.