Partner API (BETA)
Programmatic access to AutoElevate data for integration partners
Table of Contents
Overview
The AutoElevate Partner API enables integration partners — including MSPs, integration developers, and technology partners — to programmatically access AutoElevate data for their managed customers. It extends AutoElevate beyond the Web Admin Portal, supporting partner-built dashboards, reporting tools, compliance workflows, and third-party integrations.
Note: The Partner API is currently in Beta.
This article covers one thing: how to create an API key in the Web Admin Portal. For everything else — authentication, endpoints, versioning, rate limits, and the OpenAPI document — see the Partner API reference. The reference is generated directly from the API itself and is always up to date, so those details are documented there and only there.
User Types: Human and Service
The portal has two user types, chosen on the first step when creating a user:
- Human — a person who logs in and works in the portal
- Service — a non-person account that represents an integration or automation
API keys can be added to any user of either type — including Human users already in your system. You do not need a Service user to create an API key.
That said, for long-lived integrations we recommend a dedicated Service user rather than attaching the key to a person's account. All API activity is attributed to the user the key belongs to, so a Service user keeps your audit trail clean and means the integration isn't affected when an employee's account changes.
Creating a Service User (Recommended for Integrations)
- Navigate to the Users screen and click Add User
- On the first step, select Service as the user type
- Give the user a name that identifies the integration and complete the remaining steps
Click to Zoom (screenshot of the user type selection to be added)
Creating an API Key
- Log in to the Web Admin Portal at msp.autoelevate.com
- Navigate to the Users screen
- Select the user the key should belong to — the Service user you created above, or any existing user
- In the user's details, open the API Keys section and click Add API Key
- Configure the key:
- Name — a label that identifies the integration using the key
- Type — choose the authentication scheme (see the Partner API reference for how each scheme is used)
- Permissions — grant only what the integration needs. A key can never grant more than the user's own role allows; if the user's role changes later, key permissions no longer covered by the role are flagged in the UI
- Expiration — prefer the shortest expiration that works for your use case
- Click Generate and copy the key secret(s) immediately — they are shown once and cannot be retrieved again
Click to Zoom (screenshots of the Users screen and API Key dialog to be added)
Managing Existing Keys
- Each key shows when it was last used, so unused keys are easy to spot and remove
- Store key secrets in a secrets manager — never in source control, tickets, chat, or shared documents
- If a key is ever exposed, revoke it in the portal immediately and create a new one
- Review keys when personnel or roles change, and revoke keys that are no longer needed
Next Steps
With your key created, everything else lives in the Partner API reference: how to authenticate with your key type, available endpoints, versioning, rate limits, and a downloadable OpenAPI document for generating client libraries.