Skip to main content
FaqsVersion: v3

Get all FAQs by knowledge base with pagination support

GET/knowledge-bases/faqs

Retrieves Q&A entries for a knowledge base, with cursor or offset pagination and optional question search. WHEN TO USE: use this when you need to list existing FAQs; use create to add one; use update or delete to change or remove a single FAQ. RETURNS: the FAQ list, total count, lastFaqId for the next page, and whether more results exist.

Authorizations

Authorizationstringheaderrequired

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

Scope:knowledge-bases.readonly
Auth methods:OAuthPrivate Integration
Token type:Sub-Account Token

Request​

Headers

Versionstringrequired

API Version

Available optionsv3
Example:v3

Query Parameters

knowledgeBaseIdstringrequired

knowledge base ID as string

Example:710KoEzy793Fxubft0bc
locationIdstringrequired

location ID as string

Example:qDZpF8GH3qvgJTmKCoL
limitnumber

Limit the number of FAQs returned

Default:10
Example:10
lastFaqIdstring

Last FAQ ID for pagination (cursor-based)

Example:3rzeElC1FOVY91veVBkp
offsetnumber

Number of FAQs to skip (offset-based pagination)

Default:0
Example:0
searchstring

Search query to filter FAQs by question (case-insensitive contains match)

Example:pricing

Response

FAQs retrieved successfully

countnumberrequired

Total count of all FAQs in the knowledge base

Example:150
faqsobject[]required

Array of FAQ objects

lastFaqIdstring

Last FAQ ID for pagination (use as lastFaqId in next request)

Example:3rzeElC1FOVY91veVBkp
hasMoreboolean

Whether there are more FAQs available

Example:true