KnowledgeBases

List Knowledge Bases

Changed on

Get a list of knowledge bases for the Twilio account.

get/v2/ControlPlane/KnowledgeBases

Request

  • Base URL
    https://knowledge.twilio.com
  • URL
    https://knowledge.twilio.com/v2/ControlPlane/KnowledgeBases
  • Auth
    HTTP basic

Query parameters

pageSizeinteger

The maximum number of items to return per page, maximum of 100.

pageTokenstring

The token for the page of results to retrieve.

orderBy'ASC' | 'DESC'

Either 'ASC' or 'DESC' to sort results ascending or descending respectively.

Response

Knowledge Bases retrieved successfully

Example response

{
  "knowledgeBases": [
    {
      "displayName": "product-docs",
      "description": "Product documentation knowledge base for customer support",
      "id": "know_knowledgebase_00000000000000000000000000",
      "status": "ACTIVE",
      "createdAt": "2024-01-15T10:30:00Z",
      "updatedAt": "2024-01-15T11:45:00Z",
      "version": 3
    }
  ],
  "meta": {
    "nextToken": "eyJlYXN0ZXIiOiJlZ2cifQ",
    "previousToken": "eyJlYXN0ZXIiOiJlZ2cifQ"
  }
}

Changes

    • breaking

      the response property's max was increased from 99999.00 to 999999.00 for the response status

    • breaking

      the response property's max was increased from 99999.00 to 999999.00 for the response status

    • breaking

      the response property's max was increased from 99999.00 to 999999.00 for the response status

    • breaking

      the response property's max was increased from 99999.00 to 999999.00 for the response status

    • breaking

      the response property's max was increased from 99999.00 to 999999.00 for the response status

    • info

      for the query request parameter pageToken, the maxLength was increased from 500 to 4096

    • info

      the response's property default value 50 was removed for the status