Dump this token's studying records

Important read for off-boarding and migration. Returns this bearer's account metadata, settings, token metadata, decks, cards with answers and schedules (including retired), and review history. Never includes another tenant. Token plaintext and tokenHash are omitted. Rate-limit buckets and operator counters are omitted. limit defaults to 200 and maxes at 500. When complete is false, call again with resource=cards or resource=reviews and the matching nextCursor. This is not a drill reveal. During a study session still use revealCard for one answer. A complete off-board is this tenant only: account metadata, study settings, token metadata, decks, every card page (answers, retired cards, and embedded schedules), and every review page. Start with GET /api/v1/export. When complete is true, stop. When it is false, follow cards.nextCursor with resource=cards and reviews.nextCursor with resource=reviews until each is null. Manifest counts must match the union of items. Rate-limit buckets and operator counters are not tenant data. Token plaintext and tokenHash are never exported.

get/export

Request

  • Base URL: https://fluidrecall.com/api/v1
  • URL: https://fluidrecall.com/api/v1/export
  • Auth: one of:
    • HTTP bearer
    • HTTP dpop

Query parameters

resource'cards' | 'reviews'

Omit on the first call to receive account, settings, tokens, decks, and the first card and review pages. Use cards or reviews to continue a page.

limitinteger
cursorstring

Page token from cards.nextCursor or reviews.nextCursor. Prefix is cards.v1. or reviews.v1.

Response

Tenant-scoped studying dump.

format'fluid-recall.export.v1' required
exportedAtstring required

UTC ISO-8601 timestamp ending in Z

completeboolean required

True when this first snapshot already contains every card and review. Follow nextCursor when false.

resource'all' | 'cards' | 'reviews' required
accountobject required
settingsobject nullable required
cardsobject required
reviewsobject required
countsobject required
completenessstring required

Changes

No recorded changes to this operation across all 1 revision of this API.