🔌 API Documentation

Powerful API

Build powerful integrations and applications with our comprehensive RESTful API. Access customer data, automate workflows, and create seamless experiences.

Quick Start

Get up and running with our API in minutes. Follow these simple steps to start building.

1. Get Your API Key

Generate your API key from your account settings dashboard.

2. Make Your First Request

Use our interactive examples to test the API endpoints.

3. Build & Deploy

Integrate the API into your applications and automate workflows.

Authentication

Secure your API requests with Bearer token authentication.

Bearer Token Authentication

All API requests require authentication using a Bearer token in the Authorization header.

Example Request:

Authorization: Bearer YOUR_API_KEY_HERE

API Key

Generate your API key from the dashboard under Settings → API Keys.

Get API Key

Rate Limits

Free tier: 1,000 requests/hour
Pro tier: 10,000 requests/hour
Enterprise: Custom limits

API Endpoints

Explore our comprehensive API endpoints for managing customers, deals, and more.

Customers

GET /api/customers

Retrieve a list of customers

GET

Example Response:

{
  "customers": [
    {
      "id": "cust_123",
      "name": "John Doe",
      "email": "john@example.com",
      "company": "Acme Corp",
      "created_at": "2024-01-15T10:30:00Z"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 150
  }
}

POST /api/customers

Create a new customer

POST

Request Body:

{
  "name": "Jane Smith",
  "email": "jane@example.com",
  "company": "Tech Solutions",
  "phone": "+1-555-0123"
}

PUT /api/customers/{id}

Update an existing customer

PUT

Request Body:

{
  "name": "Jane Smith Updated",
  "company": "Tech Solutions Inc"
}

Deals

GET /api/deals

Retrieve a list of deals

GET

Example Response:

{
  "deals": [
    {
      "id": "deal_456",
      "title": "Enterprise Software License",
      "value": 50000,
      "stage": "negotiation",
      "customer_id": "cust_123",
      "created_at": "2024-01-15T10:30:00Z"
    }
  ]
}

POST /api/deals

Create a new deal

POST

Request Body:

{
  "title": "New Software License",
  "value": 25000,
  "stage": "prospecting",
  "customer_id": "cust_123",
  "description": "Annual software license renewal"
}