Skip to main content
DeltaLead uses API key authentication to protect every endpoint. Every request you make to https://platform-api.deltalead.ai/v1 must include your API key in the X-API-Key header — without it, the request is rejected immediately before any processing occurs. There are no cookies, sessions, or OAuth flows for server-to-server API access; a valid key in the header is all you need.

Getting your API key

1

Open API Keys settings

In the DeltaLead dashboard, click your account name in the top-right corner, then go to Settings → API Keys.
2

Generate a new key

Click Generate New Key. Give the key a descriptive label (for example, production-crm-sync or dev-testing) so you can identify it later.
3

Copy and store the key securely

Copy the key immediately after it appears on screen and store it in a secure secret manager (such as AWS Secrets Manager, HashiCorp Vault, or your platform’s equivalent). You will not be able to view the full key again after closing this dialog.
Your API key is displayed only once at the moment of creation. If you navigate away or close the dialog without copying it, you must revoke the key and generate a new one. Never store API keys in source code, .env files committed to version control, or plain-text documents.

Using your API key

Pass your API key in the X-API-Key header on every request. The example below retrieves your leads list:
Replace YOUR_API_KEY with the key you copied from the dashboard. The header name is case-insensitive, but X-API-Key is the canonical form used throughout this documentation. Here is the same request using a popular HTTP client library:

Error responses

If authentication fails, the API returns one of two HTTP error codes. A 401 response body looks like this:
A 403 response body looks like this:
Create a separate API key for each environment (development, staging, production) and for each integration or service that calls the API. This limits the blast radius if a key is ever compromised — you revoke only the affected key without disrupting other services. Rotate keys on a regular schedule by generating a new key, updating your secret manager, confirming traffic flows correctly, and then revoking the old key.

Next steps

Now that your API key is set up and working, explore the full set of available endpoints in the API Reference — including leads management, campaign triggers, agent configuration, and webhook subscriptions.