Skip to main content
GET
List suggested content

Authorizations

Authorization
string
header
required

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

Path Parameters

kbId
string
required

Knowledge base to operate on. Get the ids from listMyKnowledgeBases.

Query Parameters

status
enum<string>

Which queue to read. Only pending exists — a decided suggestion becomes ordinary content, readable through listEntries.

Available options:
pending
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:createdAt

Field to order by.

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

Order direction.

Available options:
asc,
desc
searchTerm
string

Substring match on the suggested question and answer.

label
string

Exact label match. Read the labels in use from getEntryTags.

topic
string

Exact topic match. Read the topics in use from getEntryTopics.

Response

One page of suggestions.

One page of suggestions.

items
object[]
required

The suggestions on this page.

total
integer<int64>
required

Total matching the query, across all pages.

Example:

23

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