bootstrap

Everything the app shell needs, in one request

Returns the payloads of /me, /me/preferences, /channels, /billing/subscription, /billing/usage, /strategy, /plans/current, /brains and /media in a single response, each byte-identical to what its own endpoint returns.

Only me is required: it gates the shell, so if it fails the request fails. Every other section degrades to null with its name listed in failed, which the client should read as fetch this one yourself. A null section absent from failed is a genuine empty — today only plan, when the workspace has not generated one yet.

get/api/v1/bootstrap

Request

  • Base URL: https://api.cadencz.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.cadencz.com/api/v1/bootstrap
  • Auth: HTTP bearer

Response

Successful Response

mediaobject[] nullable
failedstring[]

Example response

{
  "brains": [],
  "channels": [],
  "failed": [],
  "me": {
    "user": {
      "email": "creator@example.com",
      "id": "CAD1234567890912",
      "isAdmin": false,
      "name": "Creator",
      "timezone": "Asia/Kolkata"
    },
    "workspace": {
      "handle": "workspace-wks_123",
      "id": "wks_123",
      "name": "Creator's Studio",
      "ownerId": "CAD1234567890912"
    },
    "workspaces": []
  },
  "media": [],
  "preferences": {
    "timezone": "Asia/Kolkata",
    "weekStart": "monday"
  }
}

Changes

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