Pagination

The full contract is in Developers → Requests.

Query parameters

Parameter	Default	Description
`page`	`1`	Page number (1-based)
`limit`	`50`	Items per page (capped at 200)
`sortBy`	endpoint default	A field the endpoint allows sorting on
`sortOrder`	endpoint default	`asc` or `desc`

curl "https://api.salesos.org/v1/leads?page=2&limit=25&sortBy=createdAt&sortOrder=desc" \
  -H "X-API-Key: $SALESOS_API_KEY"

A sortBy outside the endpoint's allow-list falls back to the default order instead of failing.

Response format

{
  "data": [
    { "id": "clx8k2…", "firstName": "Alice", "lastName": "Johnson", "createdAt": "2026-01-15T10:30:00.000Z" }
  ],
  "page": 2,
  "limit": 25,
  "total": 150,
  "totalPages": 6,
  "hasMore": true
}

Walk a collection by incrementing page until hasMore is false.

Filtering

Each endpoint documents its own filters in the API reference. Leads, contacts, accounts, opportunities and tasks also share search, owner=me, open=true, createdAfter and ids:

GET /v1/leads?status=QUALIFIED&owner=me&limit=20
GET /v1/opportunities?open=true&sortBy=amount&sortOrder=desc
GET /v1/contacts?search=jane&limit=10

Filters only narrow what you can already see.

Large volumes

To export or load thousands of records, use the Bulk API instead of paging through the REST endpoints.

Query parameters

Response format

Filtering

Large volumes

On this page