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

# List mini-apps

> List the mini-apps the caller can see, newest-updated first, and find one by name, description, surface, or tag.

Returns the apps newest-updated first, with each app's name, description, tags,
surface, published version, draft, owner, and `can_edit`.

What the list contains depends on who is calling:

* An identified user with app read or write permission, or an admin, sees every
  app in the workspace, including apps that only have a draft.
* Any other identified user sees only published apps shared with one of their
  roles. `draft_version_id` is always `null` for them.
* A bare API key needs `mini-apps:read`, sees every app, and receives `can_edit: false`.

Narrow the list with any of these filters. Filters combine, so an app must match all of them:

| Parameter | Matches |
| - | - |
| `q` | Text in the app's name or description, ignoring case |
| `surface` | `inbox` or `dashboard`, the same value the app reports in `target_surface` |
| `tags` | Apps with at least one of the tags, ignoring case. Repeat the parameter or separate tags with commas |

Use the app's `id` with [Read source](https://docs.open.cx/api-reference/mini-apps/source.md) to read
its code or check whether you can edit it.


## OpenAPI

````yaml get /mini-apps
openapi: 3.1.0
info:
  title: OpenCX API
  description: >

    OpenCX is an AI-powered, all-in-one platform for customer support and
    outbound communications.


    Use this API to manage your OpenCX organization's AI agents, actions,
    conversations, contacts, and more.


    To get started, generate a new API key from the dashboard.


    ## Authentication

    All API endpoints require authentication using a Bearer token. You can
    generate an API key from your OpenCX dashboard.


    ## Rate Limiting

    API requests are rate limited to ensure fair usage. The current limits are:

    - 100 requests per minute for standard endpoints

    - 1000 requests per minute for streaming endpoints


    ## Error Handling

    The API uses standard HTTP status codes and returns detailed error messages
    in the response body.
  version: 1.0-beta
  license:
    name: MIT
    url: https://opensource.org/licenses/MIT
servers:
  - url: http://localhost:8080
    description: Development
  - url: https://api.open.cx
    description: Production
security:
  - bearerAuth: []
paths:
  /mini-apps:
    get:
      summary: List mini apps
      description: >-
        Mini apps the caller can see, newest-updated first. A user-attributed
        token sees what that user sees in the dashboard: every app, drafts
        included, with mini apps read or write access (or as an admin);
        otherwise only published apps shared with one of their roles. Filters
        combine with AND.
      operationId: listMiniApps
      parameters:
        - schema:
            type: string
            maxLength: 200
          in: query
          name: q
          required: false
          description: Case-insensitive substring match on the app name or description.
        - schema:
            type: string
            enum:
              - inbox
              - dashboard
          in: query
          name: surface
          required: false
          description: >-
            Only apps on this surface (the surface each row reports in
            target_surface).
        - schema:
            anyOf:
              - type: string
              - type: array
                items:
                  type: string
          in: query
          name: tags
          required: false
          description: >-
            Comma-separated tags; an app matches when it has any of them,
            ignoring case.
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MiniAppListResponseDto'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDto'
components:
  schemas:
    MiniAppListResponseDto:
      $schema: https://json-schema.org/draft/2020-12/schema
      $id: '#/components/schemas/MiniAppListResponseDto'
      type: object
      properties:
        mini_apps:
          type: array
          items:
            $ref: '#/components/schemas/MiniAppSummaryDto'
      required:
        - mini_apps
      additionalProperties: false
    ErrorDto:
      type: object
      properties:
        statusCode:
          type: integer
        message:
          type: string
        error:
          type: string
    MiniAppSummaryDto:
      $schema: https://json-schema.org/draft/2020-12/schema
      $id: '#/components/schemas/MiniAppSummaryDto'
      type: object
      properties:
        id:
          type: string
          format: uuid
          pattern: >-
            ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
        can_edit:
          type: boolean
        name:
          type: string
        description:
          type:
            - string
            - 'null'
        icon:
          anyOf:
            - $ref: '#/components/schemas/MiniAppIcon'
            - type: 'null'
        live_version:
          type:
            - string
            - 'null'
        draft_version_id:
          type:
            - string
            - 'null'
        target_surface:
          anyOf:
            - type: string
              enum:
                - inbox
                - dashboard
            - type: 'null'
        preview_file_id:
          type:
            - string
            - 'null'
        tags:
          type: array
          items:
            type: string
        owner:
          anyOf:
            - type: object
              properties:
                id:
                  type: number
                name:
                  type: string
                avatar_url:
                  type:
                    - string
                    - 'null'
              required:
                - id
                - name
                - avatar_url
              additionalProperties: false
            - type: 'null'
        updated_at:
          type: string
          format: date-time
      required:
        - id
        - can_edit
        - name
        - description
        - icon
        - live_version
        - draft_version_id
        - target_surface
        - preview_file_id
        - tags
        - owner
        - updated_at
      additionalProperties: false
    MiniAppIcon:
      $schema: https://json-schema.org/draft/2020-12/schema
      $id: '#/components/schemas/MiniAppIcon'
      type: string
      enum:
        - ChartBar
        - ChartBarHorizontal
        - ChartLine
        - ChartLineUp
        - ChartPie
        - ChartDonut
        - ChartScatter
        - ChartPolar
        - TrendUp
        - TrendDown
        - Graph
        - Table
        - ListBullets
        - Kanban
        - Funnel
        - Gauge
        - Pulse
        - Percent
        - Calculator
        - Target
        - Crosshair
        - Timer
        - Clock
        - CalendarBlank
        - Users
        - UsersThree
        - User
        - UserCircle
        - IdentificationBadge
        - Headset
        - Handshake
        - Chat
        - ChatsTeardrop
        - Envelope
        - Phone
        - Globe
        - Megaphone
        - PaperPlaneTilt
        - Bell
        - Star
        - Heart
        - Smiley
        - ThumbsUp
        - Warning
        - ShieldCheck
        - Trophy
        - Medal
        - Flag
        - Fire
        - Rocket
        - Lightning
        - Sparkle
        - Robot
        - Brain
        - MagicWand
        - Atom
        - Lightbulb
        - Money
        - CurrencyDollar
        - Coins
        - CreditCard
        - Receipt
        - ShoppingCart
        - Package
        - Truck
        - Storefront
        - Buildings
        - MapPin
        - Tag
        - Bookmark
        - Ticket
        - Database
        - Stack
        - Cube
        - Wrench
        - Gear
        - Flask
        - FileText
        - ClipboardText
        - Notebook
        - SquaresFour
        - TreeStructure
        - Eye
        - Binoculars
        - Compass
        - Scales
        - Question
        - Info
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````

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