HighLevel: Get all trained page links by knowledge base

← Knowledge base operations · Get started

Operation gohighlevel.getallwebsiteurlsdatabyknowledgebase

Provider route: GET /knowledge-bases/crawler. 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"]["getAllWebsiteUrlsDataByKnowledgeBase"]>[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.getAllWebsiteUrlsDataByKnowledgeBase(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_all_website_urls_data_by_knowledge_base(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.page	number	Optional
query.pageLength	number	Optional
query.query	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 trained page links by knowledge base — response body

Referenced models: Get all trained page links by knowledge base — response body

Schemas

Get all trained page links by knowledge base — response body

Field	Type	Presence	Description and constraints
$	object	Root
count	JSON	Required within parent
count (anyOf 1)	number	Alternative	Total count of URLs in the knowledge base
count (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
urls	array	Required within parent	Array of crawled URLs with their details
urls[]	Model	Each item	Expand Get all trained page links by knowledge base — response body — urls item

Referenced models: Get all trained page links by knowledge base — response body — urls item

Get all trained page links by knowledge base — response body — urls item

Field	Type	Presence	Description and constraints
$	object	Root
content	string	Required within parent	URL to the stored content file
contentEditedByUser	boolean	Required within parent	Whether the content was edited by user
id	string	Required within parent	Unique identifier for the URL
knowledgeBaseId	string	Required within parent	Knowledge base ID this URL belongs to
locationId	string	Required within parent	Location ID associated with this URL
status	string	Required within parent	Current processing status of the URL Known values: Pending, Processing, Successful, Failed, Existing, Restricted, Cancelled, Aborted, Training
title	string	Required within parent	Title of the webpage
updatedAt	string	Required within parent	Last updated timestamp
url	string	Required within parent	The actual URL that was crawled

Policy, approvals and errors

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