An introduction to Lattice's public API
This article will help admins learn how to leverage Lattice's public API. The API will allow admins and developers to retrieve data from Lattice and use that information in another application.
The API will allow you to request data regarding:
- Users
- Competencies
- Feedback
- Goals
- Questions
- Tasks
- Reviews
- Updates
If you are a developer and are interested in learning more about the API, read developer documentation. This will introduce you or your team to the API's technical specifications, including authentication, pagination, expanding objects, and rate limits. It will also provide real-time documentation about what endpoints and fields will be available from the above sections.
If you are a Lattice admin and are curious about how to begin setting up the API, follow the steps below to enable this feature.
Not a customer, but want to learn more about the API? Schedule a demo!
Initial questions to consider when approaching the API
- What do you intend to use the API for?
- Do you have a timeline for the project?
- Have you identified someone (or a team) that would be responsible for the build?
Create an API key
- Navigate to Admin > Organization > Settings > API keys.
- Click Generate API key.
- After the key is generated, click Copy.
Note: The generated API key will only be shown to you in full once, so be sure to copy it before closing the window.
After creating the key, you will be shown a log of the key with only the last few characters of the key shown, the user that created the key (identified by their email), and when the key was created.
Share your API key
Once you have created an API key, you will want to share it with whoever will be responsible for your build. You will need to do so safely and securely and ensure that the key is not hosted in any place where individuals other than Lattice admins and whoever is responsible for the build will have access.
Revoke your API key
- Navigate to Admin > Organization > Settings > API keys.
- Next to the API key you would like to revoke, click the red Revoke option.
Once revoked, the button will change to plain text, and the key will no longer be able to retrieve information from Lattice.
Note: If the user who generated the API key has left the company and is no longer active in Lattice, requests made against this key will be rejected. An admin must generate a new one and apply it where the existing key is currently being used.
Use your API key
Once a key is generated, your developer(s) can retrieve data from Lattice and test the results using the Try It button on the API developer page.