Lucca | Obtaining your API key

This article provides guidance on creating an API key to link your Lucca account to Oyster.

Prerequisites

• You have Admin access to your company's account.
• You are logged in to the Oyster Platform with your admin credentials.
• You are logged in to Lucca as an Administrator.

Steps to create the API key

Login to Lucca's platform. Copy and save the base URL of your Lucca instance. You will need to enter this information later in Oyster's platform.  In this example, the base URL is oyster-2025-10-10.ilucca-demo.net
On the right top corner, click on your profile's icon.
Click Settings.
Click API keys.
Click Generate a new API key.
Enter the name of your API key. Check the following permissions: Consult leaves Consult / create / modify users
Scroll down and enter your e-mail address under Technical contact. Under API key usage, check Third-party publisher. In the text field, enter Merge as the name of the third-party publisher. Click Generate a new API key.
Your API key has been successfully created! It will appear on the API Keys page.  Click on the icon next to the API key to copy it. Make sure to save this somewhere safe, as you will need it later.

Steps to configure API permissions

Click Role administration next to the API key you have created.
Under the Coworkers tab, add the following permissions in addition to the pre-existing set of default permissions: See future employees See former employees Consult HR files, and select All items under Section.  View employee jobs View employee managers View employee qualifications Click Save.
Go to Connecting to Oyster to complete the remaining steps in the Oyster platform.