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

# List notes

`GET /v1/notes`

Retrieve a list of notes in the workspace.

## Query parameters

- `limit` integer
- `cursor` string
- `entity.id` string
- `query` string
- `createdAfter` string, date-time
- `createdBefore` string, date-time

## Response `200`

A paginated list of notes in the workspace.

- object
  - `data` object, required
    - `items` Note[], required
      - `id` string, required
      - `entity` object, required
        - `id` string, required — The ID of the entity connected to the note.
        - `entityType` 'person' | 'company' | 'object', required — The type of the entity connected to the note. Can be `person`, `company` or `object`.
        - `fullName` string, required — The full name of the entity connected to the note.
      - `content` string, required — The content of the note. Can be in plain text or in markdown format.
      - `visibility` 'public' | 'private', required — The visibility of the note. - `public`: The note is visible to all users in the workspace. - `private`: The note is visible only to the current user.
      - `author` union, required
        - object
          - `type` 'user', required — The type of the author of the note, it can be a user or a folk assistant.
          - `id` string, required — The ID of the author of the note.
          - `fullName` string, required — The full name of the author of the note.
          - `email` string, email, required — The email of the author of the note.
          - `deleted` false, required — Whether the author has been deleted and does not exist anymore.
        - object
          - `type` 'assistant', required — The type of the author of the note, it can be a user or a folk assistant.
          - `fullName` string, required — The name of the folk assistant that created the note.
        - object
          - `type` 'user', required — The type of the author of the note, it can be a user or a folk assistant.
          - `id` string, required
          - `deleted` true, required — Whether the author has been deleted and does not exist anymore.
      - `createdAt` string, nullable, required — The date and time the note was created, in ISO format.
      - `parentNote` union, required — The parent note, if this note is a reply to another note.
        - object
          - `id` string, required
          - `deleted` true, required — Whether the parent note has been deleted and does not exist anymore.
        - object
          - `id` string, required
          - `entity` object, required
            - `id` string, required — The ID of the entity connected to the note.
            - `entityType` 'person' | 'company' | 'object', required — The type of the entity connected to the note. Can be `person`, `company` or `object`.
            - `fullName` string, required — The full name of the entity connected to the note.
          - `content` string, nullable, required — The content of the parent note. If the parent note is not visible to the current user, this field will be null.
          - `visibility` 'public' | 'private', required — The visibility of the note. - `public`: The note is visible to all users in the workspace. - `private`: The note is visible only to the current user.
          - `author` union, required
            - object
              - …
            - object
              - …
            - object
              - …
          - `createdAt` string, nullable, required — The date and time the parent note was created, in ISO format.
          - `deleted` false, required — Whether the parent note has been deleted and does not exist anymore.
    - `pagination` object, required
      - `nextLink` string
  - `deprecations` string[]

## Other responses

- `400` — The request was unacceptable, often due to missing an invalid parameter.
- `401` — No valid API key provided.
- `403` — The API key doesn’t have permissions to perform the request.
- `404` — The requested resource doesn’t exist.
- `422` — The request was unacceptable, often due to missing or invalid parameters.
- `429` — Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.
- `500` — Something went wrong on our end.
- `503` — The server is overloaded or down for maintenance.

---

[API](https://skmtc.dev/folk/apis/folk-external-api.md) · [All operations](https://skmtc.dev/folk/apis/folk-external-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/folk/folk-external-api/revisions/8ecbf0ccd00a/schema)