---
title: "List Notes"
method: GET
path: "/v1.0/notes"
tags: ["Notes"]
---

# List Notes

`GET /v1.0/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.

## Query parameters

- `leadId` integer, required
- `includeSystemNote` boolean

## Headers

- `Authorization` string, required

## Response `200`

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

- NoteListResponse — Wrapped response for GET /v1.0/notes. Note entries are returned under the 'notes' key.
  - `notes` NoteResponse[] — Notes attached to the lead.
    - `id` integer — Timeline ID that carries this note.
    - `noteId` integer — Note ID. Use this value with GET/PUT/DELETE /v1.0/notes/{noteId}.
    - `creatorId` integer — User ID of the note's creator.
    - `leadId` integer — ID of the lead this note belongs to.
    - `createTime` string — Creation time, formatted as 'yyyy-MM-dd HH:mm:ss' in UTC.
    - `deleteFlag` boolean — Whether the note has been deleted.
    - `content` string — Note content.
    - `lastUpdate` string — Last-modified time, formatted as 'yyyy-MM-dd HH:mm:ss' in UTC.
    - `lastEditorId` integer — User ID of the most recent editor.
    - `creatorName` string — Display name of the note's creator.
    - `lastEditorName` string — Display name of the most recent editor.
    - `isPin` boolean — Whether this note is pinned to the top of the lead's timeline.
    - `systemNote` boolean — Whether this is a system-generated note (e.g. automated activity). System notes are included only when includeSystemNote=true on the list endpoint.

## Other responses

- `401` — Missing or invalid authentication token.
- `404` — Lead does not exist, is trashed, or is not accessible to the caller (20006 LEAD_NOT_EXIST).
- `500` — Internal server error.

---

[API](https://skmtc.net/lofty/apis/lofty-service-open-apis.md) · [All operations](https://skmtc.net/lofty/apis/lofty-service-open-apis/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/lofty/lofty-service-open-apis/revisions/23e640467118/schema)