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

# List Model Notes

`GET /api/v1/model-notes`

Retrieves a paginated list of notes associated with a model.
Note: Model variables, filter values, and notes can all be attached to different entity types via `model_type` and `model_id`.

## Query parameters

- `filter[user_id]` string
- `filter[my_notes]` string
- `filter[model_type]` string
- `filter[model_id]` string
- `include` string
- `sort` string
- `page` integer
- `per_page` integer

## Response `200`

Successful response

- ModelNotesListResponse
  - `data` ModelNotes[]
    - `id` integer — Unique identifier
    - `note` string
    - `private` string
    - `patchworks_only` string
    - `model_type` string
    - `model_id` integer
    - `colour` 'blue' | 'blue_inverted' | 'cyan' | 'cyan_inverted' | 'gray' | 'gray_inverted' | 'green' | 'green_inverted' | 'orange' | 'orange_inverted' | 'pink' | 'pink_inverted' | 'purple' | 'purple_inverted' | 'red' | 'red_inverted' | 'yellow' | 'yellow_inverted'
    - `created_at` string, date-time
    - `updated_at` string, date-time
    - `user_id` object
    - `flow_step` object
    - `user` object
  - `meta` PaginationMeta
    - `current_page` integer
    - `from` integer, nullable
    - `last_page` integer
    - `path` string
    - `per_page` integer
    - `to` integer, nullable
    - `total` integer
  - `links` PaginationLinks
    - `first` string, uri
    - `last` string, uri
    - `prev` string, uri, nullable
    - `next` string, uri, nullable

## Other responses

- `401` — Unauthenticated
- `403` — Unauthorized

---

[API](https://skmtc.net/wearepatchworks/apis/patchworks-core-api.md) · [All operations](https://skmtc.net/wearepatchworks/apis/patchworks-core-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/wearepatchworks/patchworks-core-api/revisions/89261af4dd80/schema)