Skip to main content
The SalesCaptain API enables developers to seamlessly interact with core platform features including:
  • Company & account management
  • Contact and lead handling
  • Conversations and messaging
  • Custom field management
  • Communication channel profiles
Whether you’re building a SaaS platform, CRM integration, or automation workflow, our APIs provide a scalable and flexible solution.
Use this documentation to explore endpoints, test APIs, and integrate SalesCaptain features efficiently into your system.

​
How to Use This API

There are two primary ways to work with the SalesCaptain API:

​
1. OpenAPI Specification

  • Use for direct API integration
  • Supports tools like Postman, Swagger, and SDK generation

​
2. Interactive Documentation (MDX)

  • Embedded examples and UI-based testing
  • Ideal for frontend developers and quick testing

​
Authentication

All API requests require authentication using a Bearer Token.

​
Steps:

  1. Generate your API key from the SalesCaptain Dashboard:
    Sidebar → Settings → Your Profile → API Key
    You can copy your API key from there.
    Api Key
  2. Include the API key in every request header as a Bearer Token.

​
Example:

​
OpenAPI Security:

​
API Modules

The SalesCaptain API is organized into the following resources:

​
Companies

Manage company-level data.

​
Accounts

Access user accounts linked to companies.

​
Conversation Profiles

Represents communication channels (phone, email, etc.).

​
Conversations

Manage conversations between contacts and businesses.

​
Messages

Retrieve messages within conversations.

​
Contacts

Create, update, and manage contacts.

​
Custom Fields

Manage structured custom data for contacts.