Health, identity and locations

Response 200

{
  ok: true
}

Response 200

{
  ok: true
  region: string
  dbMs: number
}

Response 200

{
  type: "agent"
  id: string
  orgId: string
  scopes: ("platform:admin" | "platform:infra" | "platform:analytics" | "platform:coverage" | "org:read" | "org:write" | "audit:read" | "tenant:read" | "tenant:write" | "members:read" | "members:write" | "projects:read" | "projects:write" | "deployments:read" | "deployments:write" | "env:read" | "env:write" | "keys:read" | "keys:use" | "keys:write" | "domains:read" | "domains:write" | "resources:read" | "resources:write" | "git:read" | "git:write" | "git:admin" | "logs:read" | "analytics:read" | "knowledge:read" | "knowledge:write" | "connectors:read" | "connectors:write" | "chat:use" | "mcp:connect" | "agents:read" | "agents:write" | "agents:run" | "mail:read" | "mail:send" | "mail:admin" | "calendar:read" | "calendar:write" | "contacts:read" | "contacts:write" | "issues:read" | "issues:write" | "issues:admin" | "maps:read" | "maps:write" | "drive:read" | "drive:write" | "crm:read" | "crm:write" | "crm:admin" | "marketing:read" | "marketing:write" | "marketing:send" | "marketing:admin" | "health:read" | "health:write" | "weather:read" | "weather:write" | "food:read" | "food:write" | "vehicles:read" | "vehicles:write" | "vehicles:control" | "vehicles:admin" | "sharing:read" | "sharing:write")[]
  name?: string
  userId?: string
  creatorRole?: "owner" | "admin" | "developer" | "viewer"
  personal?: {
    kind: "photos"
    scopes: string[]
  }
  bot?: {
    appId: string
  }
} | {
  userId: string
  email: string
  name?: string
  avatarUrl?: string
  locale?: string
  orgs: {
    id: string
    slug: string
    name?: string
    kind: "platform" | "customer"
    role: "owner" | "admin" | "developer" | "viewer"
    teams?: string[]
    scopes?: string[]
    guest?: boolean
    pending?: {
      requirement: "mfa" | "passkey" | "method"
      until: number
    }
    was?: string[]
  }[]
  held: {
    id: string
    slug: string
    name?: string
    reason: "blocked" | "guest_expired" | "mfa_required" | "passkey_required" | "method_not_allowed" | "reauthenticate" | "session_too_old"
    was?: string[]
  }[]
  isPlatformAdmin: boolean
  type: string
}

Response 200

{
  locales: {
    locale: string
    label: string
    spelling: "au" | "us"
    weekStart: number
  }[]
}

Response 200

{
  ended: {
    [key: string]: "canceled" | "unpaid" | "setup"
  }
}

Response 200

{
  space: {
    kind: "org" | "personal"
    id: string
  }
  role?: "owner" | "admin" | "developer" | "viewer"
  held?: "blocked" | "guest_expired" | "mfa_required" | "passkey_required" | "method_not_allowed" | "reauthenticate" | "session_too_old"
  apps: {
    app: "org" | "admin" | "calendar" | "cloud" | "git" | "chat" | "knowledge" | "mail" | "issues" | "maps" | "drive" | "photos" | "messaging" | "tenant" | "crm" | "health" | "weather" | "marketing" | "food" | "documents" | "sheets" | "slides" | "contacts" | "studio" | "video" | "vehicles" | "sharing"
    label: string
    reachable: boolean
    reason?: "held" | "not_in_space" | "not_in_plan" | "access_ended" | "app_off" | "not_in_groups" | "no_access"
    level: "none" | "edit" | "view" | "manage"
    levelLabel: string
    words: string
    from?: string
  }[]
  scopes: ("platform:admin" | "platform:infra" | "platform:analytics" | "platform:coverage" | "org:read" | "org:write" | "audit:read" | "tenant:read" | "tenant:write" | "members:read" | "members:write" | "projects:read" | "projects:write" | "deployments:read" | "deployments:write" | "env:read" | "env:write" | "keys:read" | "keys:use" | "keys:write" | "domains:read" | "domains:write" | "resources:read" | "resources:write" | "git:read" | "git:write" | "git:admin" | "logs:read" | "analytics:read" | "knowledge:read" | "knowledge:write" | "connectors:read" | "connectors:write" | "chat:use" | "mcp:connect" | "agents:read" | "agents:write" | "agents:run" | "mail:read" | "mail:send" | "mail:admin" | "calendar:read" | "calendar:write" | "contacts:read" | "contacts:write" | "issues:read" | "issues:write" | "issues:admin" | "maps:read" | "maps:write" | "drive:read" | "drive:write" | "crm:read" | "crm:write" | "crm:admin" | "marketing:read" | "marketing:write" | "marketing:send" | "marketing:admin" | "health:read" | "health:write" | "weather:read" | "weather:write" | "food:read" | "food:write" | "vehicles:read" | "vehicles:write" | "vehicles:control" | "vehicles:admin" | "sharing:read" | "sharing:write")[]
  hidden?: string[]
}

Response 200

{
  locations: {
    locationId: string
    label: string
    isDefault: boolean
    regions: string[]
    region?: string
  }[]
}

Response 200

{
  apps: null | {
    order: string[]
    hidden: string[]
  }
}

Response 200

{
  apps: null | {
    order: string[]
    hidden: string[]
  }
}

Response 200

