- A simple list endpoint (
GET) with basic text search and cursor pagination. - A search endpoint (
POST) with full filtering, sorting, field selection, and cursor pagination.
Base URL
Authentication
Every request must include the API key in theX-API-Key header.
Endpoints
| Object | List | Search |
|---|---|---|
| Accounts | GET /accounts | POST /accounts/search |
| Contacts | GET /contacts | POST /contacts/search |
| Opportunities | GET /opportunities | POST /opportunities/search |
Shared concepts
Filters
Operator reference and aliases used in every
POST .../search endpoint.Cursor pagination
How to paginate
GET and POST endpoints safely.Field selection
Every list and search endpoint accepts afields parameter to return only the fields you need. Pass a comma-separated string (for GET) or a JSON array (for POST).
Custom fields
Every response includes acustom_fields object on each record and a top-level custom_field_definitions object describing those fields.
custom_field_definitions match the keys in custom_fields, so clients can resolve slug/value mappings dynamically.