> ## Documentation Index
> Fetch the complete documentation index at: https://developer.communicate.so/llms.txt
> Use this file to discover all available pages before exploring further.

# Read preferences that follow the authenticated user across workspaces

> Use a user-bound `ca_` bearer credential with the stated account scope, or an application session. Workspace `ck_` keys and their OAuth tokens do not grant account authority.



## OpenAPI

````yaml https://app.communicate.so/api/v1/openapi/mintlify.json get /account/preferences
openapi: 3.1.0
info:
  title: Communicate Public REST API
  version: 0.1.5
  summary: >-
    Scoped agent chat, account credential lifecycle and workspace bootstrap
    operations.
  description: >-
    Canonical external schema for implemented REST operations. Account
    credentials and application sessions authorize the documented account and
    workspace operations separately from workspace keys. Exchange a workspace
    API-key client ID and secret for a short-lived OAuth access token, or use
    the `ck_` key directly for backward compatibility. `requestId` is optional
    but, when supplied, becomes the idempotency key for retries of the same chat
    input.
servers:
  - url: https://app.communicate.so/api/v1
    description: Canonical external base URL served through the Next.js /api/v1 rewrite.
security:
  - oauth2: []
  - bearerAuth: []
paths:
  /account/preferences:
    get:
      tags:
        - Account preferences
      summary: Read preferences that follow the authenticated user across workspaces
      description: >-
        Use a user-bound `ca_` bearer credential with the stated account scope,
        or an application session. Workspace `ck_` keys and their OAuth tokens
        do not grant account authority.
      operationId: getAccountPreferences
      responses:
        '200':
          description: >-
            Read preferences that follow the authenticated user across
            workspaces
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountPreferences'
          headers:
            Cache-Control:
              schema:
                type: string
                const: no-store
        '401':
          description: >-
            Session or credential missing, invalid, expired or revoked; fresh
            password proof failed when required.
        '403':
          description: >-
            Email verification, trusted origin or required account scope is
            missing.
        '429':
          description: Per-user list or password proof rate limit exceeded.
        '500':
          description: Unexpected server failure.
      security:
        - accountBearer: []
        - accountSession: []
        - localAccountSession: []
components:
  schemas:
    AccountPreferences:
      type: object
      properties:
        inboxView:
          type: string
          enum:
            - chat
            - ticket
      required:
        - inboxView
      additionalProperties: false
  securitySchemes:
    oauth2:
      type: oauth2
      description: >-
        OAuth 2.0 client-credentials tokens bounded by the source API key scope
        ceiling.
      flows:
        clientCredentials:
          tokenUrl: https://app.communicate.so/api/v1/oauth/token
          scopes:
            agents:read: List agents in the authenticated workspace.
            chat:write: Create chat turns with an agent in the authenticated workspace.
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API key
      description: Workspace API key token with the `ck_` prefix.
    accountBearer:
      type: http
      scheme: bearer
      bearerFormat: Account credential
      description: >-
        Opaque user-bound `ca_` account credential. Each request checks live
        account scopes, verified email, expiry, revocation and the issuer
        session. Not a workspace `ck_` key or OAuth access token.
    accountSession:
      type: apiKey
      in: cookie
      name: __Secure-better-auth.session_token
      description: >-
        Signed Better Auth session cookie for an HTTPS application origin.
        Credential management additionally requires verified email and fresh
        password proof on writes.
    localAccountSession:
      type: apiKey
      in: cookie
      name: better-auth.session_token
      description: >-
        Signed session cookie used when the configured application auth origin
        is HTTP, such as local development.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.