Skip to main content
The Octolane API lets you read and update CRM data from outbound tools, marketing platforms, custom scripts, and internal systems. Work with opportunities, accounts, contacts, notes, activities, pipelines, stages, and custom fields through JSON REST endpoints. Every plan includes API access and webhooks. Create a personal key in Settings → API keys. For machine-readable discovery, use the OpenAPI specification and API catalog. See Octolane for AI agents for MCP and documentation indexes.

Base URL

Authentication

Include your API key in every request as a header:
Use a personal API key created in Settings → API keys. Requests act as the workspace member who created the key and use that member’s current access. A key stops working if it is disabled or its creator leaves the workspace.

Core objects

The primary CRM records are:
Accounts and contacts are created automatically when you create an opportunity - you don’t need to create them separately unless you want to.

Key behaviors

Create or resolve. Account creation resolves existing domains and contact creation resolves existing emails. Opportunity duplicate rules are endpoint-specific and can return 409; inspect the operation schema before retrying a create request. Auto-creation. When you create an opportunity with a domain and email, Octolane automatically creates the associated account and contact for you. Multiple contacts per company. You can link multiple email contacts under one account. They’ll all be associated with the same company domain. Dates. Date formats are endpoint-specific. Opportunity close_date and next_action_date inputs accept Unix timestamps in seconds or milliseconds between 2000-01-01 and 2100-01-01 UTC. Activity created_at uses an ISO 8601 date-time and cannot be in the future. Search filters use ISO 8601 date or date-time strings, not Unix timestamps.

Rate limits

Read and search routes allow 300 requests per minute and 100,000 requests per 30-day window. A request that exceeds a route limit returns 429 Too Many Requests.

Error handling

If something goes wrong, you’ll get a clear error response: Error responses follow this format:

Endpoints

Create Opportunity

Create a deal with associated account and contacts in one call.

Create Account

Create a company record by domain.

Create Contact

Create a person record by email.

Create Note

Attach notes to accounts and contacts.

Interface coverage

The published OpenAPI schema defines the REST operations documented here. Do not infer REST endpoints from MCP tool names: tasks, knowledge, custom objects, and webhook configuration may not have corresponding operations in this schema. Every plan includes webhooks; contact support for event, payload, and delivery details that are not published here.

Need help?

Reach out at help@octolane.com for integration questions or operations not covered by the published schema.