API Reference

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.

Base URL

https://api.octolane.com/v1

Authentication

Include your API key in every request as a header:

x-api-key: your-api-key

Use a personal API key created from your Octolane workspace settings. 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:

Object	What it does
Opportunity	A deal or potential deal in your pipeline
Account	A company, identified by domain (e.g., `acme.com`)
Contact	A person, identified by email
Note	A text note attached to accounts and/or contacts

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

No duplicates. Accounts and contacts are automatically deduplicated. Creating the same account or contact twice returns the existing record instead of creating a duplicate. 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:

Status Code	What it means
`400`	Bad request - check your input fields
`401`	Invalid or missing API key
`404`	Resource not found (e.g., wrong `pipeline_id`)
`409`	A matching opportunity already exists
`422`	The request is valid JSON but contains rejected values
`429`	Too many requests - slow down and retry
`500`	Something went wrong on our end - contact support

Error responses follow this format:

{
  "success": false,
  "statusCode": 400,
  "message": "Validation error",
  "errors": {
    "pipeline_id": "Pipeline id must be a valid uuid"
  }
}

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.

Need help?

Reach out at one@octolane.com - we’re happy to ship custom endpoints if you need something specific.

Getting started

Accounts

Contacts

Opportunities

Notes & activities

Pipelines

Record operations

Record history

Base URL

Authentication

Core objects

Key behaviors

Rate limits

Error handling

Endpoints

Create Opportunity

Create Account

Create Contact

Create Note

Need help?

​Base URL

​Authentication

​Core objects

​Key behaviors

​Rate limits

​Error handling

​Endpoints

Create Opportunity

Create Account

Create Contact

Create Note

​Need help?

Base URL

Authentication

Core objects

Key behaviors

Rate limits

Error handling

Endpoints

Need help?