Read & search

Read access to your Octolane CRM. Each object (Accounts, Contacts, Opportunities) 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

https://api.octolane.com/v1

Authentication

Every request must include the API key in the x-api-key header.

x-api-key: your-api-key

Find your API key in Settings → Integrations → API.

Endpoints

Object	List	Search
Accounts	`GET /v1/accounts`	`POST /v1/accounts/search`
Contacts	`GET /v1/contacts`	`POST /v1/contacts/search`
Opportunities	`GET /v1/opportunities`	`POST /v1/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 a fields parameter to return only the fields you need. Pass a comma-separated string (for GET) or a JSON array (for POST).

GET  /v1/accounts?fields=id,name,domain,custom_fields
POST /v1/accounts/search   { "fields": ["id", "name", "domain", "custom_fields"] }

Custom fields

Every response includes a custom_fields object on each record and a top-level custom_field_definitions object describing those fields.

{
  "custom_fields": {
    "customer_tier": "enterprise",
    "renewal_date": "2026-06-01T00:00:00.000Z"
  },
  "custom_field_definitions": {
    "customer_tier": {
      "current_name": "Customer Tier",
      "property_name": "select_530",
      "attribute_type": "select",
      "metadata": { "select_options": [] }
    }
  }
}

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.

Introduction Filters

Getting started

Accounts

Contacts

Opportunities

Notes & activities

Pipelines

Bulk update

CRM

Base URL

Authentication

Endpoints

Shared concepts

Filters

Cursor pagination

Field selection

Custom fields

Need help?

​Base URL

​Authentication

​Endpoints

​Shared concepts

Filters

Cursor pagination

​Field selection

​Custom fields

​Need help?

Base URL

Authentication

Endpoints

Shared concepts

Field selection

Custom fields

Need help?