One note's full state: snapshot plus later updates.

GET

/v1/notes/{id}

• Reverse-proxied API origin

Recovers a client whose incremental feed cannot bridge a compaction gap, or that is newly shared.

Authorizations

• bearerAuth

Parameters

Path Parameters

id

required

string format: uuid

Note id

Header Parameters

If-None-Match

string

Return 304 when the note’s ETag is unchanged

Responses

200

Full note state

Media typeapplication/json

One note’s state within a delta-sync response.

object

deleted

required

boolean

id

required

string format: uuid

memberCount

required

Active members including the owner; 1 means unshared. Keeps the sidebar’s shared marker truthful without a members round trip.

integer format: int64

metadata

Base64 encrypted metadata digest. Absent for tombstones.

string

role

required

The caller’s role on this note. revoked accompanies deleted.

string

Allowed values: owner editor viewer revoked

seq

required

integer format: int64

snapshot

Base64 encrypted Yjs snapshot. Absent for tombstones and on incremental sync pages (fetch the note when version cannot reach snapshotVersion).

string

snapshotVersion

required

integer format: int64

updatedAt

required

Last write time, for the tree’s date column and sort.

string format: date-time

updates

required

Base64 encrypted updates newer than the snapshot, in order.

Array<string>

version

required

integer format: int64

wrappedCek

Base64 content key wrapped to the caller. Absent for tombstones and for legacy notes still encrypted under the master key.

string

Example

{
  "role": "owner"
}

Headers

ETag

string

Weak note validator

304

Note unchanged since the supplied ETag

400

The request is malformed

Media typeapplication/problem+json

RFC 9457 problem details payload.

object

detail

Explanation specific to this occurrence, written to help correct the request.

string

errors

The invalid members of the request. Present on a validation problem.

Array<object>

One invalid member of a request, located by a JSON Pointer (RFC 6901).

object

detail

required

What is wrong with it.

string

pointer

required

JSON Pointer to the member within the request body. Empty for the whole body.

string

status

required

HTTP status code.

integer format: int32

title

required

Short summary of the problem type. For about:blank, the status phrase.

string

type

Problem type URI, which resolves to its documentation. Absent means about:blank.

string

Example^generated

{
  "detail": "example",
  "errors": [
    {
      "detail": "example",
      "pointer": "example"
    }
  ],
  "status": 1,
  "title": "example",
  "type": "example"
}

401

No valid session token

Media typeapplication/problem+json

RFC 9457 problem details payload.

object

detail

Explanation specific to this occurrence, written to help correct the request.

string

errors

The invalid members of the request. Present on a validation problem.

Array<object>

One invalid member of a request, located by a JSON Pointer (RFC 6901).

object

detail

required

What is wrong with it.

string

pointer

required

JSON Pointer to the member within the request body. Empty for the whole body.

string

status

required

HTTP status code.

integer format: int32

title

required

Short summary of the problem type. For about:blank, the status phrase.

string

type

Problem type URI, which resolves to its documentation. Absent means about:blank.

string

Example^generated

{
  "detail": "example",
  "errors": [
    {
      "detail": "example",
      "pointer": "example"
    }
  ],
  "status": 1,
  "title": "example",
  "type": "example"
}

Headers

WWW-Authenticate

string

The Bearer challenge (RFC 6750).

404

Note not found

Media typeapplication/problem+json

RFC 9457 problem details payload.

object

detail

Explanation specific to this occurrence, written to help correct the request.

string

errors

The invalid members of the request. Present on a validation problem.

Array<object>

One invalid member of a request, located by a JSON Pointer (RFC 6901).

object

detail

required

What is wrong with it.

string

pointer

required

JSON Pointer to the member within the request body. Empty for the whole body.

string

status

required

HTTP status code.

integer format: int32

title

required

Short summary of the problem type. For about:blank, the status phrase.

string

type

Problem type URI, which resolves to its documentation. Absent means about:blank.

string

Example^generated

{
  "detail": "example",
  "errors": [
    {
      "detail": "example",
      "pointer": "example"
    }
  ],
  "status": 1,
  "title": "example",
  "type": "example"
}

429

Too many requests

Media typeapplication/problem+json

RFC 9457 problem details payload.

object

detail

Explanation specific to this occurrence, written to help correct the request.

string

errors

The invalid members of the request. Present on a validation problem.

Array<object>

One invalid member of a request, located by a JSON Pointer (RFC 6901).

object

detail

required

What is wrong with it.

string

pointer

required

JSON Pointer to the member within the request body. Empty for the whole body.

string

status

required

HTTP status code.

integer format: int32

title

required

Short summary of the problem type. For about:blank, the status phrase.

string

type

Problem type URI, which resolves to its documentation. Absent means about:blank.

string

Example^generated

{
  "detail": "example",
  "errors": [
    {
      "detail": "example",
      "pointer": "example"
    }
  ],
  "status": 1,
  "title": "example",
  "type": "example"
}

Headers

Retry-After

string

Seconds to wait. Sent when the limit knows when it lifts.

500

The service failed

Media typeapplication/problem+json

RFC 9457 problem details payload.

object

detail

Explanation specific to this occurrence, written to help correct the request.

string

errors

The invalid members of the request. Present on a validation problem.

Array<object>

One invalid member of a request, located by a JSON Pointer (RFC 6901).

object

detail

required

What is wrong with it.

string

pointer

required

JSON Pointer to the member within the request body. Empty for the whole body.

string

status

required

HTTP status code.

integer format: int32

title

required

Short summary of the problem type. For about:blank, the status phrase.

string

type

Problem type URI, which resolves to its documentation. Absent means about:blank.

string

Example^generated

{
  "detail": "example",
  "errors": [
    {
      "detail": "example",
      "pointer": "example"
    }
  ],
  "status": 1,
  "title": "example",
  "type": "example"
}

503

The service is at capacity

Media typeapplication/problem+json

RFC 9457 problem details payload.

object

detail

Explanation specific to this occurrence, written to help correct the request.

string

errors

The invalid members of the request. Present on a validation problem.

Array<object>

One invalid member of a request, located by a JSON Pointer (RFC 6901).

object

detail

required

What is wrong with it.

string

pointer

required

JSON Pointer to the member within the request body. Empty for the whole body.

string

status

required

HTTP status code.

integer format: int32

title

required

Short summary of the problem type. For about:blank, the status phrase.

string

type

Problem type URI, which resolves to its documentation. Absent means about:blank.

string

Example^generated

{
  "detail": "example",
  "errors": [
    {
      "detail": "example",
      "pointer": "example"
    }
  ],
  "status": 1,
  "title": "example",
  "type": "example"
}