HighLevel: Get knowledge base by ID

← Knowledge base operations · Get started

Operation gohighlevel.getknowledgebasebyid

Provider route: GET /knowledge-bases/{knowledgeBaseId}. 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"]["getKnowledgeBaseById"]>[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.getKnowledgeBaseById(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.get_knowledge_base_by_id(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
path	object	Required within parent	Additional keys: not allowed
path.knowledgeBaseId	string	Required within parent

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 knowledge base by ID — response body

Referenced models: Get knowledge base by ID — response body

Schemas

Get knowledge base by ID — response body

Field	Type	Presence	Description and constraints
$	object	Root
data	JSON	Required within parent	Knowledge base details
data (allOf 1)	Model	All variants apply	Expand Get knowledge base by ID — response body — data created At, deleted, id, is Default, kb Metadata, location Id, name, name Lower Case, updated At
success	boolean	Required within parent	Success status of the operation

Referenced models: Get knowledge base by ID — response body — data created At, deleted, id, is Default, kb Metadata, location Id, name, name Lower Case, updated At

Get knowledge base by ID — response body — data created At, deleted, id, is Default, kb Metadata, location Id, name, name Lower Case, updated At

Field	Type	Presence	Description and constraints
$	object	Root
createdAt	string	Required within parent	Date when knowledge base was created
deleted	boolean	Required within parent	Whether the knowledge base is deleted
id	string	Required within parent	Knowledge base ID
isDefault	boolean	Optional	Whether the knowledge base is default or not
kbMetadata	JSON	Required within parent	Knowledge base metadata with content counts
kbMetadata (allOf 1)	Model	All variants apply	Expand Get knowledge base by ID — response body — data created At, deleted, id, is Default, kb Metadata, location Id, name, name Lower Case, updated At kb Metadata faqs, files, rich Text, tables, urls, web Searches
locationId	string	Required within parent	Location ID
name	string	Required within parent	Knowledge base name
nameLowerCase	string	Required within parent	Knowledge base name in lowercase
updatedAt	string	Required within parent	Date when knowledge base was last updated

Referenced models: Get knowledge base by ID — response body — data created At, deleted, id, is Default, kb Metadata, location Id, name, name Lower Case, updated At kb Metadata faqs, files, rich Text, tables, urls, web Searches

Get knowledge base by ID — response body — data created At, deleted, id, is Default, kb Metadata, location Id, name, name Lower Case, updated At kb Metadata faqs, files, rich Text, tables, urls, web Searches

Field	Type	Presence	Description and constraints
$	object	Root
faqs	JSON	Required within parent
faqs (anyOf 1)	number	Alternative	Number of FAQs in the knowledge base
faqs (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
files	JSON	Required within parent
files (anyOf 1)	number	Alternative	Number of files in the knowledge base
files (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
richText	JSON	Required within parent
richText (anyOf 1)	number	Alternative	Number of rich text documents in the knowledge base
richText (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
tables	JSON	Required within parent
tables (anyOf 1)	number	Alternative	Number of tables in the knowledge base
tables (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
urls	JSON	Required within parent
urls (anyOf 1)	number	Alternative	Number of URLs in the knowledge base
urls (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
webSearches	JSON	Required within parent
webSearches (anyOf 1)	number	Alternative	Number of web searche configs in the knowledge base
webSearches (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Policy, approvals and errors

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