Introduction

The Salesly API is organized around REST. It accepts JSON request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.

https://rest.salesly.app/api/v1/developers/

Resources

Manage your principal Salesly modules through the API:

Quick Start

1. Get your API key — go to Salesly → Settings → Integrations
2. Make your first request — see the Getting Started guide
3. Explore endpoints — browse the API Reference in the sidebar

Key Features

• RESTful design — predictable URLs and standard HTTP methods
• Idempotency — safely retry requests with Idempotency-Key header
• Pagination — offset-based pagination on all list endpoints
• Rate limiting — 120 req/min (read), 30 req/min (write) per API key
• Request tracing — every response includes X-Request-ID for debugging

Response Envelope

All successful responses wrap data in a data key:

{
  "data": {
    "id": 1,
    "name": "ACME Corp",
    "created_at": "2026-03-05T10:30:00+00:00"
  }
}

{
  "data": [
    { "id": 1, "name": "ACME Corp" },
    { "id": 2, "name": "Globex Inc" }
  ],
  "pagination": {
    "total": 42,
    "per_page": 15,
    "current_page": 1,
    "last_page": 3,
    "has_more": true
  }
}

Health Check

GET /health

Verify the API is operational:

{
  "status": "ok"
}