Search documentation

Type to search.

Navigate · Enter to open · Esc to close

On this page

Retrieve notes in creation order. Use limit to choose the page size and pass the nextCursor from a response to retrieve the following page. An absent nextCursor means there are no more results.

GET /notes

Parameters

limit (query)

Optional. Maximum number of notes to return. Defaults to 20.

integer

cursor (query)

Optional. Opaque pagination cursor from the previous response.

string

Responses

200

A page of notes and an optional continuation cursor.

application/json

NotePage

{
  "items": [
    {
      "id": "note-1",
      "title": "Write the getting-started guide",
      "body": "Cover installation and the first build.",
      "status": "open",
      "createdAt": "2026-10-04T10:00:00Z"
    }
  ],
  "nextCursor": "note-1"
}

400

The page size or cursor is invalid.

application/json

Error

{
  "code": "invalid_parameter",
  "message": "limit must be between 1 and 100."
}

Request example

Replace the explicit placeholders with your API URL and values. Credentials are never populated automatically.

curl --request GET '<BASE_URL>/notes?limit=<VALUE>&cursor=<VALUE>'