Skip to main content
Use this page as the entry point before working through the Leadsforge API endpoint reference.

Base URL

Authentication

Create an API key in the Leadsforge app under Settings -> API & MCP, and send it as is in the Authorization header of every request, without a Bearer prefix.
A key acts for the workspace member who created it, spends your account’s credits, and stops working when that member is removed from the workspace. A Leadsforge key works only with Leadsforge API, not with Salesforge API. See Authentication and Security best practices.

Request conventions

  • JSON bodies. Send request bodies as JSON with Content-Type: application/json. A body field the endpoint does not know is rejected with 400, so a misspelled filter fails instead of being ignored.
  • Paging. Search pages with a cursor. Lookalike company search pages with page and pageSize. Job lists and job results page with offset and limit.
  • Jobs. Long-running operations return 202 Accepted with a job you follow until it ends. See Asynchronous jobs.
  • Retries. Job start requests and lookalike search accept an Idempotency-Key header, so a retried request does not start or charge twice.
  • Errors. Failed requests return a JSON body with a stable code, except the few cases listed in Errors.

Endpoint groups

The reference states for each endpoint whether it is free or paid, whether it is synchronous or a job, and what input it requires.