List notes

GEThttps://<your-url>/api/v2/notes

MCP id notes.indexAlso on this path: POST Create a note

Returns the notes whose parent record the caller may read, oldest position first.

Token scope: api:read:project_driveorapi:read:customer_driveorapi:read:organization_driveorapi:read:user_drive
Without it: 403 insufficient-token-scope.
Permission: project_drive::access
Without it: 403 insufficient-permission.
Rate cost: 1 unit, read bucket. view=detail makes it 3. Adds: with_total=1 +2, each include +1.
Also: If-None-Match answers 304 when nothing changed. Never cached: private, no-store. Unknown query parameters are refused, never ignored.

Both are checked, scope first. A token never does more than its user. How access is checked

Request

Example: One project's notes with their authors

curl -G \
  'https://<your-url>/api/v2/notes' \
  --data-urlencode 'filter[notable_type]=project' \
  --data-urlencode 'filter[notable_id]=1' \
  --data-urlencode 'include=user' \
  --data-urlencode 'with_total=1' \
  -H 'Authorization: Bearer <token>' \
  -H 'Accept: application/json'

const response = await fetch('https://<your-url>/api/v2/notes?filter[notable_type]=project&filter[notable_id]=1&include=user&with_total=1', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer <token>',
    'Accept': 'application/json',
  },
});

use Illuminate\Support\Facades\Http;

$response = Http::withToken('<token>')
    ->acceptJson()
    ->get('https://<your-url>/api/v2/notes?filter[notable_type]=project&filter[notable_id]=1&include=user&with_total=1');

import requests
response = requests.request(
    'GET',
    'https://<your-url>/api/v2/notes?filter[notable_type]=project&filter[notable_id]=1&include=user&with_total=1',
    headers={'Authorization': 'Bearer <token>', 'Accept': 'application/json'},
)

Response

The shape of the response, with sample values.

{
  "data": [
    {
      "id": 1,
      "content": "<p>Kick-off moved to Monday; the client will confirm scope by Friday.</p>",
      "order_column": 1,
      "user_id": 1,
      "created_at": "2026-03-04T09:15:00Z",
      "updated_at": "2026-03-04T09:15:00Z",
      "notable_type": "project",
      "notable_id": 1,
      "notable": {
        "id": 1
      },
      "user": null,
      "links": {
        "…": "1 field of NoteLinks"
      }
    }
  ],
  "meta": {
    "page": {
      "per_page": 1,
      "next_cursor": "…",
      "prev_cursor": "…",
      "total": 1
    }
  },
  "links": {
    "self": "https://<your-url>/api/v2/work-items/1",
    "next": "https://<your-url>/api/v2/work-items/1",
    "prev": "https://<your-url>/api/v2/work-items/1"
  }
}

A note is visible exactly when the record it hangs off is: only notes on projects, customers and work items you can see are listed, so this collection can be read across the whole organisation without leaking a record the caller cannot open. Scope it to one record with the notable_type/notable_id pair, which must be sent together. total is omitted unless you pass with_total=1. The declared permission is project_drive::access; the other three drive prefixes (customer_drive, organization_drive, user_drive) apply by owner type, and a token covering any of the four is accepted.

Query parameters

Unknown parameters are refused with 400, naming the parameter.

18 parameters in 5 groups

Views

viewstring

Which field set to render.

summarydefaultdetail

Pagination

Cursor pagination only. Follow links.next.

per_pageinteger1 to 100

Rows per page. At most 25 when include names a to-many relation; a larger value is 400 invalid-query-parameter.

Default: 25

cursorstring

Opaque keyset cursor from a previous page's links.next. Never construct one by hand.

with_totalboolean

Whether meta.page.total is counted for this request.

Default: false

Filters

=: equals
[in]: any of a comma-separated list
[null]: true or false: whether it is empty
[gte][lt]: at least, less than

filter[created_at]timestamp (YYYY-MM-DDThh:mm:ssZ)=[gte][lt]

Creation timestamp. Pair with sort=id for a stable full export.

filter[notable_id]integer=[in]

Id of the record the note is attached to, within the notable_type given. Must be sent together with notable_type.

A comma-separated list of at most 100 values.

filter[notable_type]string

Type of record the note is attached to: project, customer or work_item. Must be sent together with notable_id.

filter[updated_at]timestamp (YYYY-MM-DDThh:mm:ssZ)=[gte][lt]

Last-write timestamp. Use for incremental sync.

filter[user_id]integer=[in][null]

Author of the note. Accepts the literal me.

A comma-separated list of at most 100 values.

Sorting

sortstring

Up to three keys, comma-separated, each optionally prefixed with - for descending.

Default: order_column

Key	Sorts by
`order_column`	Sort position within the parent record, ascending.
`id`	Id, ascending. An id never changes, so use this for a stable full export.
`updated_at`	Last-write timestamp; pair with the id tiebreaker for sync.

Prefix a key with - for descending.

Includes

includestring

Comma-separated names to inline, at most five.

Path	Adds	Cost
`notable`	The project, customer or work item the note is attached to.	+1
`user`	The user who wrote the note.	+1

Request headers

X-Request-Idstringpattern

A correlation id of your own. It is recorded in our logs next to the server's request id but never returned: the response header always carries the server's id. A value that does not match the pattern is discarded silently, never rejected.

If-None-Matchstring

The ETag a read is conditional on. A match is answered 304 with no body.

Response 200

Returns a page of NoteList rows.

dataarray of NoteList

The rows, each a NoteList.

meta.pagePageOptionalTotal

per_page, next_cursor, prev_cursor, total.

linksPageLinks

self, next, prev.

Each row is a NoteList: 11 fields.

Headers

ETag: A weak validator (W/"…") of the rendered page.
RateLimit: The IETF httpapi-ratelimit-headers form of your remaining allowance on the tightest bucket this request touched.
RateLimit-Policy: The ceiling and window of that bucket, as <limit>;w=<seconds>.
X-Request-Id: The server-generated ULID correlating this response with our logs.

Every response also carries Cache-Control, Vary, X-Content-Type-Options, X-Plnnrly-Api-Version, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset. Headers and versioning