API Reference

Base URL

Production API requests use this base URL. Demo or staging keys should be paired with their matching environment URL.

https://app.getcommish.io/api/v1

Authentication

All API requests require a valid API key sent in the Authorization header. Raw keys are checked by hash server-side:

Authorization: Bearer YOUR_API_KEY

Scopes and Admin Actions

Admin endpoints are intentionally sensitive. Confirm who owns approvals, key rotation, and production cutover before enabling admin-scoped keys.

Pagination

List endpoints return paginated results. Use page and per_page parameters, keep per_page at or below 100, and continue until the returned page is empty or your expected total is reached.

{
  "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"
  }
}

Rate Limits and Webhook Notes

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 admin-scoped webhook subscriptions with HTTPS endpoint validation, local/private target blocking, active/inactive status, and per-subscription secrets.

Webhook Events

Webhook management supports admin-scoped subscriptions, HTTPS endpoint validation, local/private target blocking, active/inactive toggles, and per-subscription secrets. Confirm delivery retries and idempotency expectations for your implementation before depending on event workflows.