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

# List inbox embeds

> Returns inbox embed access links for your project, most recent first. Raw tokens and embed URLs are not returned after creation.



## OpenAPI

````yaml /api/platform/v1/openapi-platform.yaml get /inbox_embeds
openapi: 3.1.0
info:
  title: Kapso Platform API
  version: 0.2.0
  description: >
    Build WhatsApp messaging into your product. Manage customers, connect phone
    numbers, send broadcasts, and handle conversations.
servers:
  - url: https://api.kapso.ai/platform/v1
    description: Production
security:
  - ApiKeyAuth: []
tags:
  - name: Customers
    description: Manage customer accounts
  - name: Setup Links
    description: WhatsApp onboarding via embedded signup
  - name: Phone Numbers
    description: Connect and manage WhatsApp numbers
  - name: Webhooks
    description: Subscribe to WhatsApp events
  - name: Display Names
    description: Update WhatsApp business display names
  - name: Broadcasts
    description: |
      Send template messages at scale

      **Alpha**: This API is in alpha and subject to change
  - name: Conversations
    description: Manage conversation state
  - name: Media
    description: Upload media files for WhatsApp messaging
  - name: Users
    description: Manage project team members
  - name: Inbox Embeds
    description: Create and manage embeddable inbox access links
  - name: Webhook Deliveries
    description: View webhook delivery attempts and their status
  - name: External API Logs
    description: View logs of external API calls made by the project
  - name: Provider Models
    description: List available AI provider models
  - name: WhatsApp Flows
    description: Build interactive WhatsApp Flows for surveys and forms
  - name: Contacts
    description: Manage WhatsApp contacts
paths:
  /inbox_embeds:
    get:
      tags:
        - Inbox Embeds
      summary: List inbox embeds
      description: >-
        Returns inbox embed access links for your project, most recent first.
        Raw tokens and embed URLs are not returned after creation.
      operationId: listInboxEmbeds
      parameters:
        - name: status
          in: query
          schema:
            type: string
            enum:
              - active
              - revoked
        - name: scope_type
          in: query
          schema:
            type: string
            enum:
              - project
              - customer
              - phone_number
        - name: scope_id
          in: query
          description: >-
            Customer UUID for `customer`, WhatsApp `phone_number_id` for
            `phone_number`
          schema:
            type: string
        - name: assigned_user_id
          in: query
          schema:
            type: string
            format: uuid
        - name: page
          in: query
          schema:
            type: integer
            minimum: 1
            default: 1
        - name: per_page
          in: query
          schema:
            type: integer
            minimum: 1
            default: 20
      responses:
        '200':
          description: Success
          headers:
            X-Total:
              schema:
                type: integer
            X-Total-Pages:
              schema:
                type: integer
            X-Per-Page:
              schema:
                type: integer
            X-Page:
              schema:
                type: integer
            Link:
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InboxEmbedListResponse'
              examples:
                phone_number:
                  value:
                    data:
                      - id: 550e8400-e29b-41d4-a716-446655440000
                        name: Support embed
                        scope_type: phone_number
                        scope_id: '1234567890'
                        scope_name: +1 415 555 1234
                        assigned_user_id: null
                        assigned_user_name: null
                        status: active
                        allowed_origins:
                          - https://app.example.com
                        default_mode: system
                        expires_at: null
                        last_used_at: null
                        created_at: '2025-01-15T10:00:00Z'
                        updated_at: '2025-01-15T10:00:00Z'
                    meta:
                      page: 1
                      per_page: 20
                      total_pages: 1
                      total_count: 1
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '422':
          $ref: '#/components/responses/ValidationError'
components:
  schemas:
    InboxEmbedListResponse:
      type: object
      required:
        - data
        - meta
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/InboxEmbed'
        meta:
          $ref: '#/components/schemas/PaginationMeta'
    InboxEmbed:
      type: object
      required:
        - id
        - scope_type
        - status
        - allowed_origins
        - default_mode
        - created_at
        - updated_at
      properties:
        id:
          type: string
          format: uuid
        name:
          type:
            - string
            - 'null'
        scope_type:
          type: string
          description: Public embed scope
          enum:
            - project
            - customer
            - phone_number
        scope_id:
          type:
            - string
            - 'null'
          description: >-
            Customer UUID for `customer`, WhatsApp `phone_number_id` for
            `phone_number`, null for `project`
        scope_name:
          type:
            - string
            - 'null'
          description: Human-readable customer or phone number label when available
        assigned_user_id:
          type:
            - string
            - 'null'
          format: uuid
          description: Limits visible conversations to the active assignee
        assigned_user_name:
          type:
            - string
            - 'null'
        status:
          type: string
          enum:
            - active
            - revoked
        allowed_origins:
          type: array
          description: Origins allowed to embed the inbox. Empty means any origin.
          items:
            type: string
          example:
            - https://app.example.com
        default_mode:
          type: string
          enum:
            - system
            - light
            - dark
        expires_at:
          type:
            - string
            - 'null'
          format: date-time
        last_used_at:
          type:
            - string
            - 'null'
          format: date-time
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
    PaginationMeta:
      type: object
      required:
        - page
        - per_page
        - total_pages
        - total_count
      properties:
        page:
          type: integer
          minimum: 1
        per_page:
          type: integer
          minimum: 1
        total_pages:
          type: integer
          minimum: 0
        total_count:
          type: integer
          minimum: 0
    ErrorResponse:
      type: object
      required:
        - error
      properties:
        error:
          type: string
  responses:
    UnauthorizedError:
      description: Missing or invalid API key
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    ValidationError:
      description: Request validation failed
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key

````