Skip to main content
GET
List notes for a project

Authorizations

Authorization
string
header
required

Pass Authorization: Bearer scripe_sk_live_<...> (or scripe_sk_test_<...> for test keys) on every request. Keys are scoped to a single workspace and can be revoked from the Scripe dashboard.

The same header also accepts an OAuth 2.1 access token (scripe_oat_*); both credentials share one scope vocabulary and every operation below documents the scope it requires. An API key can hold every scope named on this surface except webhooks:manage, which is grantable to OAuth tokens only today — the webhook-endpoint operations answer 403 scope_missing to every API key. Operations that name no scope accept any valid token of the workspace.

Headers

Scripe-Api-Version
string

Pin the API version. Format YYYY-MM-DD. Omit to receive the currently rolling default. Unknown versions return 400 version_unsupported.

Example:

"2026-08-10"

Query Parameters

projectId
string
required
Example:

"proj_a1b2c3d4e5f6g7h8"

folderId
string

Folder filter. Pass the literal string null for the inbox view (notes with no folder). Omit for "every note in the project".

q
string

Free-text search over the note body. Case- and accent-insensitive substring match (the column collation is utf8mb4_0900_ai_ci); whitespace-separated words are AND-ed and a "quoted phrase" is matched whole. % and _ in the query are matched literally, not as wildcards. Results stay newest-first — this narrows the page, it does not rank by relevance. search and query are accepted as aliases. Max 200 characters; longer is a 400 invalid_request rather than a silent truncation.

Maximum string length: 200
Example:

"churn"

dateFrom
string<date-time>

ISO 8601 or YYYY-MM-DD lower bound (inclusive).

dateTo
string<date-time>

ISO 8601 or YYYY-MM-DD upper bound (inclusive).

cursor
string

Opaque pagination cursor returned by the previous page.

limit
integer
default:50

Page size. Default 50, max 200. Values above the max are clamped silently; only a non-integer or a value below 1 is rejected with bad_pagination.

Required range: 1 <= x <= 200

Response

Page of notes.

data
object[]
required
pagination
object
required