HighLevel: Get all FA Qs by knowledge base with pagination support

← Knowledge base operations · Get started

Operation gohighlevel.list

Provider route: GET /knowledge-bases/faqs. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/gohighlevel with npm, or alter-sdk-gohighlevel with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { HighLevelIntegration } from "@alter-ai/gohighlevel";

async function execute(input: Parameters<HighLevelIntegration["knowledgeBase"]["list"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new HighLevelIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.knowledgeBase.list(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_gohighlevel import HighLevelIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = HighLevelIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.knowledge_base.list(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
query	object	Required within parent	Additional keys: not allowed
query.knowledgeBaseId	string	Required within parent
query.locationId	string	Required within parent
query.limit	number	Optional	Default: 10
query.lastFaqId	string	Optional

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
$	Model	Root	Expand Get all FA Qs by knowledge base with pagination support — response body

Referenced models: Get all FA Qs by knowledge base with pagination support — response body

Schemas

Get all FA Qs by knowledge base with pagination support — response body

Field	Type	Presence	Description and constraints
$	object	Root
count	JSON	Required within parent
count (anyOf 1)	number	Alternative	Total count of all FAQs in the knowledge base
count (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
faqs	array	Required within parent	Array of FAQ objects
faqs[]	Model	Each item	Expand Get all FA Qs by knowledge base with pagination support — response body — faqs item
hasMore	boolean	Optional	Whether there are more FAQs available
lastFaqId	string	Optional	Last FAQ ID for pagination (use as lastFaqId in next request)

Referenced models: Get all FA Qs by knowledge base with pagination support — response body — faqs item

Get all FA Qs by knowledge base with pagination support — response body — faqs item

Field	Type	Presence	Description and constraints
$	object	Root
answer	string	Required within parent	FAQ answer
createdAt	string	Required within parent	Date when FAQ was created
deleted	boolean	Required within parent	Whether the FAQ is deleted
id	string	Required within parent	FAQ ID as string
knowledgeBaseId	string	Required within parent	Knowledge base ID
locationId	string	Required within parent	Location ID
question	string	Required within parent	FAQ question
questionLowerCase	string	Required within parent	FAQ question in lowercase
trainedUrlId	string	Required within parent	Trained URL ID
updatedAt	string	Required within parent	Date when FAQ was last updated

Policy, approvals and errors

SDK function policy ID: gohighlevel.list. Catalog operation: list. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Pinned headers: {"Version": "v3"}

Official provider source