{
  widgets: null | {
    v: 1
    items: {
      id: string
      kind: "counter"
      title?: string
      tint?: "success" | "warning" | "brand" | "destructive" | "chart1" | "chart2" | "chart3" | "chart4" | "chart5"
      config: {
        label: string
        step: number
        value: number
        goal: number
      }
    } | {
      id: string
      kind: "device"
      title?: string
      tint?: "success" | "warning" | "brand" | "destructive" | "chart1" | "chart2" | "chart3" | "chart4" | "chart5"
      config: {
        show: "battery" | "memory" | "thermal" | "cpu"
      }
    } | {
      id: string
      kind: "endpoint"
      title?: string
      tint?: "success" | "warning" | "brand" | "destructive" | "chart1" | "chart2" | "chart3" | "chart4" | "chart5"
      config: {
        label: string
        url: string
        path: string
        unit: string
        decimals: null | number
        refreshMinutes: number
      }
    } | {
      id: string
      kind: "weather"
      title?: string
      tint?: "success" | "warning" | "brand" | "destructive" | "chart1" | "chart2" | "chart3" | "chart4" | "chart5"
      config: {
        place: "saved" | "current"
        placeId: string
        name: string
        lat: null | number
        lon: null | number
        units: "auto" | "metric" | "imperial"
      }
    } | {
      id: string
      kind: "vehicle"
      title?: string
      tint?: "success" | "warning" | "brand" | "destructive" | "chart1" | "chart2" | "chart3" | "chart4" | "chart5"
      config: {
        vehicleId: string
        show: "charge" | "range"
        unit: "km" | "mi"
      }
    } | {
      id: string
      kind: "photo"
      title?: string
      tint?: "success" | "warning" | "brand" | "destructive" | "chart1" | "chart2" | "chart3" | "chart4" | "chart5"
      config: {
        photos: string[]
        rotate: "never" | "hourly" | "daily"
      }
    } | {
      id: string
      kind: "activity"
      title?: string
      tint?: "success" | "warning" | "brand" | "destructive" | "chart1" | "chart2" | "chart3" | "chart4" | "chart5"
      config: {
        metric: "steps" | "distance"
        range: "today" | "week"
        weekStartsOn: "monday" | "sunday"
        unit: "km" | "mi"
        goal: number
      }
    } | {
      id: string
      kind: "quote"
      title?: string
      tint?: "success" | "warning" | "brand" | "destructive" | "chart1" | "chart2" | "chart3" | "chart4" | "chart5"
      config: {}
    } | {
      id: string
      kind: "countdown"
      title?: string
      tint?: "success" | "warning" | "brand" | "destructive" | "chart1" | "chart2" | "chart3" | "chart4" | "chart5"
      config: {
        label: string
        target: "date" | "endOfDay" | "endOfWeek" | "endOfMonth" | "endOfYear"
        at: null | number
        repeat: "none" | "yearly"
        weekStartsOn: "monday" | "sunday"
        show: "auto" | "days"
        photo: string
      }
    } | {
      id: string
      kind: "reminders"
      title?: string
      tint?: "success" | "warning" | "brand" | "destructive" | "chart1" | "chart2" | "chart3" | "chart4" | "chart5"
      config: {
        list: string
        overdue: boolean
      }
    } | {
      id: string
      kind: "weekday"
      title?: string
      tint?: "success" | "warning" | "brand" | "destructive" | "chart1" | "chart2" | "chart3" | "chart4" | "chart5"
      config: {
        style: "short" | "long"
        showDate: boolean
      }
    } | {
      id: string
      kind: "flight"
      title?: string
      tint?: "success" | "warning" | "brand" | "destructive" | "chart1" | "chart2" | "chart3" | "chart4" | "chart5"
      config: {
        radiusKm: number
      }
    } | {
      id: string
      kind: "dinner"
      title?: string
      tint?: "success" | "warning" | "brand" | "destructive" | "chart1" | "chart2" | "chart3" | "chart4" | "chart5"
      config: {
        picture: boolean
      }
    } | {
      id: string
      kind: "dayProgress"
      title?: string
      tint?: "success" | "warning" | "brand" | "destructive" | "chart1" | "chart2" | "chart3" | "chart4" | "chart5"
      config: {
        period: "month" | "day" | "year" | "week"
        start: string
        end: string
        weekStartsOn: "monday" | "sunday"
        show: "remaining" | "percent"
        photo: string
      }
    } | {
      id: string
      kind: "pomodoro"
      title?: string
      tint?: "success" | "warning" | "brand" | "destructive" | "chart1" | "chart2" | "chart3" | "chart4" | "chart5"
      config: {
        focusMinutes: number
        shortBreakMinutes: number
        longBreakMinutes: number
        sprintsPerLongBreak: number
        autoStart: boolean
        dailyGoal: number
      }
    } | {
      id: string
      kind: "stocks"
      title?: string
      tint?: "success" | "warning" | "brand" | "destructive" | "chart1" | "chart2" | "chart3" | "chart4" | "chart5"
      config: {
        symbols: string[]
        mode: "fixed" | "carousel"
        change: "amount" | "percent"
      }
    } | {
      id: string
      kind: "agenda"
      title?: string
      tint?: "success" | "warning" | "brand" | "destructive" | "chart1" | "chart2" | "chart3" | "chart4" | "chart5"
      config: {
        events: boolean
        tasks: boolean
        phoneCalendars: boolean
        days: number
      }
    } | {
      id: string
      kind: "network"
      title?: string
      tint?: "success" | "warning" | "brand" | "destructive" | "chart1" | "chart2" | "chart3" | "chart4" | "chart5"
      config: {
        speedTest: boolean
        sizeKb: number
      }
    } | {
      id: string
      kind: "stopwatch"
      title?: string
      tint?: "success" | "warning" | "brand" | "destructive" | "chart1" | "chart2" | "chart3" | "chart4" | "chart5"
      config: {
        label: string
      }
    } | {
      id: string
      kind: "shopping"
      title?: string
      tint?: "success" | "warning" | "brand" | "destructive" | "chart1" | "chart2" | "chart3" | "chart4" | "chart5"
      config: {
        count: number
      }
    } | {
      id: string
      kind: "progressBars"
      title?: string
      tint?: "success" | "warning" | "brand" | "destructive" | "chart1" | "chart2" | "chart3" | "chart4" | "chart5"
      config: {
        rows: {
          label: string
          source: string
          color: "success" | "auto" | "warning" | "brand" | "destructive" | "chart1" | "chart2" | "chart3" | "chart4" | "chart5"
          max: number
        }[]
        weekStartsOn: "monday" | "sunday"
      }
    } | {
      id: string
      kind: "findmyPeople"
      title?: string
      tint?: "success" | "warning" | "brand" | "destructive" | "chart1" | "chart2" | "chart3" | "chart4" | "chart5"
      config: {
        count: number
      }
    } | {
      id: string
      kind: "findmyDevices"
      title?: string
      tint?: "success" | "warning" | "brand" | "destructive" | "chart1" | "chart2" | "chart3" | "chart4" | "chart5"
      config: {
        count: number
        phones: boolean
        cars: boolean
      }
    }[]
    board: null | {
      items: string[]
      size: "small" | "medium" | "large"
    }[]
    island: {
      enabled: boolean
      order: string[]
    }
    lockScreen: {
      enabled: boolean
      order: string[]
      maxItems: number
    }
    homeScreen: null | {
      order: string[]
    }
    standBy: null | {
      order: string[]
    }
    live: {
      order: ("widgets" | "vehicles" | "flights" | "timers")[]
      flights: "off" | "auto" | "maps" | "home"
      vehicles: boolean
      timers: boolean
    }
  }
}

Response 200

