sync

One keyset page of currently readable rows of one entity kind for a local store

Changed on
get/api/preview/sync/snapshot

Request

  • Base URL
    https://symbol.chat (the document declares no server; this is the origin it was published from)
  • URL
    https://symbol.chat/api/preview/sync/snapshot
  • Auth
    • HTTP bearer
    • or API key in cookie __Secure-next-auth.session-token
    • or OAuth 2
      Authorization code: https://mcp.symbol.chat/authorize
      Token URL: https://mcp.symbol.chat/token

Query parameters

entity'capsules' | 'types' | 'projects' | 'collections' | 'collection_members' required

Which entity kind this page carries.

cursorstring

Opaque nextCursor from the previous page of the same entity. Omit for the first page.

limitinteger

Page size (1..200, default 100). For the change feed this bounds the log rows examined; the page may hold fewer entries after filtering.

wsstring

Workspace scope: all (default) for every workspace in the caller's grants, personal, or an organization id that is in the grants.

Response

Successful response

entity'capsules' | 'types' | 'projects' | 'collections' | 'collection_members' required
hasMoreboolean required
itemsobject[] required
nextCursorstring nullable required

Changes