Reference

You

Who the token is, and where it may act.

GETWho this token is/me GETWhat is on file, in numbers/overview

Who this token is

GETapi.thawed.app/v1/me

Start here. The person behind the token, the family or business this call landed in (the Thaw-Account header, else their first), the token's scopes and what it may do here once the role and the plan have had their say, and every family or business the token could name instead.

Responses

200

The person, the family or business the call landed in, the token and what it may do here, and every family or business the token could name in the header.

401

No token, a token that has ended, or one issued for the other door. WWW-Authenticate names the resource metadata document.

Problem

403

The token, the role or the plan does not allow it. A missing scope is named in scope and in the WWW-Authenticate header as insufficient_scope; a plan that does not come with it says which one does.

Problem

200 answer

userobject

idstring

namestring or null

emailstring

accountobject

idstring

namestring

kindstring

familybusiness

rolestring

ownermemberviewervieweditupload_only

bundlestring or null

The one bundle a guest was let in on, when that is all they may see.

family_or_businessobject

idstring

namestring

kindstring

planobject

namestring

labelstring

tokenobject

A personal or app token (kind, name, label, scopes, expires_at) or a connection (kind "connection", the app's name, scopes).

canobject

changeboolean

Whether a change would be allowed here (the role, the plan and the token all agreeing).

identifiersboolean

Whether account, policy and license numbers come back.

accountsarray of object

Every family or business a personal token may name in the Thaw-Account header; empty for a connection.

idstring

namestring

kindstring

rolestring

guestboolean

headerstring

apistring

The versioned base every URL in the answers hangs off.

Request

curl "https://api.thawed.app/v1/me" \
  -H "Authorization: Bearer $THAW_TOKEN"

Response 200

{
  "user": {
    "id": "019958a0-3e60-7f5c-9d41-5b2e4c80af33",
    "name": "Marisol Alvarez",
    "email": "marisol@example.com"
  },
  "account": {
    "id": "019958a0-2d5f-7e4b-8c30-4a1d3b7f9e22",
    "name": "The Alvarez family",
    "kind": "family",
    "role": "owner",
    "bundle": null,
    "family_or_business": {
      "id": "019958a0-2d5f-7e4b-8c30-4a1d3b7f9e22",
      "name": "The Alvarez family",
      "kind": "family"
    },
    "plan": {
      "name": "family",
      "label": "Family"
    }
  },
  "token": {},
  "can": {
    "change": true,
    "identifiers": false
  },
  "accounts": [
    {
      "id": "019958a0-2d5f-7e4b-8c30-4a1d3b7f9e22",
      "name": "The Alvarez family",
      "kind": "family",
      "role": "owner",
      "guest": false
    }
  ],
  "header": "Thaw-Account",
  "api": "https://api.thawed.app/v1"
}

What is on file, in numbers

GETapi.thawed.app/v1/overview

Scope: read · every token has it

The family or business in one look - documents by category and by type, the people & things by kind, the Checkup's counts, the plan's room - and the URLs of the four places.

Responses

200

The overview.

401

No token, a token that has ended, or one issued for the other door. WWW-Authenticate names the resource metadata document.

Problem

200 answer

family_or_businessobject

namestring

kindstring

youobject

Your name and role, and the token or connection the call came on.

documentsobject

currentinteger

including_replacedinteger

needs_a_lookinteger

being_readinteger

arrived_last_7_daysinteger

yearsobject

categoriesarray of object

namestring

slugstring

documentsinteger

typesarray of object

namestring

slugstring

documentsinteger

people_and_thingsarray of object

kindstring

labelstring

countinteger

checkupobject

openinteger

past_due_or_urgentinteger

snoozedinteger

handledinteger

planobject

labelstring

questions_leftinteger or null

full_reads_leftinteger or null

ways_instring

urlsobject

Request

curl "https://api.thawed.app/v1/overview" \
  -H "Authorization: Bearer $THAW_TOKEN"

Response 200

{
  "family_or_business": {
    "name": "The Alvarez family",
    "kind": "family"
  },
  "you": {},
  "documents": {
    "current": 1,
    "including_replaced": 3,
    "needs_a_look": 3,
    "being_read": 3,
    "arrived_last_7_days": 3,
    "years": {}
  },
  "categories": [
    {
      "name": "Marisol Alvarez",
      "slug": "utilities/electric-bill",
      "documents": 412
    }
  ],
  "types": [
    {
      "name": "Electric bill",
      "slug": "utilities/electric-bill",
      "documents": 412
    }
  ],
  "people_and_things": [
    {
      "kind": "document",
      "label": "Amount due",
      "count": 412
    }
  ],
  "checkup": {
    "open": 3,
    "past_due_or_urgent": 3,
    "snoozed": 3,
    "handled": 3
  },
  "plan": {
    "label": "Family",
    "questions_left": 8,
    "full_reads_left": 8
  },
  "ways_in": "email, drive, camera",
  "urls": {}
}