{
  widgets: null | {
    v: 1
    items: {
      id: string
      kind: "counter"
      title?: string
      tint?: "success" | "warning" | "brand" | "destructive" | "chart1" | "chart2" | "chart3" | "chart4" | "chart5"
      config: {
        label: string
        step: number
        value: number
        goal: number
      }
    } | {
      id: string
      kind: "device"
      title?: string
      tint?: "success" | "warning" | "brand" | "destructive" | "chart1" | "chart2" | "chart3" | "chart4" | "chart5"
      config: {
        show: "battery" | "memory" | "thermal" | "cpu"
      }
    } | {
      id: string
      kind: "endpoint"
      title?: string
      tint?: "success" | "warning" | "brand" | "destructive" | "chart1" | "chart2" | "chart3" | "chart4" | "chart5"
      config: {
        label: string
        url: string
        path: string
        unit: string
        decimals: null | number
        refreshMinutes: number
      }
    } | {
      id: string
      kind: "weather"
      title?: string
      tint?: "success" | "warning" | "brand" | "destructive" | "chart1" | "chart2" | "chart3" | "chart4" | "chart5"
      config: {
        place: "saved" | "current"
        placeId: string
        name: string
        lat: null | number
        lon: null | number
        units: "auto" | "metric" | "imperial"
      }
    } | {
      id: string
      kind: "vehicle"
      title?: string
      tint?: "success" | "warning" | "brand" | "destructive" | "chart1" | "chart2" | "chart3" | "chart4" | "chart5"
      config: {
        vehicleId: string
        show: "charge" | "range"
        unit: "km" | "mi"
      }
    } | {
      id: string
      kind: "photo"
      title?: string
      tint?: "success" | "warning" | "brand" | "destructive" | "chart1" | "chart2" | "chart3" | "chart4" | "chart5"
      config: {
        photos: string[]
        rotate: "never" | "hourly" | "daily"
      }
    } | {
      id: string
      kind: "activity"
      title?: string
      tint?: "success" | "warning" | "brand" | "destructive" | "chart1" | "chart2" | "chart3" | "chart4" | "chart5"
      config: {
        metric: "steps" | "distance"
        range: "today" | "week"
        weekStartsOn: "monday" | "sunday"
        unit: "km" | "mi"
        goal: number
      }
    } | {
      id: string
      kind: "quote"
      title?: string
      tint?: "success" | "warning" | "brand" | "destructive" | "chart1" | "chart2" | "chart3" | "chart4" | "chart5"
      config: {}
    } | {
      id: string
      kind: "countdown"
      title?: string
      tint?: "success" | "warning" | "brand" | "destructive" | "chart1" | "chart2" | "chart3" | "chart4" | "chart5"
      config: {
        label: string
        target: "date" | "endOfDay" | "endOfWeek" | "endOfMonth" | "endOfYear"
        at: null | number
        repeat: "none" | "yearly"
        weekStartsOn: "monday" | "sunday"
        show: "auto" | "days"
        photo: string
      }
    } | {
      id: string
      kind: "reminders"
      title?: string
      tint?: "success" | "warning" | "brand" | "destructive" | "chart1" | "chart2" | "chart3" | "chart4" | "chart5"
      config: {
        list: string
        overdue: boolean
      }
    } | {
      id: string
      kind: "weekday"
      title?: string
      tint?: "success" | "warning" | "brand" | "destructive" | "chart1" | "chart2" | "chart3" | "chart4" | "chart5"
      config: {
        style: "short" | "long"
        showDate: boolean
      }
    } | {
      id: string
      kind: "flight"
      title?: string
      tint?: "success" | "warning" | "brand" | "destructive" | "chart1" | "chart2" | "chart3" | "chart4" | "chart5"
      config: {
        radiusKm: number
      }
    } | {
      id: string
      kind: "dinner"
      title?: string
      tint?: "success" | "warning" | "brand" | "destructive" | "chart1" | "chart2" | "chart3" | "chart4" | "chart5"
      config: {
        picture: boolean
      }
    } | {
      id: string
      kind: "dayProgress"
      title?: string
      tint?: "success" | "warning" | "brand" | "destructive" | "chart1" | "chart2" | "chart3" | "chart4" | "chart5"
      config: {
        period: "month" | "day" | "year" | "week"
        start: string
        end: string
        weekStartsOn: "monday" | "sunday"
        show: "remaining" | "percent"
        photo: string
      }
    } | {
      id: string
      kind: "pomodoro"
      title?: string
      tint?: "success" | "warning" | "brand" | "destructive" | "chart1" | "chart2" | "chart3" | "chart4" | "chart5"
      config: {
        focusMinutes: number
        shortBreakMinutes: number
        longBreakMinutes: number
        sprintsPerLongBreak: number
        autoStart: boolean
        dailyGoal: number
      }
    } | {
      id: string
      kind: "stocks"
      title?: string
      tint?: "success" | "warning" | "brand" | "destructive" | "chart1" | "chart2" | "chart3" | "chart4" | "chart5"
      config: {
        symbols: string[]
        mode: "fixed" | "carousel"
        change: "amount" | "percent"
      }
    } | {
      id: string
      kind: "agenda"
      title?: string
      tint?: "success" | "warning" | "brand" | "destructive" | "chart1" | "chart2" | "chart3" | "chart4" | "chart5"
      config: {
        events: boolean
        tasks: boolean
        phoneCalendars: boolean
        days: number
      }
    } | {
      id: string
      kind: "network"
      title?: string
      tint?: "success" | "warning" | "brand" | "destructive" | "chart1" | "chart2" | "chart3" | "chart4" | "chart5"
      config: {
        speedTest: boolean
        sizeKb: number
      }
    } | {
      id: string
      kind: "stopwatch"
      title?: string
      tint?: "success" | "warning" | "brand" | "destructive" | "chart1" | "chart2" | "chart3" | "chart4" | "chart5"
      config: {
        label: string
      }
    } | {
      id: string
      kind: "shopping"
      title?: string
      tint?: "success" | "warning" | "brand" | "destructive" | "chart1" | "chart2" | "chart3" | "chart4" | "chart5"
      config: {
        count: number
      }
    } | {
      id: string
      kind: "progressBars"
      title?: string
      tint?: "success" | "warning" | "brand" | "destructive" | "chart1" | "chart2" | "chart3" | "chart4" | "chart5"
      config: {
        rows: {
          label: string
          source: string
          color: "success" | "auto" | "warning" | "brand" | "destructive" | "chart1" | "chart2" | "chart3" | "chart4" | "chart5"
          max: number
        }[]
        weekStartsOn: "monday" | "sunday"
      }
    } | {
      id: string
      kind: "findmyPeople"
      title?: string
      tint?: "success" | "warning" | "brand" | "destructive" | "chart1" | "chart2" | "chart3" | "chart4" | "chart5"
      config: {
        count: number
      }
    } | {
      id: string
      kind: "findmyDevices"
      title?: string
      tint?: "success" | "warning" | "brand" | "destructive" | "chart1" | "chart2" | "chart3" | "chart4" | "chart5"
      config: {
        count: number
        phones: boolean
        cars: boolean
      }
    }[]
    board: null | {
      items: string[]
      size: "small" | "medium" | "large"
    }[]
    island: {
      enabled: boolean
      order: string[]
    }
    lockScreen: {
      enabled: boolean
      order: string[]
      maxItems: number
    }
    homeScreen: null | {
      order: string[]
    }
    standBy: null | {
      order: string[]
    }
    live: {
      order: ("widgets" | "vehicles" | "flights" | "timers")[]
      flights: "off" | "auto" | "maps" | "home"
      vehicles: boolean
      timers: boolean
    }
  }
}

