Skip to main content
The Lucca API is now in its beta phase. Which means it is not feature complete, and susceptible to breaking changes. You can still use the Legacy APIs in the meantime.
Some endpoints may not be immediately available to you, as it requires opting in. This is the case for the leaves management objects, for example. In order to gain access to these features, please contact our support.
The Lucca API tries to conform to the constraints of the REST architectural style. Our API has predictable resource-oriented URLs, accepts JSON-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication schemes, and HTTP methods. To get started using the Lucca API:
1

Pick an environment

You can use the Lucca API either in a production, sandbox or demo environment. 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.

You may want to browse our guides, as one might shed light on how to achieve what you’re trying to do.
Please, bear in mind:
  • The Lucca API doesn’t support bulk updates. You can only change the state of a single resource per request.
  • This API is versioned. Version is set through the Api-Version HTTP header.
  • 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.