API Documentation Overview

Build powerful integrations with the SalesOS REST API.

https://api.salesos.com/v1

All requests require an API key:

curl -X GET "https://api.salesos.com/v1/leads" \
  -H "X-API-Key: sos_your_api_key"

Go to Settings → API Keys

Click "Generate New Key"

Name your key (e.g., "Production")

Copy and store securely

All responses are JSON:

{
  "success": true,
  "data": { ... },
  "meta": {
    "page": 1,
    "total": 100
  }
}

Errors include helpful messages:

{
  "success": false,
  "error": {
    "code": "INVALID_REQUEST",
    "message": "Email is required"
  }
}

Visit API Docs for complete documentation.