HighLevel: Get all knowledge bases for a location by location Id (paginated)

← Knowledge base operations · Get started

Operation gohighlevel.listallknowledgebasespaginated

Provider route: GET /knowledge-bases/. 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"]["listAllKnowledgeBasesPaginated"]>[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.listAllKnowledgeBasesPaginated(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_all_knowledge_bases_paginated(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.locationId	string	Required within parent
query.query	string	Optional
query.limit	number	Optional	Default: 20
query.lastKnowledgeBaseId	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 knowledge bases for a location by location Id (paginated) — response body

Referenced models: Get all knowledge bases for a location by location Id (paginated) — response body

Schemas

Get all knowledge bases for a location by location Id (paginated) — response body

Field	Type	Presence	Description and constraints
$	object	Root
data	JSON	Required within parent	Paginated knowledge bases data
data (allOf 1)	Model	All variants apply	Expand Get all knowledge bases for a location by location Id (paginated) — response body — data active Count, has More, knowledge Bases, last Knowledge Base Id
success	boolean	Required within parent	Success status of the operation

Referenced models: Get all knowledge bases for a location by location Id (paginated) — response body — data active Count, has More, knowledge Bases, last Knowledge Base Id

Get all knowledge bases for a location by location Id (paginated) — response body — data active Count, has More, knowledge Bases, last Knowledge Base Id

Field	Type	Presence	Description and constraints
$	object	Root
activeCount	JSON	Required within parent
activeCount (anyOf 1)	number	Alternative	Total count of all active knowledge bases
activeCount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
hasMore	boolean	Required within parent	Whether there are more knowledge bases available
knowledgeBases	array	Required within parent	Array of knowledge bases
knowledgeBases[]	Model	Each item	Expand Get all knowledge bases for a location by location Id (paginated) — response body — data active Count, has More, knowledge Bases, last Knowledge Base Id knowledge Bases item
lastKnowledgeBaseId	string	Optional	ID of the last knowledge base in this page (use for next page request)

Referenced models: Get all knowledge bases for a location by location Id (paginated) — response body — data active Count, has More, knowledge Bases, last Knowledge Base Id knowledge Bases item

Get all knowledge bases for a location by location Id (paginated) — response body — data active Count, has More, knowledge Bases, last Knowledge Base Id knowledge Bases item

Field	Type	Presence	Description and constraints
$	object	Root
createdAt	string	Required within parent	Date when knowledge base was created
id	string	Required within parent	Knowledge base ID
name	string	Required within parent	Knowledge base name

Policy, approvals and errors

SDK function policy ID: gohighlevel.listallknowledgebasespaginated. Catalog operation: listAllKnowledgeBasesPaginated. 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