OnePageCRM developers
  • Quickstart
  • Platform
    • 🗂️ The data model
    • 🔍 OQL
    • 📡 Webhooks
    • 🧩 Extension points
    • 🔐 OAuth 2.1 Request access
    • 🤖 MCP
  • 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

      • 🗂️ The data model
      • 🔍 OQL
      • 📡 Webhooks
      • 🧩 Extension points
      • 🔐 OAuth 2.1 Request access
      • 🤖 MCP
    • API Reference
    • Tutorials

    Getting Started

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

    CRM Core

    • Contacts
      • GET Get a list of contacts
      • POST Create a contact
      • GET Get a specific contact
      • PUT Update a specific contact
      • DELETE Delete a specific contact
      • POST Add a contact photo
      • PUT Update a contact's photo
      • DELETE Remove a contact's photo
      • GET Show contacts that meet the criteria of a filter
      • DELETE Delete multiple contacts
      • POST Save a specific OnePageCRM contact to Google Contacts
      • GET Get all actions for a specific contact
      • POST Create an action for a specific contact
      • GET Get all deals for a specific contact
      • POST Create a deal for a specific contact
      • GET Get all notes for a specific contact
      • POST Create a note for a specific contact
      • GET Get all calls for a specific contact
      • POST Create a call for a specific contact
      • GET Get all meetings for a specific contact
      • POST Create a meeting for a specific contact
      • GET Get all relationships for a specific contact
      • POST Create a relationships for a specific contact
      • GET Get a specific relationship
      • PUT Update a specific relationship
      • DELETE Delete a relationship
      • PUT Assign a tag to a specific contact
      • PUT Remove a tag from a specific contact
      • PUT Change the status of a specific contact
      • PUT Change the owner of a specific contact
      • PUT Apply a star to a specific contact
      • PUT Remove star from a specific contact
      • PUT Close the sales cycle for a specific contact
      • PUT Force close the sales cycle for a specific contact
      • PUT Reopen the sales cycle for a specific contact
      • PUT Split a contact from their current company (and potentially to a new company)
      • GET Get a list of attachments pinned to this contact
      • GET Get contacts past the 10,000 contact in the account
      • GET Get contacts past the 10,000 contact in the account.
    • Companies
      • GET Get a list of companies
      • GET Get a specific company
      • PUT Update a specific company
      • GET Get actions associated with a specific company
      • GET Get deals associated with a specific company
      • GET Get notes associated with a specific company
      • GET Get calls associated with a specific company
      • GET Get meetings associated with a specific company
      • GET Get contacts linked with a specific company
      • POST Link a contact to a specific company
      • DELETE Unlink a contact from a company
      • POST Enable company status sync
      • DELETE Disable company status sync
      • GET Get the list of attachments pinned to this company
      • PATCH Update the company logo
      • DELETE Delete the company logo
    • Deals
      • GET Get a list of deals
      • POST Create a deal
      • GET Get a specific deal
      • PUT Update a specific deal
      • DELETE Delete a specific deal
      • POST Create attachment and assign it to an existing deal
    • Actions
      • GET Get a list of actions
      • POST Create an action
      • GET Get a specific action
      • PUT Update a specific action
      • DELETE Delete a specific action
      • PUT Unassign a specific action (from the currently assigned user)
      • PUT Mark a specific action as complete
      • PUT Undo action completion
      • PUT Specify action to be promoted as the logged API users next action
      • PUT Undo action promotion
      • PUT Specify action to be swapped in as the logged API users next action
    • Notes
      • GET Get a list of notes
      • POST Create a note
      • GET Get a specific note
      • PUT Update a specific note
      • DELETE Delete a specific note
      • POST Create attachment and assign it to an existing note
    • Calls
      • GET Get a list of calls
      • POST Create a call
      • GET Get a specific call
      • PUT Update a specific call
      • DELETE Delete a specific call
      • POST Create attachment and assign it to an existing call
      • GET Get the list of call results (for the logged API user's account)
    • Meetings
      • GET Get a list of meetings
      • POST Create a meeting
      • GET Get a specific meeting
      • PUT Update a specific meeting
      • DELETE Delete a specific meeting
      • POST Create attachment and assign it to an existing meeting
    • Attachments
      • GET Get a pre-authorized S3 upload form (use to upload a file on the client side)
      • POST Create a new attachment
      • PATCH Sets/updates attachment custom file name
      • DELETE Delete a specific attachment
      • PATCH Pin attachment to its owner contact through its note/call/deal
      • PATCH Unpin attachment from its owner contact through its note/call/deal

    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
      • GET Get all webhooks (associated with the logged API user's account)
      • GET Get a specific webhook
      • DELETE Delete a specific webhook
    • Notifications
      • GET Get a list of notifications that user has
      • GET Get serialised notification by ID
      • POST Marks given notification as read
      • POST Marks all users' notifications as read

    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
      • GET Get the list of statuses (for the logged API user's account)
      • POST Create a new status
      • GET Get a specific status
      • PUT Update a specific status
      • DELETE Delete a specific status
    • Pipelines
      • GET Get all pipelines (associated with the logged API user's account)
      • GET Get a specific pipeline
    • Lead Sources
      • GET Get the list of lead sources (for the logged API user's account)
      • POST Create a new lead source
      • GET Get a specific lead source
      • PUT Update a specific lead source
      • DELETE Delete a specific lead source
    • Relationship Types
      • GET Get a list of relationship types
      • POST Create a new relationship type
      • GET Get a specific relationship type
      • PUT Update a specific relationship type
      • DELETE Delete a relationship type
    • Custom Fields
      • GET Get the list of custom fields (for the logged API user's account)
      • POST Create a new custom field
      • GET Get a specific custom field
      • PUT Update a specific custom field
      • DELETE Delete a specific custom field
    • Company Fields
      • GET Get the list of company fields (for the logged API user's account)
      • POST Create a new company field
      • GET Get a specific company field
      • PUT Update a specific company field
      • DELETE Delete a specific company field
    • Deal Fields
      • GET Get the list of deal fields (for the logged API user's account)
      • POST Create a deal field
      • GET Get a specific deal field
      • PUT Update a specific deal field
      • DELETE Delete a specific deal field

    Predefined Content

    • Predefined Actions
      • GET Get the list of predefined actions (for the logged API user's account)
      • POST Create a new predefined action
      • GET Get a specific predefined action
      • PUT Update a specific predefined action
      • DELETE Delete a specific predefined action
    • Predefined Action Groups
      • GET Get the list of predefined action groups (for the logged API user's account)
      • POST Create a new predefined action group
      • GET Get a specific predefined action group
      • PUT Update a specific predefined action group
      • DELETE Delete a specific predefined action group
    • Predefined Items
      • GET Get the list of predefined items (for the logged API user's account)
      • POST Create a new predefined item
      • GET Get a specific predefined item
      • PUT Update a specific predefined item
      • DELETE Delete a specific predefined item
    • Predefined Item Groups
      • GET Get the list of predefined item groups (for the logged API user's account)
      • POST Create a new predefined item group
      • GET Get a specific predefined item group
      • DELETE Delete a specific predefined item group

    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
      • GET Get the list of users (for the logged API user's account)
      • GET Get a specific user
      • PUT Update a specific user
    • Countries
      • GET Get the list of all compatible countries

    API Reference — entity overview

    Predefined Item Groups

    Groups of predefined deal items that are sold together or complement one another.

    Operations 4

    • GET Get the list of predefined item groups (for the logged API user's account) /predefined_item_groups
    • POST Create a new predefined item group /predefined_item_groups
    • GET Get a specific predefined item group /predefined_item_groups/{predefined_item_group_id}
    • DELETE Delete a specific predefined item group /predefined_item_groups/{predefined_item_group_id}
    OnePageCRM

    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.

    onepagecrm.com