Note: Only Nimble Account Administrators may generate API keys to access account data over the Nimble API.
API keys are an easier way to access your data inside of Nimble, as it's a simpler way to access as opposed to oAuth 2.0 that is used for our public API. This gives you full access to the public Nimble API, but only for your Nimble account. This saves you the hassle of having to store, save, and refresh oAuth tokens.
Follow the guide at https://nimble.readthedocs.io to see how to interact with your Nimble data over our API. with two important changes:
When sending your request, send the API request to https://app.nimble.com instead of https://api.nimble.com
The only form of accepted authentication is through HTTP header. Your API request must have Authorization header with value like this: Bearer API-KEY.
Generate an API Token
The option to generate a new API token can be found in your Settings >> API Token. Select "Generate New Token" then describe your token. When you are ready, select "Generate".
You will be provided with an API token and the option to set the Token Name and Scopes.
Please note, that API access must be granted by the admin of your Nimble account. Admins can grant API access on the Settings >> Users page.
Python example
import requests
apikey = "YOUR_API_KEY"
result = requests.get("https://app.nimble.com/api/v1/myself", headers={"Authorization": "Bearer " + apikey})
print(result.json())
cURL example
curl -H "Authorization: Bearer YOUR_API_KEY" https://app.nimble.com/api/v1/myself
If you have any questions, please write us at care@nimble.com, initiate a chat from this FAQ, or join one of our Nimble Onboarding and Best Practices sessions, held every weekday at 9 AM PT.