---
title: "Get the history of progress updates for a note"
method: GET
path: "/v1/notes/{noteId}/progress/history"
tags: ["Notes"]
---

# Get the history of progress updates for a note

`GET /v1/notes/{noteId}/progress/history`

Retrieves the history of progress updates made against a note (required scope notes:read)

## Path parameters

- `noteId` integer, required

## Query parameters

- `sortBy` 'progressedAt' — Represents the fields that can be used to sort note progress entries<p>Possible values:</p><ul><li><b>progressedAt</b>: The progress date</li></ul>
- `direction` 'ascending' | 'descending' — Represents the direction in which sorting should be applied<p>Possible values:</p><ul><li><b>ascending</b>: Indicates ascending sorting order</li><li><b>descending</b>: Indicates descending sorting order</li></ul>
- `pageNumber` integer
- `pageSize` integer

## Headers

- `Customer-Id` integer, required

## Response `200`

OK

- PagedResponseReadNoteProgressModel — A paged collection of items
  - `items` ReadNoteProgressModel[] — The items returned for the requested page
    - `id` integer — The unique identifier of the note progress entry
    - `progressedAt` string, date-time — The UTC timestamp of when this note was progressed
    - `percentage` integer — The percentage the note was progressed to
    - `comment` string — Free text description about progress made by this update
  - `pageNumber` integer — The page number of the response where 1 is the first page
  - `pageSize` integer — The number of items requested for the current page
  - `pageItemCount` integer — The number of items returned in the current page

## Other responses

- `400` — Bad Request
- `403` — Forbidden
- `404` — Not Found
- `500` — Internal Server Error

---

[API](https://skmtc.net/bigchange/apis/bigchange-dx.md) · [All operations](https://skmtc.net/bigchange/apis/bigchange-dx/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/bigchange/bigchange-dx/revisions/916e669fc527/schema)