DevelopersYour tokens
Reference

Shapes

The shapes an answer is made of. A document reads the same whichever door it came through, because the API and the MCP tools build it in one place; a field that is not on file is null, never missing.

5Problem0Scope5Named3Status14DocumentRow5Document10Fact14UpNext19CheckupItem9PersonOrThing7ShareLink
#

Problem

Fields
typestringrequired
about:blank, or a URL under the API host naming the kind of problem.
titlestringrequired
statusintegerrequired
detailstring
One sentence a person could read out.
scopeScope
The scope the call needed, on a 403 for want of one.
readwritefilesidentifiersaskmanage
Comes back from
GET /me
GET /overview
GET /search
GET /documents
POST /documents
GET /documents/{document}
PATCH /documents/{document}
GET /documents/{document}/facts
GET /documents/{document}/files/{file}
GET /documents/{document}/files/{file}/pages/{page}
GET /facts
GET /people-and-things
GET /people-and-things/{entity}
PATCH /people-and-things/{entity}
GET /checkup
GET /bundles
GET /bundles/{bundle}
GET /imports
GET /imports/{import}
GET /calendar.ics
POST /ask
POST /documents/{document}/ask
POST /checkup/obligations/{obligation}/draft
POST /checkup/{gap}/draft
POST /documents/note
POST /uploads
POST /uploads/urls
POST /uploads/complete
POST /uploads/abort
POST /documents/{document}/type
POST /documents/{document}/entities
DELETE /documents/{document}/entities/{entity}
PATCH /documents/{document}/facts/{fact}
POST /documents/{document}/reviewed
POST /documents/{document}/read-again
POST /documents/{document}/links
DELETE /documents/{document}/links/{link}
POST /checkup/obligations/{obligation}
PATCH /checkup/obligations/{obligation}/lead-days
POST /checkup/{gap}/dismiss
POST /checkup/{gap}/reopen
POST /reminders
Example
{
  "type": "utilities/electric-bill",
  "title": "Bluebonnet Electric bill September 2026",
  "status": 1,
  "detail": "A bearer token is required.",
  "scope": "read"
}
#

Scope

