Getting Started
Authentication
Learn how to authenticate with the LeadX API.
Every request to the LeadX API must include your API key in the header. Without it, your requests will be rejected with a 401 Unauthorized error.
X-API-KEY: YOUR_API_KEYDocumentation access
Protected documentation uses your LeadX account. Click Continue with LeadX. If you are already signed in to the LeadX platform, the documentation signs you in automatically. Otherwise, LeadX asks you to sign in before returning you to the page you requested.
LeadX displays only the API references enabled for your organization and user. Documentation login never accepts an API key. Your API key remains a credential for API requests only.
The documentation session is linked to your exact LeadX platform session. Your platform bearer token never leaves the LeadX platform. Logging out, suspending the account, expiring organization access, or changing an entitlement affects the next protected documentation request. The documentation session expires after three days at most.
If you use LeadX only through the API and do not have login credentials, ask your organization administrator or LeadX support to enable your existing LeadX account. You do not need a separate documentation identity.
Using your API key
Include the X-API-KEY header with every request:
curl -X POST "https://api.leadx.com/v1/companies" \
-H "X-API-KEY: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"url": "company.com"}'import requests
response = requests.post(
"https://api.leadx.com/v1/companies",
headers={"X-API-KEY": "YOUR_API_KEY"},
json={"url": "company.com"},
)
print(response.json())const response = await fetch("https://api.leadx.com/v1/companies", {
method: "POST",
headers: {
"X-API-KEY": "YOUR_API_KEY",
"Content-Type": "application/json",
},
body: JSON.stringify({ url: "company.com" }),
});
console.log(await response.json());Keep your API key secure. Treat it like a password — never commit it to a public repository or share it with unauthorized parties. Anyone with your key can make API calls on your account.
Test in your browser
You can also use your API key with the interactive playground on every endpoint page to:
-
Run API calls directly from your browser
-
Experiment with different endpoints and parameters
-
View live JSON responses
The playground clears the key as soon as you send the request. It does not save the key in your documentation session or browser storage.