Skip to main content
GET
List knowledge bases

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

accountId
string

Account to narrow to, e.g. 7. Not an account on its own: accountId is only unique within an instance, so sending it alone can match several accounts — possibly different customers — and all of them are listed. Pass instance alongside it to address exactly one account. Get the pair from listMyCloudChatAccounts. Omit both to list every account the credentials cover.

instance
string

CloudChat instance the account lives in, e.g. 4. Pair it with accountId — the two together name exactly one account, while accountId alone does not. Get the pair from listMyCloudChatAccounts. On its own it narrows to every account the credentials cover in that instance.

offset
integer<int32>
default:0

Rows to skip. Page with total and hasNext from the response.

limit
integer<int32>
default:50

Page size. Capped at 200.

sortBy
enum<string>
default:updatedAt

Field to order by.

Available options:
kbName,
createdAt,
updatedAt
sortDir
enum<string>
default:desc

Order direction.

Available options:
asc,
desc

Response

One page of knowledge bases. Every row carries accountId and instance — the pair that identifies the account — so the rows stay attributable when the filter matched more than one account.

One page of knowledge bases.

items
object[]
required

The knowledge bases on this page.

total
integer<int64>
required

Total matching the query, across all pages.

Example:

12

offset
integer<int32>
required

Offset this page started at.

Example:

0

limit
integer<int32>
required

Page size actually applied (capped at 200).

Example:

50

hasNext
boolean
required

Whether another page follows.

Example:

false