This article will help Lattice customers learn how they can begin leveraging Lattice's public API. The API will allow users to retrieve data from Lattice and use that information in another application. This means that customers will be able to do more with their data than was previously possible. The API will allow you to request data regarding:
If you are a developer and are interested in learning more about the API you can check out the developer documentation here. This will give you or your team an introduction into the technical specification of the API including authentication, pagination, expanding objects and rate limits. It will also provide real-time documentation as to 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 please follow the documentation below to begin enabling 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?
How To Set Up The API
Ask for it to be turned on in your account
All customers can be given access to the API but it will not be turned on automatically in your account. The first step is to reach out to ask us it to be turned on. You can do so by reaching out to your customer success manager.
Creating your API keys
Once you have have had Lattice enable the feature in your account you will have a new section under Settings titled "API Keys". Make sure the person creating the keys is a super admin in your Lattice account. If someone with limited privileges creates the key then it will limit what information will be able to be retrieved. To create one simply click on the "Create new key" button on the top right hand side of the screen.
From here, you will want to select your permission type and indicate what this API is for. The permission types are as follows:
- Read-only permissions
- Read and write permissions (coming soon!)
Once everything looks good, click "Generate Key".
Once you create your API key it will be shown to you as a long stream of alphanumeric characters. Be sure to keep it safe and remember that this is the only time that this API key will be shown to you. After creating the key you will be shown a log of the key with only the last few characters of the string shown, the user that created the key (identified by their email) and when the key was created.
Sharing 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 be sure to make sure that the key is not hosted in any place that individuals other than Lattice admins and whoever is responsible for the build will have access to.
Revoking your API key
If the security of your key has been compromised you can revoke access of the key in the "API Keys" section of the admin dashboard. If you have created multiple you will want to identify which key you need to revoke using the characteristics provided (the ending of the character string, the email and/or the date) and click the "Revoke" button.
Once revoked the button will change to plain text and the key will no longer be able to retrieve information from Lattice
Using your API key
Once you have a key generated your developer(s) will be able to retrieve data from Lattice and test the results using the "Try It" button in the API developer page.
Questions? Feel free to reach out to our support team at [email protected]!