Sign in
latestOpenAPI 3.0.12026-08-192092911.2 MB

916e669fc527

Notes

Get the history of progress updates for a note

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

get/v1/notes/{noteId}/progress/history

Path parameters

noteIdinteger required

The unique identifier of the note

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>

Example:progressedAt

The field to sort items in the page by

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>

Example:ascending

The direction to apply the sort

pageNumberinteger

The page number being requested (minimum: 1, maximum: 2147483)

pageSizeinteger

The page size being requested (minimum: 1, maximum: 1000)

Headers

Customer-Idinteger required

The customer identifier

Response

OK

pageNumberinteger

The page number of the response where 1 is the first page

pageSizeinteger

The number of items requested for the current page

pageItemCountinteger

The number of items returned in the current page

Example response

{
  "items": [
    {
      "id": 124124,
      "progressedAt": "2023-09-12T11:24:23.0000000+00:00",
      "percentage": 50,
      "comment": "Sent out the new part"
    }
  ],
  "pageNumber": 2,
  "pageSize": 100,
  "pageItemCount": 55
}