Get started with the Nimblr API
What partners can do with the Nimblr API, how to create a key and where to find the reference.
The Nimblr API lets partners automate work they would otherwise do in the Admin Portal and pull Nimblr data into their own tools. This guide covers what the API is for, how to get a key and where the full reference lives. The reference itself lists every endpoint, so this guide doesn't repeat it.
What you can do with the API
- Report on your customers. Pull awareness, course and simulation results into Power BI or another reporting tool, on your own schedule.
- Finish organization setup. Configure group content settings and organization security settings, such as requiring Microsoft sign-in, and remove administrator accounts.
- Connect directories. Set up and manage a customer's Microsoft Entra ID, Google Workspace or SFTP connection: connection type, credentials, sync settings and mapping directory groups to Nimblr groups.
API access is included in your Nimblr account. It is not a paid add-on.
Create an API key
- Sign in to the Admin Portal and open the partner view.
- Go to API and click Create API Key.
- Copy the key and store it somewhere safe, such as a password manager or your secrets store.
Warning: Treat the key like a password. Anyone who has it can read and change data for the organizations it can access. Don't paste it into emails, tickets or code repositories. If a key may have been exposed, contact support so it can be revoked.
Make your first request
Send the key in the x-api-key header of every request, and ask for JSON:
x-api-key: YOUR-API-KEY
Accept: application/json
Replace YOUR-API-KEY with your key.
Find the full reference
The API page in the Admin Portal links to the interactive documentation, where you can see every endpoint, its parameters and responses, and try requests in your browser. You can also open it directly at nimblr.net/api/v3/documentation.
Good to know
- Keys are created per account, so each key only reaches the data that account can access.
- The reference is updated by our developers whenever the API changes, so always check it for the current endpoints.
Tip: Not sure whether the API covers what you need? Contact your Channel Sales Executive or Customer Success before you start building.
Owner: Filip Cronvall · Last reviewed: pending · Review cycle: 12 months · Applies to: Partners, Nimblr API