User synchronization via our API

If you use a different reference source than Lucca to manage your users, your own HR software for example, you can easily transmit all modifications that you have made in your software to Lucca thanks to our API REST.



Before jumping into a synchronization via the API, you must first verify a few technical details:


  • you must develop a stand-alone tool or one that is integrated into your software that is capable of producing HTTP requests through Lucca.
  • this tool must know how to interpret Lucca’s HTTP responses: 200 OK, 500 Error, etc.
  • this tool must be able to support the JSON exchange format
  • ideally, you should have a database associated with this tool which will allow you to track all exchanges with Lucca as well as permit you to resubmit failed synchronizations.



Lucca possesses an API that displays user lists as well as all of their associated data.

This API allows read-write access.

The exchanges are completed in JSON format.

With each modification/creation of a user in your software, you trigger a call through Lucca’s API to transmit the modification/creation.

By doing so, your system and Lucca are synchronized in real time.

If you are not able to trigger the update with each modification, you can develop a surveillance system that will detect the modifications made by your software at the frequency of your choice and that is consequently powered by Lucca’s API. In this case, and in order to avoid updating every user in Lucca every time, you must save verification history and only recover modifications carried out between two verifications.



The API of Lucca users is only available in write access to connected users who have sufficient permission to do so.

You must request an application key from us which will allow us to identify your software and authorize it to create/modify forms.

Every HTTP produced by your software can therefore be carried out with this application key.

Then, each user is updated via an HTTP request (POST or PUT depending on whether you would like to create or modify a user).

Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request