Response 200

{
  calendar: null | {
    weekStart: null | number
    workStart: number
    workEnd: number
    workDays: number[]
    zones: string[]
    defaultReminder: null | number
    defaultLength: number
    showWeekends: boolean
    showDeclined: boolean
    showTasks: boolean
    showBirthdays: boolean
    hidden: string[]
    defaultView: "month" | "day" | "year" | "week" | "agenda"
  }
}

Response 200

{
  calendar: null | {
    weekStart: null | number
    workStart: number
    workEnd: number
    workDays: number[]
    zones: string[]
    defaultReminder: null | number
    defaultLength: number
    showWeekends: boolean
    showDeclined: boolean
    showTasks: boolean
    showBirthdays: boolean
    hidden: string[]
    defaultView: "month" | "day" | "year" | "week" | "agenda"
  }
}

Response 200

{
  phones: {
    installId: string
    known: boolean
    device: string
    os?: string
    place?: {
      country?: string
      city?: string
    }
    lastActiveAt: number
    apps: {
      sessionId: string
      app?: string
      appName: string
      appVersion?: string
      signedInAt: number
      lastActiveAt: number
      push: boolean
    }[]
  }[]
  browsers: {
    sessionId: string
    method?: string
    browser?: string
    os?: string
    model?: string
    deviceKind?: string
    ip?: string
    firstIp?: string
    country?: string
    region?: string
    city?: string
    createdAt?: number
    lastSeenAt?: number
  }[]
  cli: {
    signedInAt: number
    lastActiveAt: number
    platform?: string
    sessionId: string
    machine: string
  }[]
  apple: {
    grantId: string
    orgId: string
    deviceName: string
    mailboxId: string
    address?: string
    createdAt?: number
    lastUsedAt?: number
  }[]
  thisSession: null | string
}

Response 200

{
  ok: true
  thisPhone: boolean
}

Response 200

{
  ok: true
  thisPhone: boolean
}

Response 200

{
  ok: true
}

Response 200

{
  ok: true
  keysRevoked: number
}

Response 200

{
  ok: true
}

Response 200

{
  mailboxes: {
    mailboxId: string
    orgId: string
    orgName: string
    address: string
    displayName: string
  }[]
  passwords: {
    appPasswordId: string
    name: string
    mailboxIds: string[]
    createdAt: number
    firstUsedAt?: number
    lastUsedAt?: number
    lastUsedBy?: string
    expiresAt?: number
  }[]
  devices: {
    deviceId: string
    protocol: "eas" | "ews"
    name: string
    userAgent?: string
    mailboxIds: string[]
    appPasswordId?: string
    firstSeenAt: number
    lastSeenAt: number
    wipeRequestedAt?: number
    wipedAt?: number
  }[]
  signIns: {
    grantId: string
    orgId: string
    deviceName: string
    mailboxId: string
    address?: string
    createdAt?: number
    lastUsedAt?: number
  }[]
}

Response 201

{
  password: string
  appPasswordId: string
}

Response 200

{
  ok: true
}

Response 200

{
  ok: true
}

Response 200

{
  ok: true
}

Response 200

{
  birthDate: null | string
  birthDateSource: null | "staff" | "self"
  age: null | {
    outcome: string
    adult: boolean | null
    method: string
    recheckAfter: null | number
  }
}

Response 200

{
  birthDate: null | string
  birthDateSource: null | "staff" | "self"
  age: null | {
    outcome: string
    adult: boolean | null
    method: string
    recheckAfter: null | number
  }
}

Response 200

{
  org: {
    orgId: string
    slug: string
    name: string
    kind: "platform" | "customer"
    role: "owner" | "admin" | "developer" | "viewer"
  }
  members: {
    guest?: boolean
    userId: string
    email: null | string
    name: null | string
    role: "owner" | "admin" | "developer" | "viewer"
  }[]
  groups: {
    members: {
      userId: string
      role: "owner" | "member"
    }[]
    canManage: boolean
    description?: string
    teamId: string
    name: string
  }[]
}

Response 200

{
  ok: true
}

Response 200

{
  ok: true
}

Response 200

{
  days: number
  entries: {
    eventId: string
    at: number
    result: "success" | "failure"
    device: string
    kind: "mobile" | "other" | "desktop" | "tablet"
    place?: string
    ip?: string
    how?: string
    reason?: string
    apple?: boolean
    session?: "active" | "ended" | "current"
    sessionId?: string
  }[]
}

Response 200

{
  spaces: {
    id: string
    kind: "org" | "personal"
    name: string
    slug?: string
    role?: "owner" | "admin" | "developer" | "viewer"
    view: {
      space: {
        kind: "org" | "personal"
        id: string
      }
      role?: "owner" | "admin" | "developer" | "viewer"
      held?: "blocked" | "guest_expired" | "mfa_required" | "passkey_required" | "method_not_allowed" | "reauthenticate" | "session_too_old"
      apps: {
        app: "org" | "admin" | "calendar" | "cloud" | "git" | "chat" | "knowledge" | "mail" | "issues" | "maps" | "drive" | "photos" | "messaging" | "tenant" | "crm" | "health" | "weather" | "marketing" | "food" | "documents" | "sheets" | "slides" | "contacts" | "studio" | "video" | "vehicles" | "sharing"
        label: string
        reachable: boolean
        reason?: "held" | "not_in_space" | "not_in_plan" | "access_ended" | "app_off" | "not_in_groups" | "no_access"
        level: "none" | "edit" | "view" | "manage"
        levelLabel: string
        words: string
        from?: string
      }[]
      scopes: ("platform:admin" | "platform:infra" | "platform:analytics" | "platform:coverage" | "org:read" | "org:write" | "audit:read" | "tenant:read" | "tenant:write" | "members:read" | "members:write" | "projects:read" | "projects:write" | "deployments:read" | "deployments:write" | "env:read" | "env:write" | "keys:read" | "keys:use" | "keys:write" | "domains:read" | "domains:write" | "resources:read" | "resources:write" | "git:read" | "git:write" | "git:admin" | "logs:read" | "analytics:read" | "knowledge:read" | "knowledge:write" | "connectors:read" | "connectors:write" | "chat:use" | "mcp:connect" | "agents:read" | "agents:write" | "agents:run" | "mail:read" | "mail:send" | "mail:admin" | "calendar:read" | "calendar:write" | "contacts:read" | "contacts:write" | "issues:read" | "issues:write" | "issues:admin" | "maps:read" | "maps:write" | "drive:read" | "drive:write" | "crm:read" | "crm:write" | "crm:admin" | "marketing:read" | "marketing:write" | "marketing:send" | "marketing:admin" | "health:read" | "health:write" | "weather:read" | "weather:write" | "food:read" | "food:write" | "vehicles:read" | "vehicles:write" | "vehicles:control" | "vehicles:admin" | "sharing:read" | "sharing:write")[]
      hidden?: string[]
    }
    caity: {
      enabled: boolean
      reason?: string
      mode: "ask" | "reads" | "app" | "auto"
      modeLabel: string
      maxMode: "ask" | "reads" | "app" | "auto"
      apps: {
        app: "cloud" | "git" | "maps" | "drive" | "photos" | "tenant" | "crm" | "health" | "weather" | "marketing" | "food" | "documents" | "sheets" | "slides" | "video" | "vehicles" | "mirage" | "brain" | "tasks" | "connectors" | "agents"
        platform: "org" | "admin" | "calendar" | "cloud" | "git" | "chat" | "knowledge" | "mail" | "issues" | "maps" | "drive" | "photos" | "messaging" | "tenant" | "crm" | "health" | "weather" | "marketing" | "food" | "documents" | "sheets" | "slides" | "contacts" | "studio" | "video" | "vehicles" | "sharing"
        label: string
        reachable: boolean
        words: string
      }[]
    }
  }[]
}

