List Knowledge Bases

(information)

Legal information

Enterprise Knowledge, including the APIs, may use artificial intelligence or machine learning technologies and is subject to the terms of the Predictive and Generative AI/ML Features Addendum. For more details on AI usage and data, see the AI Nutrition Facts.

Enterprise Knowledge is not a HIPAA Eligible Service or PCI compliant and should not be enabled in workflows that are subject to HIPAA or PCI.

Conversations products are only available in the new Twilio Console. If your account hasn't been migrated, you'll be redirected to the legacy Console where these products won't appear.

GET/v2/ControlPlane/KnowledgeBases

Base url: https://knowledge.twilio.com (base url)

Get a list of knowledge bases for the Twilio account.

Request

Authentication

Basic Auth

Query string

Property nameTypeRequiredPIIDescription

pageSizeinteger

Optional

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

Default: 50Minimum: 1Maximum: 100

pageTokenstring

Optional

The token for the page of results to retrieve.

Max length: 500

orderByenum<string>

Optional

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

Default: DESCPossible values:

ASCDESC

Responses

200400404429500503

Knowledge Bases retrieved successfully

Schema

Property nameTypeRequiredPIIDescriptionChild properties

knowledgeBasesarray[object]

Optional

List of Knowledge Bases associated with the Twilio account.

Max items: 1000

Show knowledgeBases properties

metaobject

Optional

Example: {"key":"knowledgeBases","pageSize":50,"nextToken":"eyJlYXN0ZXIiOiJlZ2cifQ"}

Show meta properties

Bad Request

SchemaExample

Property nameTypeRequiredPIIDescriptionChild properties

codeinteger<int32>

Optional

The Twilio error code.

Minimum: 100Maximum: 99999

messagestring

Optional

A human readable message describing the error.

Max length: 1024

moreInfostring

Optional

A URL to a Twilio error directory page with more information about the error code.

statusinteger<int32>

Optional

The HTTP status code for the error.

Minimum: 100Maximum: 599

Not Found

SchemaExample

Property nameTypeRequiredPIIDescriptionChild properties

codeinteger<int32>

Optional

The Twilio error code.

Minimum: 100Maximum: 99999

messagestring

Optional

A human readable message describing the error.

Max length: 1024

moreInfostring

Optional

A URL to a Twilio error directory page with more information about the error code.

statusinteger<int32>

Optional

The HTTP status code for the error.

Minimum: 100Maximum: 599

This error indicates that you have sent too many requests to the API. You should retry according to the Retry-After response header.

SchemaExample

Property nameTypeRequiredPIIDescriptionChild properties

codeinteger<int32>

Optional

The Twilio error code.

Minimum: 100Maximum: 99999

messagestring

Optional

A human readable message describing the error.

Max length: 1024

moreInfostring

Optional

A URL to a Twilio error directory page with more information about the error code.

statusinteger<int32>

Optional

The HTTP status code for the error.

Minimum: 100Maximum: 599

Internal Server Error

SchemaExample

Property nameTypeRequiredPIIDescriptionChild properties

codeinteger<int32>

Optional

The Twilio error code.

Minimum: 100Maximum: 99999

messagestring

Optional

A human readable message describing the error.

Max length: 1024

moreInfostring

Optional

A URL to a Twilio error directory page with more information about the error code.

statusinteger<int32>

Optional

The HTTP status code for the error.

Minimum: 100Maximum: 599

Service Unavailable

SchemaExample

Property nameTypeRequiredPIIDescriptionChild properties

codeinteger<int32>

Optional

The Twilio error code.

Minimum: 100Maximum: 99999

messagestring

Optional

A human readable message describing the error.

Max length: 1024

moreInfostring

Optional

A URL to a Twilio error directory page with more information about the error code.

statusinteger<int32>

Optional

The HTTP status code for the error.

Minimum: 100Maximum: 599

List Knowledge Bases

1// Download the helper library from https://www.twilio.com/docs/node/install
2const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
3
4// Find your Account SID and Auth Token at twilio.com/console
5// and set the environment variables. See http://twil.io/secure
6const accountSid = process.env.TWILIO_ACCOUNT_SID;
7const authToken = process.env.TWILIO_AUTH_TOKEN;
8const client = twilio(accountSid, authToken);
9
10async function listKnowledgeBases() {
11  const knowledgeBases = await client.knowledge.v2.knowledgeBases.list({
12    orderBy: "DESC",
13    limit: 20,
14  });
15
16  knowledgeBases.forEach((k) => console.log(k.displayName));
17}
18
19listKnowledgeBases();

Response

1{
2  "knowledgeBases": [
3    {
4      "displayName": "product-docs",
5      "description": "description",
6      "id": "know_knowledgebase_00000000000000000000000000",
7      "status": "ACTIVE",
8      "createdAt": "2009-07-06T20:30:00Z",
9      "updatedAt": "2009-07-06T20:30:00Z",
10      "version": 3
11    }
12  ],
13  "meta": {
14    "key": "key",
15    "pageSize": 50,
16    "nextToken": "nextToken",
17    "previousToken": "previousToken"
18  }
19}