read (search, documents, facts, people & things, the Checkup, bundles, imports; every token has it), write (change things), files (the original file and the pages), identifiers (account, policy and license numbers), ask (Thaw's answer and the drafts). manage is on Thaw's own app's token alone and is never offered on a personal one.

Example
"read"
#

Named

Fields
idstring
titlestring
namestring
kindstring
urlstring
The page in Thaw.
Example
{
  "id": "019958a0-3e60-7f5c-9d41-5b2e4c80af33",
  "title": "Bluebonnet Electric bill September 2026",
  "name": "Marisol Alvarez",
  "kind": "person",
  "url": "https://go.thawed.app/documents/019958a0-1c4e-7d3a-9b2f-3f0c2a6e8d11"
}
#

Status

The one line Home shows for a person or thing.

Fields
textstring
whenstring (date) or null
moreinteger
How many other open items there are about it.
Example
{
  "text": "When does the electric bill come due?",
  "when": "2026-09-12",
  "more": 3
}
#

DocumentRow

One document as a list shows it.

Fields
idstring
titlestring
typestring or null
categorystring or null
datestring (date) or null
The date printed on it.
periodobject or null
fromstring or null
tostring or null
statusstring
In words - Filed, Reading, Needs a look and so on.
needs_lookboolean
readstring
fullquicknot yet
supersededboolean
Replaced by a newer version.
duplicateboolean
A copy of one already on file.
people_and_thingsarray of any
arrivedstring (date) or null
urlstring
Example
{
  "id": "019958a0-1c4e-7d3a-9b2f-3f0c2a6e8d11",
  "title": "Bluebonnet Electric bill September 2026",
  "type": "utilities/electric-bill",
  "category": "home",
  "date": "2026-09-12",
  "period": {
    "from": "marisol@example.com",
    "to": "billing@bluebonnet.example"
  },
  "status": "filed",
  "needs_look": false,
  "read": "full",
  "superseded": false,
  "duplicate": false,
  "people_and_things": [
    {
      "id": "019958a0-3e60-7f5c-9d41-5b2e4c80af33",
      "title": "Bluebonnet Electric bill September 2026",
      "name": "Marisol Alvarez",
      "kind": "document",
      "url": "https://go.thawed.app/documents/019958a0-1c4e-7d3a-9b2f-3f0c2a6e8d11",
      "role": "subject"
    }
  ],
  "arrived": "2026-09-12",
  "url": "https://go.thawed.app/documents/019958a0-1c4e-7d3a-9b2f-3f0c2a6e8d11"
}
#

Document

The whole document, as GET /documents/{id} returns it - the text at the top for a reader, everything else under metadata.

Fields
idstring
titlestring
textstring or null
The window of words, page headings inline; null unless text=1 was asked for.
urlstring
metadataany
Comes back from
GET /documents/{document}
Example
{
  "id": "019958a0-1c4e-7d3a-9b2f-3f0c2a6e8d11",
  "title": "Bluebonnet Electric bill September 2026",
  "text": "When does the electric bill come due?",
  "url": "https://go.thawed.app/documents/019958a0-1c4e-7d3a-9b2f-3f0c2a6e8d11",
  "metadata": {
    "id": "019958a0-3e60-7f5c-9d41-5b2e4c80af33",
    "title": "Bluebonnet Electric bill September 2026",
    "type": "utilities/electric-bill",
    "category": "home",
    "date": "2026-09-12",
    "period": {
      "from": "marisol@example.com",
      "to": "billing@bluebonnet.example"
    },
    "status": "filed",
    "needs_look": false,
    "read": "full",
    "superseded": false,
    "duplicate": false,
    "people_and_things": [
      {
        "id": "019958a0-3e60-7f5c-9d41-5b2e4c80af33",
        "title": "Bluebonnet Electric bill September 2026",
        "name": "Marisol Alvarez",
        "kind": "document",
        "url": "https://go.thawed.app/documents/019958a0-1c4e-7d3a-9b2f-3f0c2a6e8d11",
        "role": "subject"
      }
    ],
    "arrived": "2026-09-12",
    "url": "https://go.thawed.app/documents/019958a0-1c4e-7d3a-9b2f-3f0c2a6e8d11",
    "summary": "The September bill: $129.50, due 1 October, paid by autopay.",
    "confidence": 92,
    "page_count": 3,
    "read_by_ocr_pages": 1,
    "retention_until": "2026-10-01",
    "corrected_by_hand": [
      "string"
    ],
    "arrived_by": "email",
    "facts": [
      {
        "id": "019958a0-4f71-706d-8e52-6c3f5d91b044",
        "key": "staging/019958a0-2d5f…/scan.pdf",
        "label": "Amount due",
        "role": "money",
        "value": "$129.50",
        "number": 129.5,
        "date": "2026-09-12",
        "currency": "USD",
        "page": 1,
        "corrected_by_hand": false
      }
    ],
    "identifiers_shown": false,
    "up_next": [
      {
        "id": "019958a0-2d5f-7e4b-8c30-4a1d3b7f9e22",
        "kind": "document",
        "kind_label": "Person",
        "title": "Bluebonnet Electric bill September 2026",
        "due": "2026-10-01",
        "status": "filed",
        "snoozed_until": "2026-10-01",
        "amount": 129.5,
        "currency": "USD",
        "if_missed": "A late fee of $10 and a possible disconnection notice.",
        "what_to_do": {
          "summary": "The September bill: $129.50, due 1 October, paid by autopay.",
          "steps": [
            "string"
          ],
          "phone": "+1 512 555 0142",
          "links": [
            "string"
          ],
          "prepared": "2026"
        },
        "document": {
          "id": "019958a0-1c4e-7d3a-9b2f-3f0c2a6e8d11",
          "title": "Bluebonnet Electric bill September 2026",
          "name": "scan.pdf",
          "kind": "document",
          "url": "https://go.thawed.app/documents/019958a0-1c4e-7d3a-9b2f-3f0c2a6e8d11"
        },
        "person_or_thing": {
          "id": "019958a0-3e60-7f5c-9d41-5b2e4c80af33",
          "title": "Bluebonnet Electric bill September 2026",
          "name": "Marisol Alvarez",
          "kind": "person",
          "url": "https://go.thawed.app/documents/019958a0-1c4e-7d3a-9b2f-3f0c2a6e8d11"
        },
        "url": "https://go.thawed.app/documents/019958a0-1c4e-7d3a-9b2f-3f0c2a6e8d11"
      }
    ],
    "replaces": [
      {
        "id": "019958a0-3e60-7f5c-9d41-5b2e4c80af33",
        "title": "Bluebonnet Electric bill September 2026",
        "name": "Marisol Alvarez",
        "kind": "document",
        "url": "https://go.thawed.app/documents/019958a0-1c4e-7d3a-9b2f-3f0c2a6e8d11"
      }
    ],
    "replaced_by": {
      "id": "019958a0-2d5f-7e4b-8c30-4a1d3b7f9e22",
      "title": "Bluebonnet Electric bill September 2026",
      "name": "Marisol Alvarez",
      "kind": "document",
      "url": "https://go.thawed.app/documents/019958a0-1c4e-7d3a-9b2f-3f0c2a6e8d11"
    },
    "duplicate_of": {
      "id": "019958a0-3e60-7f5c-9d41-5b2e4c80af33",
      "title": "Bluebonnet Electric bill September 2026",
      "name": "Marisol Alvarez",
      "kind": "document",
      "url": "https://go.thawed.app/documents/019958a0-1c4e-7d3a-9b2f-3f0c2a6e8d11"
    },
    "links_out": [
      {}
    ],
    "text_window": {
      "from_page": 1,
      "to_page": 1,
      "total_pages": 3,
      "more": false,
      "next_page": 1
    }
  }
}
#

Fact

Fields
idstring
keystring
labelstring or null
rolestring
moneydatepartytextidentifier
valuestring or null
numbernumber or null
datestring (date) or null
currencystring or null
pageinteger or null
corrected_by_handboolean
Example
{
  "id": "019958a0-3e60-7f5c-9d41-5b2e4c80af33",
  "key": "staging/019958a0-2d5f…/scan.pdf",
  "label": "Amount due",
  "role": "money",
  "value": "$129.50",
  "number": 129.5,
  "date": "2026-09-12",
  "currency": "USD",
  "page": 1,
  "corrected_by_hand": false
}
#

UpNext

A dated item - a payment, a renewal, an expiry, a filing.

Fields
idstring
kindstring
kind_labelstring
titlestring
duestring (date)
statusstring
snoozed_untilstring (date) or null
amountnumber or null
currencystring or null
if_missedstring or null
what_to_doobject or null
summarystring or null
stepsarray of string
phonestring or null
linksarray of string
preparedstring or null
documentNamed or any or null
person_or_thingNamed or any or null
urlstring
Example
{
  "id": "019958a0-1c4e-7d3a-9b2f-3f0c2a6e8d11",
  "kind": "document",
  "kind_label": "Person",
  "title": "Bluebonnet Electric bill September 2026",
  "due": "2026-10-01",
  "status": "filed",
  "snoozed_until": "2026-10-01",
  "amount": 129.5,
  "currency": "USD",
  "if_missed": "A late fee of $10 and a possible disconnection notice.",
  "what_to_do": {
    "summary": "The September bill: $129.50, due 1 October, paid by autopay.",
    "steps": [
      "string"
    ],
    "phone": "+1 512 555 0142",
    "links": [
      "string"
    ],
    "prepared": "2026"
  },
  "document": {
    "id": "019958a0-1c4e-7d3a-9b2f-3f0c2a6e8d11",
    "title": "Bluebonnet Electric bill September 2026",
    "name": "scan.pdf",
    "kind": "document",
    "url": "https://go.thawed.app/documents/019958a0-1c4e-7d3a-9b2f-3f0c2a6e8d11"
  },
  "person_or_thing": {
    "id": "019958a0-3e60-7f5c-9d41-5b2e4c80af33",
    "title": "Bluebonnet Electric bill September 2026",
    "name": "Marisol Alvarez",
    "kind": "person",
    "url": "https://go.thawed.app/documents/019958a0-1c4e-7d3a-9b2f-3f0c2a6e8d11"
  },
  "url": "https://go.thawed.app/documents/019958a0-1c4e-7d3a-9b2f-3f0c2a6e8d11"
}
#

CheckupItem

One line of the Checkup - a dated item, something missing, or a document waiting on a look.

Fields
idstring
sourcestring
obligationgapdocument
kindstring
kind_labelstring
titlestring
detailstring or null
whenstring (date) or null
overdueboolean
groupstring or null
severitystring or null
statusstring
snoozed_untilstring or null
dismissed_reasonstring or null
amountnumber or null
currencystring or null
what_to_doobject or string or null
person_or_thingNamed or any or null
documentNamed or any or null
urlstring
Example
{
  "id": "019958a0-2d5f-7e4b-8c30-4a1d3b7f9e22",
  "source": "obligation",
  "kind": "payment",
  "kind_label": "Person",
  "title": "Bluebonnet Electric bill September 2026",
  "detail": "A bearer token is required.",
  "when": "2026-09-12",
  "overdue": false,
  "group": "month",
  "severity": "soon",
  "status": "filed",
  "snoozed_until": null,
  "dismissed_reason": "not_needed",
  "amount": 129.5,
  "currency": "USD",
  "what_to_do": {},
  "person_or_thing": {
    "id": "019958a0-3e60-7f5c-9d41-5b2e4c80af33",
    "title": "Bluebonnet Electric bill September 2026",
    "name": "Marisol Alvarez",
    "kind": "person",
    "url": "https://go.thawed.app/documents/019958a0-1c4e-7d3a-9b2f-3f0c2a6e8d11"
  },
  "document": {
    "id": "019958a0-1c4e-7d3a-9b2f-3f0c2a6e8d11",
    "title": "Bluebonnet Electric bill September 2026",
    "name": "scan.pdf",
    "kind": "document",
    "url": "https://go.thawed.app/documents/019958a0-1c4e-7d3a-9b2f-3f0c2a6e8d11"
  },
  "url": "https://go.thawed.app/documents/019958a0-1c4e-7d3a-9b2f-3f0c2a6e8d11"
}
#

PersonOrThing

Fields
idstring
namestring
kindstring
personpetorganizationpropertyvehiclefinancial_accountpolicyasset
kind_labelstring
subtitlestring or null
also_known_asarray of string
detailsobject
What is known about it; the numbers someone could use are left out without the identifiers scope.
gonestring (date) or null
When it was sold, ended or said to be not yours.
urlstring
Example
{
  "id": "019958a0-3e60-7f5c-9d41-5b2e4c80af33",
  "name": "Marisol Alvarez",
  "kind": "person",
  "kind_label": "Person",
  "subtitle": "Due 1 October · $129.50",
  "also_known_as": [
    "string"
  ],
  "details": {},
  "gone": "2025-06-30",
  "url": "https://go.thawed.app/documents/019958a0-1c4e-7d3a-9b2f-3f0c2a6e8d11"
}
#

A link out, without its token.

Fields
idstring
expiresstring (date)
viewsinteger
max_viewsinteger or null
passcodeboolean
liveboolean
revokedboolean
Example
{
  "id": "019958a0-4f71-706d-8e52-6c3f5d91b044",
  "expires": "2026-10-01",
  "views": 2,
  "max_views": 5,
  "passcode": false,
  "live": false,
  "revoked": false
}