Skip to main content
The v2 API provides read access to accounts, contacts, and opportunities. Each object has two endpoints:
  • 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 the x-api-key header.
Requests use the current access of the workspace member who created the personal API key.

Endpoints

The /v1 list and search endpoints remain available as compatibility routes and return the same v2 response shape.

Rate limits

The v2 read and search endpoints allow 300 requests per minute and 100,000 requests per 30-day window.

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 a fields 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 a custom_fields object on each record and a top-level custom_field_definitions object describing those fields.
The keys in custom_field_definitions match the keys in custom_fields, so clients can resolve slug/value mappings dynamically.

Need help?

Email one@octolane.com. We ship custom endpoints when teams need something specific.