Authentication
How to create an API key and authenticate requests to the Untangly Public API.
The Untangly Public API uses Bearer token authentication. Every request must include an API key that you generate inside the app.
Create an API key
- Sign in to your Untangly organization.
- Go to Settings → Organization → API Keys.
- Click Create Key, give it a descriptive name (e.g.
Zapier Integration), and optionally set an expiration date. - Copy the key — it is shown only once.
Store your API key securely. Treat it like a password — never commit it to source control or expose it in client-side code.
Make an authenticated request
Include the key in the Authorization header of every request:
GET /clients HTTP/1.1
Host: api.untangly.com
Authorization: Bearer mint_<your_api_key>Example with curl
curl https://api.untangly.com/clients \
-H "Authorization: Bearer mint_<your_api_key>"Example with JavaScript fetch
const response = await fetch("https://api.untangly.com/clients", {
headers: {
Authorization: "Bearer mint_<your_api_key>",
},
});
const data = await response.json();Key scoping
API keys are scoped to your organization. A key can only access data that belongs to the organization it was created in.
Revoking a key
To revoke a key, go to Settings → Organization → API Keys and click the trash icon next to the key. The key will stop working immediately.
Error responses
| Scenario | Status | Error message |
|---|---|---|
No Authorization header | 401 | Missing or invalid Authorization header |
| Key not found / expired | 401 | Invalid or expired API key |
| Key has no organization | 403 | API key is not associated with an organization |