Before you start
- You need an admin role to create API keys.
Steps
1
Go to API keys
In your Get2Dial workspace, go to Settings > API keys, then select New API key.
2
Name the key and set its scopes
Enter a Name. Optionally set a custom Rate limit (requests / minute) — leave it
blank to use your workspace’s default. Under Scopes, set each resource to No
access, Read, or Read & write — the same model used for
user roles. A key only reaches what it’s granted.
3
Copy the key
Copy the key immediately — it starts with
g2d_key_ and is shown in full exactly once.
Get2Dial stores only a hash of it; if you lose it, you have to create a new one.4
Send it on every request
Include it as a bearer token:
The same
Authorization: Bearer <token> header also accepts a session token from
POST /auth/login — useful for testing, but a workspace API key is the right credential for
a real integration since it’s independently scoped and doesn’t expire with a browser
session.Verify
A request with your key against
GET /api/v1/campaigns (or any endpoint your key’s
capabilities cover) returns 200 OK instead of 401 or 403.Common problems
- 401 Unauthorized. The key is missing, malformed, or revoked. Confirm the header is
exactly
Authorization: Bearer <your-api-key>. - 403 Forbidden on a specific endpoint. The key doesn’t have the capability that endpoint requires — edit the key and grant it.
- You lost the key. There’s no way to retrieve it again — revoke it and create a new one.