Get dashboard bootstrap REST API

GET

/api/user/bootstrap

curl --request GET \
  --url http://127.0.0.1:25737/api/user/bootstrap \
  --cookie hk_token=<hk_token>

Returns authenticated dashboard startup context in one response.

Authorizations

• cookieAuth

Responses

200

Dashboard bootstrap

Media typeapplication/json

object

permissions

object

active_team_capabilities

Array<string>

active_team_id

string format: uuid

active_team_role

string

can_create_teams

boolean

instance_capabilities

Array<string>

instance_permissions

Array<string>

instance_role

string

permissions

object

key

additional properties

string

site_capabilities

object

key

additional properties

Array<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

ask_ai

object

available

required

boolean

budget_exhausted

required

boolean

enabled

required

boolean

model

string

provider

string

status

required

string

Allowed values: disabled not_configured available budget_exhausted

cloud

object

hosted

boolean

jurisdiction

string

region

string

signup_enabled

boolean

support_url

string

upgrade_url

string

mail_delivery

object

available

required

boolean

status

required

string

Allowed values: available unavailable

needs_setup

boolean

version

string

support_chat

object

base_url

required

string format: uri

identifier

required

string

identifier_hash

required

string

/^[a-f0-9]{64}$/

provider

required

string

Allowed values: chatwoot

website_token

required

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_external_report_recipients

Whether scheduled reports may be sent to confirmed addresses outside the team.

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

{
  "status": {
    "ask_ai": {
      "status": "disabled"
    },
    "mail_delivery": {
      "status": "available"
    }
  },
  "support_chat": {
    "provider": "chatwoot"
  }
}

401

Unauthorized

Media typeapplication/json

object

message

string

Example^generated

{
  "message": "example"
}