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

# Get All Knowledge Base Items

> This endpoint retrieves a paginated list of all knowledge base items (FAQs and Documents)




## OpenAPI

````yaml GET /knowledge-base
openapi: 3.0.3
info:
  title: API - Local
  description: >-
    #### Welcome to the official Postman collection of Periskope API


    Periskope APIs enable you automate actions on your WhatsApp phone, and the
    Periskope platform


    - Read more about the APIs & webhooks here -
    [https://docs.periskope.app/api-reference/introduction](https://docs.periskope.app/api-reference/introduction)
        
    - We encourage responsible usage of the APIs. Follow these best practices
    and recommendations for safe actions on WhatsApp -
    [https://docs.periskope.app/get-started/best-practices](https://docs.periskope.app/get-started/best-practices)
        

    #### Getting Started


    ##### Pre-requisites:


    1. **Sign up for a free account on Periskope:** To use the Periskope API,
    you need to have an active Periskope account. If you don’t have one, you can
    sign up for a 7-day free trial [here](https://console.periskope.app).
        
    2. **Scan the QR code from WhatsApp to connect your phone:** A connected
    phone is required to use the APIs
        
    3. **Go to** [Settings >
    API](https://console.periskope.app/settings/api), and generate an API key
    for your organization - The API key is used to authenticate every request.
    Please keep this secure
        

    ##### Using Postman:


    1. **Fork the collection so you can edit values and test the APIs in your
    own postman environment:** To fork the collection, click on the three dots
    next to v1. Then click on create a fork (_shortcut: Ctrl + Alt + F)._
        
    2. **Update the value of the variables in the collection:**  
        \- Update the API key with the key generated in Step 3  
        \- Update the phone number with your connected number. This number will be added to the `x-phone` header across requests
        
        It must be in the format of country code+number, with no special characters or spaces _e.g. +91 98745 32456 becomes 919874532456_
        

    For any help or feedback, please contact us at
    [support@periskope.app](https://mailto:support@periskope.app), or ping us on
    [WhatsApp](https://what.sapp.link/periskope)
  version: 1.0.0
  contact: {}
servers:
  - url: https://api.periskope.app/v1
security:
  - bearerAuth: []
tags:
  - name: contacts
  - name: tickets
  - name: tasks
  - name: phones
  - name: message
  - name: queue
  - name: chats
  - name: group
  - name: members
  - name: webhooks
  - name: custom properties
paths:
  /knowledge-base:
    get:
      tags:
        - knowledge-base
      summary: Get All Knowledge Base Items
      description: >
        This endpoint retrieves a paginated list of all knowledge base items
        (FAQs and Documents)
      operationId: getAllKnowledgeBase
      parameters:
        - name: offset
          in: query
          schema:
            type: number
            example: '0'
            description: |-
              - The offset value for paginating the results
              - Default 0
        - name: limit
          in: query
          schema:
            type: number
            example: '10'
            description: |-
              - The maximum number of items to retrieve
              - Default 100
        - name: type
          in: query
          schema:
            type: string
            example: faq
            description: |-
              - Optional filter by type: 'faq' or 'document'
              - If not provided, returns all types
      responses:
        '200':
          description: 200 OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    description: An array of knowledge base items (FAQs and Documents)
                  total:
                    type: number
                    description: Total count of items
                  offset:
                    type: number
                    description: Current offset
                  limit:
                    type: number
                    description: Current limit
              examples:
                200 OK:
                  value:
                    data:
                      - context_id: ai-context-aaauajhjdgjnomr
                        type: faq
                        question: How do I connect WhatsApp?
                        answer: >-
                          You can connect WhatsApp by scanning the QR code in
                          Settings.
                        attachments: []
                        embedding:
                          - -0.020637017
                          - -0.0148050785
                          - 0.02985098
                          - 0.023778915
                          - ...
                        created_at: '2025-01-20T10:00:00Z'
                        updated_at: '2025-01-20T10:00:00Z'
                      - document_id: doc_xyz789
                        type: document
                        filename: user-guide.pdf
                        chunks_count: 15
                        created_at: '2025-01-19T15:30:00Z'
                        updated_at: '2025-01-19T15:30:00Z'
                    total: 2
                    offset: 0
                    limit: 10
      x-codeSamples:
        - lang: TypeScript
          label: Node.js
          source: |-
            import { PeriskopeApi } from '@periskope/periskope-client';

            const client = new PeriskopeApi({
              authToken: 'YOUR_API_KEY',
              phone: 'YOUR_PHONE_NUMBER', // e.g., '919876543210'
            });

            async function getAllKnowledgeBase() {
              const response = await client.knowledgeBase.getAll({
                offset: 0,
                limit: 10,
                type: 'faq' // optional: filter by 'faq' or 'document'
              });

              console.log(response);
            }

            getAllKnowledgeBase();
        - lang: cURL
          label: cURL
          source: |-
            curl -X GET \
              'https://api.periskope.app/v1/knowledge-base?offset=0&limit=10&type=faq' \
              -H 'Authorization: Bearer <token>' \
              -H 'Content-Type: application/json' \
              -H 'x-phone: YOUR_PHONE_NUMBER'
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer

````