---
title: "candidate.listNotes"
method: POST
path: "/candidate.listNotes"
tags: ["Candidate"]
---

# candidate.listNotes

`POST /candidate.listNotes`

Lists the notes that have been added to a candidate.

**Requires the [`candidatesRead`](authentication#permissions-candidatelistnotes) permission.**

## Request body

- CandidateListNotesRequest
  - `candidateId` string, uuid, required — The id of the candidate to fetch notes for
  - `cursor` string, nullable — Opaque cursor indicating which page of results to fetch
  - `syncToken` string, nullable — An opaque token representing the last time the data was successfully synced from the API. A new, updated one is returned after successfully fetching the last page of data.
  - `limit` number, nullable — The maximum number of items to return. The maximum and default value is 100.

## Response `200`

Responses from the candidate.listNotes endpoint

- union
  - CandidateListNotesSuccessResponse
    - `success` true, required
    - `results` Note[], required
      - `id` string, uuid, required — The unique identifier for the note
      - `createdAt` string, required — The timestamp when the note was created
      - `isPrivate` boolean, required — Whether the note is private
      - `content` string, nullable — The note's content as plain text
      - `author` Author, required
        - `id` string, uuid, required — The unique identifier for the user
        - `firstName` string, required — The user's first name
        - `lastName` string, required — The user's last name
        - `email` string, nullable — The user's email address
    - `nextCursor` string — Cursor for the next page of results, if available
    - `moreDataAvailable` boolean — Whether more data is available beyond this page
    - `syncToken` string — Sync token to use for future incremental syncs. Only present on the last page.
  - ErrorResponse
    - `success` false, required
    - `errors` ErrorDetail[], required
      - `message` string, required
      - `parameter` string

---

[API](https://skmtc.net/ashbyhq/apis/ashby-api.md) · [All operations](https://skmtc.net/ashbyhq/apis/ashby-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/ashbyhq/ashby-api/revisions/778b919dc743/schema)