Skip to main content
Our APIs are designed for developers to seamlessly access SalesCaptain’s suite of tools, including lead capture, customer communication, analytics, and campaign automation.
Tip: Use this API documentation to explore, test, and integrate SalesCaptain features into your platform efficiently.
There are two primary ways to use our API:
  • OpenAPI Specification — for direct endpoint testing and integration.
  • MDX Components — for interactive documentation and embedded code examples.

​
Authentication

All API requests to SalesCaptain are authenticated using Bearer tokens.
To access our endpoints:
  1. Generate your API key from your SalesCaptain Developer Dashboard.
  2. Include the token in the header of every request as shown below.
"security": [
  {
    "bearerAuth": []
  }
]

​
Lead Management

Use the Lead API to create, fetch, and manage leads from any source — website forms, campaigns, or integrations.

​
Endpoints

  • GET /leads — Retrieve all leads
  • POST /leads — Create a new lead
  • GET /leads/{id} — Get lead details by ID
  • PATCH /leads/{id} — Update lead details
  • DELETE /leads/{id} — Delete a lead
Example response: 
{
  "id": "12345",
  "name": "John Doe",
  "email": "[email protected]",
  "status": "new",
  "source": "Website Form"
}
You can filter leads by date, status, or source using query parameters.