Retrieve list of all notes

Lists notes. A note belongs to one record: a contact, a deal, a deal task, a contact activity entry or an account, named by reltype and relid. Only notes the caller is allowed to see are returned. Notes on activity entries are always shown. Notes on contacts need permission to edit contacts (pg_subscriber_edit), notes on deals need deal access (pg_deal) and an account with Deals, notes on deal tasks need permission to see all deals (pg_deal_list_all), and notes on accounts need permission to edit accounts (pg_account_edit). Drafts are left out unless filters[is_draft] asks for them. Without orders, the order of the notes is not defined. There is no error response of its own: unknown filters are ignored. GET /contacts/{id}/notes lists the notes of one contact.

{
    "notes": [
        {
            "relid": "126",
            "reltype": "Activity",
            "userid": "1",
            "is_draft": "0",
            "cdate": "2022-05-26T08:58:34-05:00",
            "mdate": "2022-05-26T08:58:34-05:00",
            "note": "Oh, hi lisa",
            "links": {
                "activities": "https://:account.api-us1.com/api/3/notes/1/activities",
                "user": "https://:account.api-us1.com/api/3/notes/1/user",
                "mentions": "https://:account.api-us1.com/api/3/notes/1/mentions",
                "notes": "https://:account.api-us1.com/api/3/notes/1/notes",
                "owner": "https://:account.api-us1.com/api/3/notes/1/owner"
            },
            "id": "1",
            "user": "1",
            "owner": {
                "type": "activity",
                "id": "126"
            }
        },
        {
            "relid": "6",
            "reltype": "Deal",
            "userid": "1",
            "is_draft": "0",
            "cdate": "2023-08-18T11:09:38-05:00",
            "mdate": "2023-08-18T11:09:40-05:00",
            "note": "Here is a note",
            "links": {
                "activities": "https://:account.api-us1.com/api/3/notes/2/activities",
                "user": "https://:account.api-us1.com/api/3/notes/2/user",
                "mentions": ":account.api-us1.com/api/3/notes/2/mentions",
                "notes": ":account.api-us1.com/api/3/notes/2/notes",
                "owner": ":account.api-us1.com/api/3/notes/2/owner"
            },
            "id": "2",
            "user": "1",
            "owner": {
                "type": "deal",
                "id": "6"
            }
        }
    ],
    "meta": {
        "total": "2"
    }
}
Query Params
string
enum

Only notes on this kind of record. Exact match.

Allowed:
integer

Only notes on the record with this id. Send filters[reltype] too, because ids of different kinds of record overlap.

integer

Only notes on this contact. The same as filters[reltype]=Subscriber with filters[relid], and replaces both. When more than one of filters[account_id], filters[contact_id] and filters[deal_id] is sent, only the first in that order is used.

integer

Only notes on this deal. Works like filters[contact_id], with reltype Deal.

integer

Only notes on this account. Works like filters[contact_id], with reltype CustomerAccount.

string

Send with filters[account_id] to also return the notes on the account's contacts and deals, newest first. Sending the parameter at all switches to this mode, but the contact and deal notes are only added when its value is not empty or 0. In this mode drafts are included, and filters[is_draft], filters[reltype], filters[relid], filters[cdate] and orders are ignored; ids no longer picks notes but still caps how many are returned. Known defect: with filters[contact_id] or filters[deal_id] instead, it returns notes on any contact, deal or account whose id equals the given id.

integer
enum

0 for published notes, the default, or 1 for drafts. Send it twice as filters[is_draft][]=0&filters[is_draft][]=1 to get both.

Allowed:
string

Only notes created at exactly this date and time, written as YYYY-MM-DD HH:MM:SS. Comparison operators are not supported.

string

Sort by creation time: DESC for newest first; any other value sorts oldest first. orders[reltype] and orders[relid] sort the same way by those fields.

integer

Number of notes to return. Defaults to 20; values above 100 are treated as 100. 0 or a negative number returns every note and ignores offset.

integer

Number of notes to skip. Use with limit to page through the notes.

string

Comma-separated note IDs to return. When set, only those notes are returned; limit does not apply, but offset still does.

Response

Language
Credentials
Header
URL
LoadingLoading…
Response
Choose an example:
application/json