List notes

GET

/notes

const url = 'http://127.0.0.1:7677/notes?limit=20&offset=0';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'http://127.0.0.1:7677/notes?limit=20&offset=0' \
  --header 'Authorization: Bearer <token>'

Authorizations

Parameters

Query Parameters

limit

integer

default: 20 >= 1

Max results (default 20 for search/grep, 100 for list)

offset

integer

Skip first N results

tag

Array<string>

Filter by tag. Repeat the parameter for AND logic across multiple tags. Glob patterns are supported.

type

string

Filter by note type (comma-separated, glob patterns)

repo

string

Filter by repository (glob pattern)

ext

string

Filter by file extension in title

Responses

200

Paginated list of notes

application/json

object

data

required

Array<object>

object

required

string format: uuid

title

required

string

description

string

tags

required

Array<string>

type

required

string

Allowed values: user feedback project reference knowledge snippet file

repository

string

created

required

string format: date-time

updated

required

string format: date-time

content

required

Markdown body

string

filePath

required

Absolute path on the server’s filesystem

string

total

required

integer

offset

required

integer

limit

required

integer

Example

{
  "data": [
    {
      "type": "user"
    }
  ]
}