Skip to main content
All requests to the Starleads API must include a valid API key in the X-Api-Key header.
API keys are secrets shared only between you and Starleads. Never expose them in client-side code, public repositories, or share them with anyone.

​
Get your API key

Log in to Starleads

Go to app.starleads.co and sign in to your account.

Open API Access

In the sidebar, navigate to Configuration → API Access.
API Access menu

Navigate to Configuration → API Access in the sidebar.

Copy your API key

Copy the API key displayed on the page. You’ll need it for every request.

​
Using your API key

Include the X-Api-Key header in every request:

​
What an API key grants access to

An API key now grants access to your company’s billing data. Any holder of the key can read your current credit balance, your consumption breakdown, your subscription contract (plan, status, active features and effective limits), and your credit ledger history.
Billing endpoints are authenticated with the same X-Api-Key header as every other endpoint. There is no separate credential and no second scope for billing: whoever can call GET /Campaign can also call GET /Consumption, GET /Consumption/breakdown, GET /Subscription and GET /Consumption/transactions. If you distributed an API key before billing was placed behind it — for example to an integration partner, a script, or a third-party service — that key now exposes financial information it did not expose at the time you shared it. We recommend you audit and review where your keys are used, and rotate any key whose exposure is broader than you are comfortable with.
No pricing details (rates, discounts, Stripe identifiers) are ever exposed through the API. What a key can read is your consumption, your remaining balance, and the terms of your contract — see the Track Consumption guide.
You’re all set! Head over to the API Reference to explore the available endpoints.