Response 200

{
  run: null | {
    startedAt: number
    done: ("apps" | "phone" | "secure" | "welcome" | "organisation" | "bring" | "connect")[]
    skipped: ("apps" | "phone" | "secure" | "welcome" | "organisation" | "bring" | "connect")[]
    completedAt?: number
    pausedAt?: number
    dismissedAt?: number
  }
  due: boolean
  steps: ("apps" | "phone" | "secure" | "welcome" | "organisation" | "bring" | "connect")[]
  name?: string
  invites: {
    inviteId: string
    orgId: string
    orgName: string
    role: string
    guest: boolean
    invitedBy?: string
  }[]
  ways: string[]
  secured: boolean
}

Response 200

{
  run: {
    startedAt: number
    done: ("apps" | "phone" | "secure" | "welcome" | "organisation" | "bring" | "connect")[]
    skipped: ("apps" | "phone" | "secure" | "welcome" | "organisation" | "bring" | "connect")[]
    completedAt?: number
    pausedAt?: number
    dismissedAt?: number
  }
}

Response 200

{
  run: null | {
    pausedAt: number
    startedAt: number
    done: ("apps" | "phone" | "secure" | "welcome" | "organisation" | "bring" | "connect")[]
    skipped: ("apps" | "phone" | "secure" | "welcome" | "organisation" | "bring" | "connect")[]
    completedAt?: number
    dismissedAt?: number
  }
}

Response 200

{
  run: null | {
    dismissedAt: number
    startedAt: number
    done: ("apps" | "phone" | "secure" | "welcome" | "organisation" | "bring" | "connect")[]
    skipped: ("apps" | "phone" | "secure" | "welcome" | "organisation" | "bring" | "connect")[]
    completedAt?: number
    pausedAt?: number
  }
}

Response 200

{
  joined: {
    orgId: string
    orgName: string
    role: "owner" | "admin" | "developer" | "viewer"
  }
  run: null | {
    startedAt: number
    done: ("apps" | "phone" | "secure" | "welcome" | "organisation" | "bring" | "connect")[]
    skipped: ("apps" | "phone" | "secure" | "welcome" | "organisation" | "bring" | "connect")[]
    completedAt?: number
    pausedAt?: number
    dismissedAt?: number
  }
}

Response 200

{
  joined: {
    orgId: string
    orgName: string
    role: "owner" | "admin" | "developer" | "viewer"
  }
  run: null | {
    startedAt: number
    done: ("apps" | "phone" | "secure" | "welcome" | "organisation" | "bring" | "connect")[]
    skipped: ("apps" | "phone" | "secure" | "welcome" | "organisation" | "bring" | "connect")[]
    completedAt?: number
    pausedAt?: number
    dismissedAt?: number
  }
}

Response 200

{
  apps: {
    orgName?: string
    clientId: string
    name: string
    kind: "project" | "dynamic"
    orgId?: string
    scopes: string[]
    lastUsedAt?: number
    createdAt?: number
  }[]
}

Response 200

{
  ok: true
}

Response 200

{
  passkeys: {
    credentialId: string
    name?: string
    transports?: string[]
    createdAt?: number
    lastUsedAt?: number
  }[]
}

Response 200

{
  ok: true
}

Response 200

{
  links: {
    provider: "apple" | "google"
    email?: string
    privateEmail: boolean
    linkedAt?: number
    lastUsedAt?: number
  }[]
  lastWay: null | "apple" | "google"
}

Response 200

{
  ok: true
}

Response 200

{
  hasPassword: boolean
}

Response 200

{
  ok: true
  signedOut: {
    browsers: number
    apps: number
    commandLine: number
  }
}

Response 200

{
  phones: {
    display: string
    number: string
    label?: string
    createdAt?: number
    verifiedAt?: number
    primary?: boolean
    phoneId: string
    verifiedBy?: "code" | "operator"
    notifications?: boolean
  }[]
  max: number
  twoStep: boolean
}

Response 200

{
  reason?: string
  phone: {
    display: string
    number: string
    label?: string
    createdAt?: number
    verifiedAt?: number
    primary?: boolean
    phoneId: string
    verifiedBy?: "code" | "operator"
    notifications?: boolean
  }
  sent: boolean
}

Response 200

{
  ok: true
  display: string
}

Response 200

{
  ok: true
  to: string
}

Response 200

{
  ok: true
}

Response 200

{
  ok: true
}

Response 200

{
  ok: true
}

Response 200

{
  ok: true
  to: string
}

Response 200

{
  ok: true
  twoStep: boolean
}

Response 200

