Get dashboard bootstrap

GET

/api/user/bootstrap

curl --request GET \
  --url https://hitkeep.com/api/user/bootstrap \
  --cookie hk_token=<hk_token>

Returns authenticated dashboard startup context in one response.

Authorizations

• cookieAuth

Responses

200

Dashboard bootstrap

Media type application/json

object

permissions

object

instance_permissions

Array<string>

instance_role

string

permissions

object

key

additional properties

string

preferences

object

default_locale

string

dismissed_onboarding_at

string format: date-time

profile

object

avatar_url

string

display_name

string

email

string format: email

given_name

string

id

string format: uuid

last_name

string

session

object

duration_seconds

integer

expires_at

string format: date-time

extendable

boolean

issued_at

string format: date-time

remember_expires_at

string format: date-time

remember_me_duration_days

integer

remembered

boolean

timing_adjustable

boolean

warning_seconds

integer

sites

Array<object>

object

created_at

string format: date-time

data_retention_days

integer

domain

string

id

string format: uuid

user_id

string format: uuid

status

object

cloud

object

hosted

boolean

jurisdiction

string

region

string

signup_enabled

boolean

support_url

string

upgrade_url

string

needs_setup

boolean

version

string

teams

object

active_team_id

string format: uuid

recent_team_ids

Array<string>

teams

Array<object>

object

created_at

string format: date-time

entitlements

object

allow_custom_branding

boolean

allow_sso

boolean

max_retention_days

integer

max_sites_per_team

integer

max_team_members

integer

id

string format: uuid

logo_url

string

name

string

plan

object

code

string

name

string

support_url

string

upgrade_url

string

role

string

usage

object

current_members

integer

current_pending_invites

integer

current_sites

integer

Example ^generated

{
  "permissions": {
    "instance_permissions": [
      "example"
    ],
    "instance_role": "example",
    "permissions": {
      "additionalProperty": "example"
    }
  },
  "preferences": {
    "default_locale": "example",
    "dismissed_onboarding_at": "2026-04-15T12:00:00Z"
  },
  "profile": {
    "avatar_url": "example",
    "display_name": "example",
    "email": "hello@example.com",
    "given_name": "example",
    "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "last_name": "example"
  },
  "session": {
    "duration_seconds": 1,
    "expires_at": "2026-04-15T12:00:00Z",
    "extendable": true,
    "issued_at": "2026-04-15T12:00:00Z",
    "remember_expires_at": "2026-04-15T12:00:00Z",
    "remember_me_duration_days": 1,
    "remembered": true,
    "timing_adjustable": true,
    "warning_seconds": 1
  },
  "sites": [
    {
      "created_at": "2026-04-15T12:00:00Z",
      "data_retention_days": 1,
      "domain": "example",
      "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "user_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
    }
  ],
  "status": {
    "cloud": {
      "hosted": true,
      "jurisdiction": "example",
      "region": "example",
      "signup_enabled": true,
      "support_url": "example",
      "upgrade_url": "example"
    },
    "needs_setup": true,
    "version": "example"
  },
  "teams": {
    "active_team_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "recent_team_ids": [
      "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
    ],
    "teams": [
      {
        "created_at": "2026-04-15T12:00:00Z",
        "entitlements": {
          "allow_custom_branding": true,
          "allow_sso": true,
          "max_retention_days": 1,
          "max_sites_per_team": 1,
          "max_team_members": 1
        },
        "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
        "logo_url": "example",
        "name": "example",
        "plan": {
          "code": "example",
          "name": "example",
          "support_url": "example",
          "upgrade_url": "example"
        },
        "role": "example",
        "usage": {
          "current_members": 1,
          "current_pending_invites": 1,
          "current_sites": 1
        }
      }
    ]
  }
}

401

Unauthorized

Media type application/json

object

message

string

Example ^generated

{
  "message": "example"
}