Skip to main content
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.
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 — 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 for the up-to-date status of each endpoint.
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.

Download the OpenAPI specification

The OpenAPI specification of the Lucca API is available for download. It can be used to generate client libraries, create API documentation, and more.

​
Getting started

1

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

Authenticate

Authentication is OAuth 2.0 based. Learn how to authenticate.
3

Send your HTTP requests following the API reference below.

​
Good to know

  • This API is versioned. 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.
  • 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. Make sure your script is ready for this.