Getting Started

Base URL

All API requests are made to:

https://www.salesos.org/api

Quick Start

1. Get Your API Key

Navigate to Settings > API Keys in your SalesOS dashboard and create a new API key.

2. Make Your First Request

curl -X GET https://www.salesos.org/api/leads \
  -H "Authorization: Bearer YOUR_JWT_TOKEN" \
  -H "Content-Type: application/json"

3. Example Response

[
  {
    "id": "lead_abc123",
    "firstName": "Jane",
    "lastName": "Smith",
    "email": "[email protected]",
    "status": "NEW",
    "createdAt": "2025-01-15T10:30:00Z"
  }
]

Authentication

SalesOS supports two authentication methods:

See Authentication for full details.

Request Format

• All request bodies must be JSON with Content-Type: application/json
• Query parameters use standard URL encoding
• IDs are UUID strings
• Dates are ISO 8601 format (2025-01-15T10:30:00Z)

Response Format

All responses return JSON. Successful responses return the resource directly:

{
  "id": "abc123",
  "name": "Acme Corp",
  "createdAt": "2025-01-15T10:30:00Z"
}

Error responses follow a consistent format:

{
  "statusCode": 400,
  "message": "Validation failed",
  "errors": [
    { "field": "email", "message": "must be a valid email" }
  ]
}

Rate Limiting

The API enforces rate limits to ensure fair usage. See Rate Limiting for details.

Next Steps

• Authentication - Detailed auth guide
• Error Handling - Status codes and error format
• Pagination - Paginating list endpoints
• Webhooks - Real-time event notifications
• API Reference - Full endpoint documentation