Skip to main content

Authorization

Follow this guide to create a new Lattice credential that will allow Nexla to authenticate to and exchange data with your Lattice account.
lattice_api_auth.png

Lattice

Prerequisites​

Before creating a Lattice credential, you need to obtain an API Key from your Lattice admin dashboard. The API Key is required to authenticate with the Lattice API.

To obtain your API Key, sign in to your Lattice account with administrator permissions and navigate to the admin dashboard. In the admin dashboard, locate the API Settings or API Keys section where you can view and manage your API keys. You can generate a new API Key or use an existing one. If you're generating a new API Key, you may be asked to provide a name or description for the key to help identify it later. Copy the API Key immediately after generation, as it may not be displayed again for security reasons. Store the API Key securely, as you will need it to configure your Nexla credential.

The API Key is sent in the Authorization header with the Bearer prefix (e.g., Authorization: Bearer {api_key}) for all API requests to the Lattice API. The API Key authenticates your account and grants access to your Lattice data, including users, departments, feedback, goals, review cycles, and tags. For detailed information about API key setup, authentication, and available API endpoints, refer to the Lattice API reference and Lattice API authentication documentation.

Create a Lattice Credential​

  • To create a new Lattice credential, after selecting the data source/destination type, click the Add Credential tile to open the Add New Credential overlay.

New Credential Overlay – Lattice

LatticeCred.png

Credential Name & Description​

  1. Enter a name for the credential in the Credential Name field and a short, meaningful description in the Credential Description field.

    Resource descriptions are recommended but are not required. They should be used provide information about the resource purpose, data freshness, etc. that can help the owner and other users efficiently understand and utilize the resource.

API Key Authentication​

Lattice uses API Key authentication for all API requests. The API Key is sent in the Authorization header with the Bearer prefix to authenticate API requests to the Lattice API.

  1. Enter your Lattice API Key in the API Key field. This is the API Key you obtained from your Lattice admin dashboard. The API Key is sent in the Authorization header with the Bearer prefix (e.g., Authorization: Bearer {api_key}) for all API requests to the Lattice API. The API Key authenticates your account and determines what data and operations you can access based on your account permissions.

    Keep your API Key secure and do not share it publicly. The API Key provides access to your Lattice account data and should be treated as sensitive information. If your API Key is compromised, you should immediately regenerate it in your Lattice admin dashboard. You can view and manage API keys in your Lattice admin dashboard (API Settings or API Keys section). The API Key is sent in the Authorization: Bearer {api_key} header for all API requests to the Lattice API. The API Key does not expire automatically, but you can regenerate it at any time if needed. For detailed information about obtaining and managing API keys, API authentication, and available endpoints, see the Lattice API reference and Lattice API authentication documentation.

Save the Credential​

  1. Once all of the relevant steps in the above sections have been completed, click the Save button at the bottom of the overlay to save the configured credential.

  2. The newly added credential will now appear in a tile on the Authenticate screen during data source/destination creation and can be selected for use with a new data source or destination.