Skip to content

Quickstart
Platform
API Reference
Tutorials

Suggested

Quickstart Authenticate and make your first call
Authentication API keys and OAuth 2.1 — which to use
The data model The seven core entities and how they relate
API reference Every endpoint, from the OpenAPI spec
Webhook payloads The envelope and real sample events
Rate limits What throttling looks like, and backing off
Errors The response envelope and every status code
OQL Query the CRM in one request
MCP server Connect an AI agent to live CRM data
OAuth 2.1 Act on behalf of another user

Menu

Quickstart
Platform
API Reference
Tutorials

Getting Started

Overview
Authentication
Errors
Rate limits
Pagination
Sorting & time filters
Partial updates
Undo deletion

CRM Core

Contacts
Companies
Deals
Actions
Notes
Calls
Meetings
Attachments

Streams

Action Stream
- GET Get a list of contacts prioritized by their next action
Team Stream
- GET Get a list of contacts prioritized by their next action

Events & Webhooks

Web Hooks
Notifications

Search & Filtering

Filters
- GET Get the list of custom filters (for the logged API user's account)
- GET Get (and run) a specific custom filter

CRM Configuration

Statuses
Pipelines
- GET Get all pipelines (associated with the logged API user's account)
- GET Get a specific pipeline
Lead Sources
Relationship Types
Custom Fields
Company Fields
Deal Fields

Predefined Content

Predefined Actions
Predefined Action Groups
Predefined Items
Predefined Item Groups

Account & Reference

Bootstrap
- GET Get useful information about the logged API user's account
- POST Invalidate the current API key and return a new API key
Users
Countries
- GET Get the list of all compatible countries

API Reference — entity overview

Deal Fields

Extra, user-defined fields on deals. Configurable by admins.

Maintained by the OnePageCRM engineering team

Operations 5

GET Get the list of deal fields (for the logged API user's account) /deal_fields
POST Create a deal field /deal_fields
GET Get a specific deal field /deal_fields/{deal_field_id}
PUT Update a specific deal field /deal_fields/{deal_field_id}
DELETE Delete a specific deal field /deal_fields/{deal_field_id}

Build on the action-focused CRM. APIs, webhooks, OQL, MCP, integrations.

Build

API Reference
The data model
OQL
Webhooks
Extension points
OAuth 2.1
MCP

Resources

Build with AI
Blog
Support
Status
GitHub
OpenAPI spec

Company

Contributors
OnePageCRM
About
Contact
Careers

Legal

Terms
Privacy
Security

© 2026 OnePageCRM. All rights reserved.