Skip to content
Astro Notes

Every accessible note changed after the cursor.

GET
/v1/changes

Pages carry snapshots when asked; without one a client that cannot bridge the gap fetches individually.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
pageToken
string

A nextPageToken or nextSyncToken from an earlier call. Absent lists every note: a full sync.

pageSize
integer format: int64

Notes per page: 100 when absent, at most 500. A page is also cut short at 4 MiB of ciphertext, though never below one note.

snapshots
boolean

Include snapshots on this page. Defaults to true on a full sync. An initial sync passes true on every page so later pages need no per-note fetch.

Responses

Section titled “Responses”

200

Section titled “200”

Changed notes

Media typeapplication/json

Delta-sync page.

object
changes
required
Array<object>

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
nextPageToken
required

Pass as pageToken for the next page. Empty on the last page of this listing.

string
nextSyncToken

On the last page only. Pass it as pageToken later to list what changed since. It is the account’s sync watermark and does not expire.

string

Example

{
  "changes": [
    {
      "role": "owner"
    }
  ]
}

400

Section titled “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

Examplegenerated

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

401

Section titled “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

Examplegenerated

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

Headers

Section titled “Headers”
WWW-Authenticate
string

The Bearer challenge (RFC 6750).

429

Section titled “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

Examplegenerated

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

Headers

Section titled “Headers”
Retry-After
string

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

500

Section titled “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

Examplegenerated

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

503

Section titled “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

Examplegenerated

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