ghl_kb_faq_list
Lists FAQs in a knowledge base with pagination and optional question search, returning entries, total count, and next-page cursor for browsing existing Q&A records.
Instructions
Get all FAQs by knowledge base with pagination support 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. Endpoint: GET /knowledge-bases/faqs (Version header: v3; source: v3/knowledge-base-v3.json) Requires a Sub-Account (location) token. OAuth scopes: knowledge-bases.readonly Pagination params: limit, lastFaqId, offset — pass them to page through full result sets.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"knowledgeBaseId": "<knowledgeBaseId>",
"locationId": "<locationId>"
},
"name": "ghl_kb_faq_list"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Limit the number of FAQs returned | |
| offset | No | Number of FAQs to skip (offset-based pagination) | |
| search | No | Search query to filter FAQs by question (case-insensitive contains match) | |
| lastFaqId | No | Last FAQ ID for pagination (cursor-based) | |
| locationId | Yes | location ID as string | |
| knowledgeBaseId | Yes | knowledge base ID as string |