TWtwilio
KnowledgeBases

Retrieve a Knowledge Base

Changed on

Retrieve the details of a specific Knowledge Base by its unique ID.

get/v2/ControlPlane/KnowledgeBases/{kbId}

Request

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

Response

Knowledge Base details retrieved successfully

displayNamestring required

Provides a unique and addressable name to be assigned to this Knowledge Base. This name is assigned by the developer and can be used in addition to the ID. It is intended to be human-readable and unique within the account.

descriptionstring

A human readable description of this resource, up to 128 characters.

idstring required

The unique identifier for the Knowledge Base

status'QUEUED' | 'PROVISIONING' | 'ACTIVE' | 'FAILED' | 'DELETING' required

The provisioning status of the Knowledge Base

createdAtstring date-time required

The ISO 8601 timestamp when the Knowledge Base was created.

updatedAtstring date-time required

The ISO 8601 timestamp when the Knowledge Base was last updated.

versioninteger required

The current version number of the Knowledge Base. Incremented on each successful mutable update.

Example response

{
  "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
}

Changes

  • v259909e2b8833Revision 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