{
  orgs: {
    orgId: string
    name: string
    role: "owner" | "admin" | "developer" | "viewer"
    scopes: {
      scope: string
      label: string
    }[]
    defaults: ("platform:admin" | "platform:infra" | "platform:analytics" | "platform:coverage" | "org:read" | "org:write" | "audit:read" | "tenant:read" | "tenant:write" | "members:read" | "members:write" | "projects:read" | "projects:write" | "deployments:read" | "deployments:write" | "env:read" | "env:write" | "keys:read" | "keys:use" | "keys:write" | "domains:read" | "domains:write" | "resources:read" | "resources:write" | "git:read" | "git:write" | "git:admin" | "logs:read" | "analytics:read" | "knowledge:read" | "knowledge:write" | "connectors:read" | "connectors:write" | "chat:use" | "mcp:connect" | "agents:read" | "agents:write" | "agents:run" | "mail:read" | "mail:send" | "mail:admin" | "calendar:read" | "calendar:write" | "contacts:read" | "contacts:write" | "issues:read" | "issues:write" | "issues:admin" | "maps:read" | "maps:write" | "drive:read" | "drive:write" | "crm:read" | "crm:write" | "crm:admin" | "marketing:read" | "marketing:write" | "marketing:send" | "marketing:admin" | "health:read" | "health:write" | "weather:read" | "weather:write" | "food:read" | "food:write" | "vehicles:read" | "vehicles:write" | "vehicles:control" | "vehicles:admin" | "sharing:read" | "sharing:write")[]
  }[]
  maxOrgs: number
  number?: string
  assistant: {
    enabled: boolean
    orgs: {
      orgId: string
      scopes: ("platform:admin" | "platform:infra" | "platform:analytics" | "platform:coverage" | "org:read" | "org:write" | "audit:read" | "tenant:read" | "tenant:write" | "members:read" | "members:write" | "projects:read" | "projects:write" | "deployments:read" | "deployments:write" | "env:read" | "env:write" | "keys:read" | "keys:use" | "keys:write" | "domains:read" | "domains:write" | "resources:read" | "resources:write" | "git:read" | "git:write" | "git:admin" | "logs:read" | "analytics:read" | "knowledge:read" | "knowledge:write" | "connectors:read" | "connectors:write" | "chat:use" | "mcp:connect" | "agents:read" | "agents:write" | "agents:run" | "mail:read" | "mail:send" | "mail:admin" | "calendar:read" | "calendar:write" | "contacts:read" | "contacts:write" | "issues:read" | "issues:write" | "issues:admin" | "maps:read" | "maps:write" | "drive:read" | "drive:write" | "crm:read" | "crm:write" | "crm:admin" | "marketing:read" | "marketing:write" | "marketing:send" | "marketing:admin" | "health:read" | "health:write" | "weather:read" | "weather:write" | "food:read" | "food:write" | "vehicles:read" | "vehicles:write" | "vehicles:control" | "vehicles:admin" | "sharing:read" | "sharing:write")[]
    }[]
    defaultOrgId?: string
    sms: boolean
    voice: boolean
    pinForActions: boolean
    saveTranscripts: "none" | "issues" | "brain"
    issuesSpace?: string
    retentionDays: 7 | 90 | 30
    briefingAt?: string
  }
  hasPin: boolean
  hasPhone: boolean
}

Response 200

{
  assistant: {
    enabled: boolean
    orgs: {
      orgId: string
      scopes: ("platform:admin" | "platform:infra" | "platform:analytics" | "platform:coverage" | "org:read" | "org:write" | "audit:read" | "tenant:read" | "tenant:write" | "members:read" | "members:write" | "projects:read" | "projects:write" | "deployments:read" | "deployments:write" | "env:read" | "env:write" | "keys:read" | "keys:use" | "keys:write" | "domains:read" | "domains:write" | "resources:read" | "resources:write" | "git:read" | "git:write" | "git:admin" | "logs:read" | "analytics:read" | "knowledge:read" | "knowledge:write" | "connectors:read" | "connectors:write" | "chat:use" | "mcp:connect" | "agents:read" | "agents:write" | "agents:run" | "mail:read" | "mail:send" | "mail:admin" | "calendar:read" | "calendar:write" | "contacts:read" | "contacts:write" | "issues:read" | "issues:write" | "issues:admin" | "maps:read" | "maps:write" | "drive:read" | "drive:write" | "crm:read" | "crm:write" | "crm:admin" | "marketing:read" | "marketing:write" | "marketing:send" | "marketing:admin" | "health:read" | "health:write" | "weather:read" | "weather:write" | "food:read" | "food:write" | "vehicles:read" | "vehicles:write" | "vehicles:control" | "vehicles:admin" | "sharing:read" | "sharing:write")[]
    }[]
    defaultOrgId?: string
    sms: boolean
    voice: boolean
    pinForActions: boolean
    saveTranscripts: "none" | "issues" | "brain"
    issuesSpace?: string
    retentionDays: 7 | 90 | 30
    briefingAt?: string
  }
}

Response 200

{
  ok: true
}

Response 200

{
  keys: {
    uses30d: number
    lastUsedAt: null | number
    keyId: string
    name: string
    description: null | string
    app: "keys" | "drive" | "health" | "vehicles" | "secrets" | "connectors" | "integrations" | "vehicles-tesla"
    appLabel: string
    protects: string
    scope: {
      kind: "org" | "project" | "person" | "environment" | "space" | "vehicle"
      id: string
    }
    owner: "org" | "person"
    algorithm: "aes-256-gcm" | "ed25519" | "ecdsa-p256" | "s3"
    state: "disabled" | "enabled" | "destroyed"
    currentVersion: number
    managed: boolean
    createdAt: number
    rotatedAt: null | number
    rotateEveryDays: null | number
    nextRotationAt: null | number
    destroyedAt: null | number
    canRotate: boolean
  }[]
}

Response 200

{
  key: {
    keyId: string
    name: string
    description: null | string
    app: "keys" | "drive" | "health" | "vehicles" | "secrets" | "connectors" | "integrations" | "vehicles-tesla"
    appLabel: string
    protects: string
    scope: {
      kind: "org" | "project" | "person" | "environment" | "space" | "vehicle"
      id: string
    }
    owner: "org" | "person"
    algorithm: "aes-256-gcm" | "ed25519" | "ecdsa-p256" | "s3"
    state: "disabled" | "enabled" | "destroyed"
    currentVersion: number
    managed: boolean
    createdAt: number
    rotatedAt: null | number
    rotateEveryDays: null | number
    nextRotationAt: null | number
    destroyedAt: null | number
    canRotate: boolean
    versions: {
      version: number
      createdAt: number
      current: boolean
      uses30d: number
      adopted: boolean
    }[]
    uses30d: number
    lastUsedAt: null | number
    usage: {
      day: string
      uses: number
    }[]
    canReencrypt: boolean
    jobs: {
      error?: string
      createdAt: number
      kind: "reencrypt"
      app: "keys" | "drive" | "health" | "vehicles" | "secrets" | "connectors" | "integrations" | "vehicles-tesla"
      createdBy: string
      keyId: string
      total?: number
      startedAt?: number
      state: "queued" | "done" | "failed" | "running"
      jobId: string
      failed: number
      seen: number
      moved: number
      finishedAt?: number
      current: number
      toVersion: number
    }[]
  }
  activity: {
    events: {
      eventId: string
      orgId: string
      action: string
      actor: {
        type: "user" | "key" | "device" | "system"
        id: string
        label?: string
      }
      target: {
        type: string
        id: string
        label?: string
      }
      metadata?: {
        [key: string]: unknown
      }
      ip?: string
      userAgent?: string
      createdAt: number
    }[]
    cursor: null | string
  }
}

Response 200

{
  tokens: {
    tokenId: string
    name: string
    scopes: string[]
    createdAt: number
    lastUsedAt?: number
    expiresAt?: number
  }[]
}

Response 200

{
  ok: true
}

Response 200

