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

# List a dashboard's embed access

Return the embed audience of a workbook's published dashboard: the global `allowEmbed` (signed-embedding) flag, whether it is shared with **all embed users**, and the list of individual embed **tenants** it is shared with.

Embed access is a read-only share of the workbook with a system sharing group, so this is scoped to the workbook that owns the dashboard. Requires **read** access to the workbook. Returns `404` if the workbook does not exist or belongs to a different deployment.


## OpenAPI

````yaml /api-reference/api.yaml get /api/v1/deployments/{deploymentId}/workbooks/{workbookId}/embed-access
openapi: 3.1.0
info:
  title: Cube Platform API
  version: 1.0.0
  description: >-
    Programmatically manage Cube: deployments and everything scoped to them

    (environments, folders, reports, workbooks, notifications, workspace, and
    agents),

    plus account-level users, groups, policies, embedding, and AI settings.
    Data-model

    authoring, dev mode, branches, and uploads live under /build/api/v1 — same
    host and

    token, routed to the build pods.
servers:
  - url: https://{tenant}.cubecloud.dev
    description: Your tenant host. Replace the whole host if you use a custom domain.
    variables:
      tenant:
        default: your-tenant
        description: Your Cube tenant subdomain
security:
  - bearerAuth: []
tags:
  - name: Deployments
  - name: Deployment Creation
  - name: Environments
  - name: Env Variables
  - name: Regions
  - name: Data Model
  - name: Data Model Uploads
  - name: GitHub
  - name: GitHub Connection
  - name: dbt Sync
  - name: Folders
  - name: Reports
  - name: Workbooks
  - name: Notifications
  - name: Workspace
  - name: Users Admin
  - name: User Attributes
  - name: User Attribute Values
  - name: Tenant Settings
  - name: OAuth Integrations
  - name: User OAuth Tokens
  - name: OIDC Token Configs
  - name: App Theme
  - name: Embed
  - name: Embed Tenants
  - name: Dashboard Embed Access
paths:
  /api/v1/deployments/{deploymentId}/workbooks/{workbookId}/embed-access:
    get:
      tags:
        - Dashboard Embed Access
      summary: List a dashboard's embed access
      operationId: getEmbedAccess
      parameters:
        - in: path
          name: deploymentId
          required: true
          schema:
            type: number
        - in: path
          name: workbookId
          required: true
          schema:
            type: number
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmbedAccessResponse'
          description: ''
components:
  schemas:
    EmbedAccessResponse:
      properties:
        allEmbedUsers:
          $ref: '#/components/schemas/EmbedAccessAllEmbedUsers'
        allowEmbed:
          type: boolean
        tenants:
          items:
            $ref: '#/components/schemas/EmbedAccessTenantEntry'
          type: array
      required:
        - allowEmbed
        - allEmbedUsers
        - tenants
      type: object
    EmbedAccessAllEmbedUsers:
      properties:
        action:
          $ref: '#/components/schemas/EmbedAccessAllEmbedUsersAction'
        enabled:
          type: boolean
        groupId:
          oneOf:
            - type: integer
            - type: 'null'
      required:
        - enabled
        - action
      type: object
    EmbedAccessTenantEntry:
      properties:
        action:
          $ref: '#/components/schemas/EmbedAccessTenantEntryAction'
        embedTenantName:
          type: string
        groupId:
          type: integer
      required:
        - embedTenantName
        - groupId
        - action
      type: object
    EmbedAccessAllEmbedUsersAction:
      enum:
        - read
        - none
      type: string
    EmbedAccessTenantEntryAction:
      enum:
        - read
        - none
      type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: 'Token authentication. Send `Authorization: Bearer <YOUR_TOKEN>`.'

````