v1

latestOpenAPI 3.0.12026-07-22120163333.7 KB
Notes

List Notes

Returns all notes attached to the given lead.

Notes:

  • Caller must have access to the lead; otherwise 404 LEAD_NOT_EXIST.
  • By default only user-created notes are returned. Pass includeSystemNote=true to also include automated / system-generated notes.
  • Response order is not guaranteed.
get/v1.0/notes

Query parameters

leadIdinteger required

ID of the lead whose notes to return.

includeSystemNoteboolean

When true, include system-generated notes alongside user-created notes.

Headers

Authorizationstring required

Bearer [access_token]

Response

Notes for the lead (empty array when the lead has no notes).

Example response

{
  "notes": [
    {
      "id": 563172647619608,
      "noteId": 400000012345,
      "creatorId": 100234,
      "leadId": 100001,
      "createTime": "2026-04-22 10:15:30",
      "content": "Discussed Austin inventory, will send pre-approval doc tomorrow.",
      "lastUpdate": "2026-04-22 10:20:00",
      "lastEditorId": 100234,
      "creatorName": "Alice Johnson",
      "lastEditorName": "Alice Johnson"
    }
  ]
}