> ## 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 knowledge base items

> List knowledge base items — List items synced from external sources such as Confluence or a website crawl, optionally filtered to one Confluence folder.



## OpenAPI

````yaml get /knowledgebase-items
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:
  /knowledgebase-items:
    get:
      tags:
        - Knowledge Base
      summary: List knowledge base items
      description: >-
        List knowledge base items synced from external data sources (website,
        Confluence, Notion, etc.). Use this to find item ids and inspect their
        contact-segment restrictions.
      operationId: listKnowledgebaseItems
      parameters:
        - schema:
            type: string
          in: query
          name: search
          required: false
          description: Full-text search over item titles/content
        - schema:
            type: string
            enum:
              - confluence
              - notion
              - zendesk_support
              - shopify
              - gitbook
              - intercom
              - front
              - freshdesk
              - hubspot_kb
              - genesys
              - ai_instructions
              - custom_training
              - website
              - workflow
              - help_center
          in: query
          name: data_source
          required: false
          description: >-
            Filter to a specific external data source (e.g. website, confluence,
            notion)
        - schema:
            type: string
            enum:
              - internal
              - public
          in: query
          name: visibility
          required: false
        - schema:
            default: 1
            type: integer
            minimum: 1
            maximum: 9007199254740991
          in: query
          name: page
          required: false
        - schema:
            default: 20
            type: integer
            minimum: 1
            maximum: 100
          in: query
          name: limit
          required: false
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListPublicKnowledgebaseItemsOutput'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDto'
components:
  schemas:
    ListPublicKnowledgebaseItemsOutput:
      $schema: https://json-schema.org/draft/2020-12/schema
      $id: '#/components/schemas/ListPublicKnowledgebaseItemsOutput'
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/PublicKnowledgebaseItem'
        pagination:
          type: object
          properties:
            current_page:
              type: number
            total_pages:
              type: number
            total_items:
              type: number
            items_per_page:
              type: number
            has_next_page:
              type: boolean
            has_previous_page:
              type: boolean
          required:
            - current_page
            - total_pages
            - total_items
            - items_per_page
            - has_next_page
            - has_previous_page
          additionalProperties: false
      required:
        - items
        - pagination
      additionalProperties: false
    ErrorDto:
      type: object
      properties:
        statusCode:
          type: integer
        message:
          type: string
        error:
          type: string
    PublicKnowledgebaseItem:
      $schema: https://json-schema.org/draft/2020-12/schema
      $id: '#/components/schemas/PublicKnowledgebaseItem'
      type: object
      properties:
        id:
          type: string
        title:
          type: string
        visibility:
          type: string
          enum:
            - internal
            - public
        source_type:
          type: string
          enum:
            - custom_training
            - help_center
            - integration
            - website
            - workflow
        data_source:
          description: External source the item was synced from (present when listing).
          anyOf:
            - type: string
              enum:
                - confluence
                - notion
                - zendesk_support
                - shopify
                - gitbook
                - intercom
                - front
                - freshdesk
                - hubspot_kb
                - genesys
                - ai_instructions
                - custom_training
                - website
                - workflow
                - help_center
            - type: 'null'
        stream:
          anyOf:
            - type: string
            - type: 'null'
        source_url:
          anyOf:
            - type: string
            - type: 'null'
        restricted_to_segments:
          type: array
          items:
            type: string
          description: >-
            Contact segment ids this item is restricted to. Empty = available to
            all contacts.
        restricted_to_channels:
          type: array
          items:
            $ref: '#/components/schemas/SessionChannel'
          description: >-
            Channels this item is restricted to. Empty = available on all
            channels.
        start_time:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          description: Active window start (UTC). Null = no start bound.
        end_time:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          description: Active window end (UTC). Null = no end bound.
        updated_at:
          type: string
          format: date-time
      required:
        - id
        - title
        - visibility
        - source_type
        - source_url
        - restricted_to_segments
        - restricted_to_channels
        - start_time
        - end_time
        - updated_at
      additionalProperties: false
    SessionChannel:
      $schema: https://json-schema.org/draft/2020-12/schema
      $id: '#/components/schemas/SessionChannel'
      type: string
      enum:
        - web
        - email
        - phone_voice
        - slack
        - sms
        - whatsapp
        - instagram
        - messenger
        - api
        - web_voice
        - twitter
        - twitter_mentions
        - app_review
        - internal
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````

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