{
  user: {
    userId: string
    name: string
    avatarUrl: null | string
    bannerUrl: null | string
    banner: null | string
    accent: null | string
    about: null | string
    effect: null | {
      id: string
      renderer: "sparkles" | "snow" | "hearts" | "glow" | "aurora" | "confetti"
      colors: string[]
    }
    username: null | string
    kind: "org" | "personal"
    badges: {
      kind: "early-supporter"
      since: null | number
    } | {
      kind: "subscriber"
      since: number
      tier: {
        form: "stone" | "cut" | "brilliant" | "radiant" | "spark"
        name: string
        months: number
        art: "quartz" | "bronze" | "silver" | "gold" | "platinum" | "diamond" | "emerald" | "ruby" | "opal" | "early"
        id: string
      }
    }[]
    email: string
    usernameChangeAt: null | number
    showBadges: boolean
    ownBadges: {
      kind: "early-supporter"
      since: null | number
    } | {
      kind: "subscriber"
      since: number
      tier: {
        form: "stone" | "cut" | "brilliant" | "radiant" | "spark"
        name: string
        months: number
        art: "quartz" | "bronze" | "silver" | "gold" | "platinum" | "diamond" | "emerald" | "ruby" | "opal" | "early"
        id: string
      }
    }[]
    locale: null | string
    effectChoice: null | {
      id: string
      renderer: "sparkles" | "snow" | "hearts" | "glow" | "aurora" | "confetti"
      colors: string[]
    }
    effectsIncluded: boolean
  }
  locale: string
  locales: {
    locale: string
    label: string
    spelling: "au" | "us"
    weekStart: number
  }[]
  orgs: {
    scopes: ("platform:admin" | "platform:infra" | "platform:analytics" | "platform:coverage" | "org:read" | "org:write" | "audit:read" | "tenant:read" | "tenant:write" | "members:read" | "members:write" | "projects:read" | "projects:write" | "deployments:read" | "deployments:write" | "env:read" | "env:write" | "keys:read" | "keys:use" | "keys:write" | "domains:read" | "domains:write" | "resources:read" | "resources:write" | "git:read" | "git:write" | "git:admin" | "logs:read" | "analytics:read" | "knowledge:read" | "knowledge:write" | "connectors:read" | "connectors:write" | "chat:use" | "mcp:connect" | "agents:read" | "agents:write" | "agents:run" | "mail:read" | "mail:send" | "mail:admin" | "calendar:read" | "calendar:write" | "contacts:read" | "contacts:write" | "issues:read" | "issues:write" | "issues:admin" | "maps:read" | "maps:write" | "drive:read" | "drive:write" | "crm:read" | "crm:write" | "crm:admin" | "marketing:read" | "marketing:write" | "marketing:send" | "marketing:admin" | "health:read" | "health:write" | "weather:read" | "weather:write" | "food:read" | "food:write" | "vehicles:read" | "vehicles:write" | "vehicles:control" | "vehicles:admin" | "sharing:read" | "sharing:write")[]
    was?: string[]
    guest?: true
    id: string
    slug: string
    name?: string
    kind: "platform" | "customer"
    role: "owner" | "admin" | "developer" | "viewer"
  }[]
}

Response 200

{
  user: {
    userId: string
    name: string
    avatarUrl: null | string
    bannerUrl: null | string
    banner: null | string
    accent: null | string
    about: null | string
    effect: null | {
      id: string
      renderer: "sparkles" | "snow" | "hearts" | "glow" | "aurora" | "confetti"
      colors: string[]
    }
    username: null | string
    kind: "org" | "personal"
    badges: {
      kind: "early-supporter"
      since: null | number
    } | {
      kind: "subscriber"
      since: number
      tier: {
        form: "stone" | "cut" | "brilliant" | "radiant" | "spark"
        name: string
        months: number
        art: "quartz" | "bronze" | "silver" | "gold" | "platinum" | "diamond" | "emerald" | "ruby" | "opal" | "early"
        id: string
      }
    }[]
    email: string
    createdAt: number
    usernameChangeAt: null | number
    showBadges: boolean
    ownBadges: {
      kind: "early-supporter"
      since: null | number
    } | {
      kind: "subscriber"
      since: number
      tier: {
        form: "stone" | "cut" | "brilliant" | "radiant" | "spark"
        name: string
        months: number
        art: "quartz" | "bronze" | "silver" | "gold" | "platinum" | "diamond" | "emerald" | "ruby" | "opal" | "early"
        id: string
      }
    }[]
    locale: null | string
    effectChoice: null | {
      id: string
      renderer: "sparkles" | "snow" | "hearts" | "glow" | "aurora" | "confetti"
      colors: string[]
    }
    effectsIncluded: boolean
  }
  changed: ("name" | "avatar" | "bannerImage" | "banner" | "accent" | "about" | "effect" | "username" | "locale" | "showBadges")[]
}

Response 201

{
  uploadId: string
  url: string
  headers: {
    "content-type": "image/png" | "image/jpeg" | "image/webp" | "image/gif"
  }
  expiresAt: number
}

Response 200

{
  user: {
    userId: string
    name: string
    avatarUrl: null | string
    bannerUrl: null | string
    banner: null | string
    accent: null | string
    about: null | string
    effect: null | {
      id: string
      renderer: "sparkles" | "snow" | "hearts" | "glow" | "aurora" | "confetti"
      colors: string[]
    }
    username: null | string
    kind: "org" | "personal"
    badges: {
      kind: "early-supporter"
      since: null | number
    } | {
      kind: "subscriber"
      since: number
      tier: {
        form: "stone" | "cut" | "brilliant" | "radiant" | "spark"
        name: string
        months: number
        art: "quartz" | "bronze" | "silver" | "gold" | "platinum" | "diamond" | "emerald" | "ruby" | "opal" | "early"
        id: string
      }
    }[]
    email: string
    createdAt: number
    usernameChangeAt: null | number
    showBadges: boolean
    ownBadges: {
      kind: "early-supporter"
      since: null | number
    } | {
      kind: "subscriber"
      since: number
      tier: {
        form: "stone" | "cut" | "brilliant" | "radiant" | "spark"
        name: string
        months: number
        art: "quartz" | "bronze" | "silver" | "gold" | "platinum" | "diamond" | "emerald" | "ruby" | "opal" | "early"
        id: string
      }
    }[]
    locale: null | string
    effectChoice: null | {
      id: string
      renderer: "sparkles" | "snow" | "hearts" | "glow" | "aurora" | "confetti"
      colors: string[]
    }
    effectsIncluded: boolean
  }
  changed: ("name" | "avatar" | "bannerImage" | "banner" | "accent" | "about" | "effect" | "username" | "locale" | "showBadges")[]
}

Response 200

