API Reference

Authentication

All API requests require a valid API key sent in the Authorization header:

Authorization: Bearer cm_live_your_api_key_here

Pagination

List endpoints return paginated results. Use page and per_page parameters.

{
  "data": [...],
  "meta": {
    "page": 1,
    "per_page": 25,
    "total": 100
  }
}

Error Codes

Errors return a consistent JSON structure:

{
  "error": {
    "code": "not_found",
    "message": "Deal not found"
  }
}

Deals

Manage sales deals and their commission calculations.

Comp Plans

Manage compensation plans and their configurations.

Users

Manage sales reps and team members.

Commissions

Aggregated commission data across your organization.

SPIFFs

Manage SPIFFs (Sales Performance Incentive Fund) and leaderboards.

Custom Deal Fields

Manage custom fields that can be added to deals for your organization.

Webhooks

Manage webhook subscriptions to receive real-time event notifications.

Webhook Events