OQL ยท Entities
Notes
OQL field reference for notes. Free-text notes attached to contacts, optionally linked to a deal.
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.
| Field | Type | F | S | A | G | Description |
|---|---|---|---|---|---|---|
id | ID | Y | โ | โ | โ | Note ID |
text | string | โ | โ | โ | โ | Note text (select only) |
contact_id | ID | Y | โ | โ | Y | Associated contact ID |
author | string | โ | โ | โ | โ | Author display name (select only) |
author_id | ID | Y | โ | โ | Y | Author user ID |
deal_id | ID | Y | โ | โ | Y | Linked deal ID (optional) |
date | date | Y | Y | โ | Y | Note date |
created_at | time | Y | Y | โ | Y | Record creation timestamp |
modified_at | time | Y | Y | โ | Y | Last modification timestamp |
Notes
textis select-only โ OQL has no full-text search over note bodies.authoris a display name and is select-only; filter and sort byauthor_idinstead.- Lookups:
contact(viacontact_id) anddeal(viadeal_id). Reference their fields inline ascontact.<field>ordeal.<field>inselect,where, andorder_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" }
}