{
  user: {
    userId: string
    name: string
    avatarUrl: null | string
    bannerUrl: null | string
    banner: null | string
    accent: null | string
    about: null | string
    effect: null | {
      id: string
      renderer: "sparkles" | "snow" | "hearts" | "glow" | "aurora" | "confetti"
      colors: string[]
    }
    username: null | string
    kind: "org" | "personal"
    badges: {
      kind: "early-supporter"
      since: null | number
    } | {
      kind: "subscriber"
      since: number
      tier: {
        form: "stone" | "cut" | "brilliant" | "radiant" | "spark"
        name: string
        months: number
        art: "quartz" | "bronze" | "silver" | "gold" | "platinum" | "diamond" | "emerald" | "ruby" | "opal" | "early"
        id: string
      }
    }[]
    email: string
    createdAt: number
    usernameChangeAt: null | number
    showBadges: boolean
    ownBadges: {
      kind: "early-supporter"
      since: null | number
    } | {
      kind: "subscriber"
      since: number
      tier: {
        form: "stone" | "cut" | "brilliant" | "radiant" | "spark"
        name: string
        months: number
        art: "quartz" | "bronze" | "silver" | "gold" | "platinum" | "diamond" | "emerald" | "ruby" | "opal" | "early"
        id: string
      }
    }[]
    locale: null | string
    effectChoice: null | {
      id: string
      renderer: "sparkles" | "snow" | "hearts" | "glow" | "aurora" | "confetti"
      colors: string[]
    }
    effectsIncluded: boolean
  }
  changed: ("name" | "avatar" | "bannerImage" | "banner" | "accent" | "about" | "effect" | "username" | "locale" | "showBadges")[]
}

Response 201

{
  uploadId: string
  url: string
  headers: {
    "content-type": "image/png" | "image/jpeg" | "image/webp" | "image/gif"
  }
  expiresAt: number
}

Response 200

{
  user: {
    userId: string
    name: string
    avatarUrl: null | string
    bannerUrl: null | string
    banner: null | string
    accent: null | string
    about: null | string
    effect: null | {
      id: string
      renderer: "sparkles" | "snow" | "hearts" | "glow" | "aurora" | "confetti"
      colors: string[]
    }
    username: null | string
    kind: "org" | "personal"
    badges: {
      kind: "early-supporter"
      since: null | number
    } | {
      kind: "subscriber"
      since: number
      tier: {
        form: "stone" | "cut" | "brilliant" | "radiant" | "spark"
        name: string
        months: number
        art: "quartz" | "bronze" | "silver" | "gold" | "platinum" | "diamond" | "emerald" | "ruby" | "opal" | "early"
        id: string
      }
    }[]
    email: string
    createdAt: number
    usernameChangeAt: null | number
    showBadges: boolean
    ownBadges: {
      kind: "early-supporter"
      since: null | number
    } | {
      kind: "subscriber"
      since: number
      tier: {
        form: "stone" | "cut" | "brilliant" | "radiant" | "spark"
        name: string
        months: number
        art: "quartz" | "bronze" | "silver" | "gold" | "platinum" | "diamond" | "emerald" | "ruby" | "opal" | "early"
        id: string
      }
    }[]
    locale: null | string
    effectChoice: null | {
      id: string
      renderer: "sparkles" | "snow" | "hearts" | "glow" | "aurora" | "confetti"
      colors: string[]
    }
    effectsIncluded: boolean
  }
  changed: ("name" | "avatar" | "bannerImage" | "banner" | "accent" | "about" | "effect" | "username" | "locale" | "showBadges")[]
}

Response 200

{
  user: {
    userId: string
    name: string
    avatarUrl: null | string
    bannerUrl: null | string
    banner: null | string
    accent: null | string
    about: null | string
    effect: null | {
      id: string
      renderer: "sparkles" | "snow" | "hearts" | "glow" | "aurora" | "confetti"
      colors: string[]
    }
    username: null | string
    kind: "org" | "personal"
    badges: {
      kind: "early-supporter"
      since: null | number
    } | {
      kind: "subscriber"
      since: number
      tier: {
        form: "stone" | "cut" | "brilliant" | "radiant" | "spark"
        name: string
        months: number
        art: "quartz" | "bronze" | "silver" | "gold" | "platinum" | "diamond" | "emerald" | "ruby" | "opal" | "early"
        id: string
      }
    }[]
    email: string
    createdAt: number
    usernameChangeAt: null | number
    showBadges: boolean
    ownBadges: {
      kind: "early-supporter"
      since: null | number
    } | {
      kind: "subscriber"
      since: number
      tier: {
        form: "stone" | "cut" | "brilliant" | "radiant" | "spark"
        name: string
        months: number
        art: "quartz" | "bronze" | "silver" | "gold" | "platinum" | "diamond" | "emerald" | "ruby" | "opal" | "early"
        id: string
      }
    }[]
    locale: null | string
    effectChoice: null | {
      id: string
      renderer: "sparkles" | "snow" | "hearts" | "glow" | "aurora" | "confetti"
      colors: string[]
    }
    effectsIncluded: boolean
  }
  changed: ("name" | "avatar" | "bannerImage" | "banner" | "accent" | "about" | "effect" | "username" | "locale" | "showBadges")[]
}

Response 200

{
  effects: {
    effectId: string
    name: string
    renderer: "sparkles" | "snow" | "hearts" | "glow" | "aurora" | "confetti"
    colors: string[]
  }[]
}

Response 200

{
  username: string
  available: boolean
  reason: null | string
}

Response 200

{
  user: {
    userId: string
    name: string
    avatarUrl: null | string
    bannerUrl: null | string
    banner: null | string
    accent: null | string
    about: null | string
    effect: null | {
      id: string
      renderer: "sparkles" | "snow" | "hearts" | "glow" | "aurora" | "confetti"
      colors: string[]
    }
    username: null | string
    kind: "org" | "personal"
    badges: {
      kind: "early-supporter"
      since: null | number
    } | {
      kind: "subscriber"
      since: number
      tier: {
        form: "stone" | "cut" | "brilliant" | "radiant" | "spark"
        name: string
        months: number
        art: "quartz" | "bronze" | "silver" | "gold" | "platinum" | "diamond" | "emerald" | "ruby" | "opal" | "early"
        id: string
      }
    }[]
    email: string
    createdAt: number
    usernameChangeAt: null | number
    showBadges: boolean
    ownBadges: {
      kind: "early-supporter"
      since: null | number
    } | {
      kind: "subscriber"
      since: number
      tier: {
        form: "stone" | "cut" | "brilliant" | "radiant" | "spark"
        name: string
        months: number
        art: "quartz" | "bronze" | "silver" | "gold" | "platinum" | "diamond" | "emerald" | "ruby" | "opal" | "early"
        id: string
      }
    }[]
    locale: null | string
    effectChoice: null | {
      id: string
      renderer: "sparkles" | "snow" | "hearts" | "glow" | "aurora" | "confetti"
      colors: string[]
    }
    effectsIncluded: boolean
  }
  changed: ("name" | "avatar" | "bannerImage" | "banner" | "accent" | "about" | "effect" | "username" | "locale" | "showBadges")[]
}