Skip to content

OQL · Entities

Notes

OQL field reference for notes. Free-text notes attached to contacts, optionally linked to a deal.

Maintained by the OnePageCRM engineering team · Last updated Jul 16, 2026

Notes are free-text notes attached to contacts. They can optionally be linked to a deal.

Fields

Legend: F filterable, S sortable, A aggregatable, G groupable.

FieldTypeFSAGDescription
idIDYNote ID
textstringNote text (select only)
contact_idIDYYAssociated contact ID
authorstringAuthor display name (select only)
author_idIDYYAuthor user ID
deal_idIDYYLinked deal ID (optional)
datedateYYYNote date
created_attimeYYYRecord creation timestamp
modified_attimeYYYLast modification timestamp

Notes

  • text is select-only — OQL has no full-text search over note bodies.
  • author is a display name and is select-only; filter and sort by author_id instead.
  • Lookups: contact (via contact_id) and deal (via deal_id). Reference their fields inline as contact.<field> or deal.<field> in select, where, and order_by. See Concepts › Lookups.

Example queries

Most recent 25 notes I wrote:

{
  "from": "notes",
  "where": { "author_id": "ME()" },
  "order_by": [{ "created_at": "desc" }],
  "limit": 25
}

All notes on a specific contact:

{
  "from": "notes",
  "where": { "contact_id": "507f1f77bcf86cd799439011" },
  "order_by": [{ "date": "desc" }]
}

Notes tied to a specific deal:

{
  "from": "notes",
  "where": { "deal_id": "507f1f77bcf86cd799439011" }
}