How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

HighLevel Web Crawler API

Documentation for Knowledge Base API

HighLevel Web Crawler API is one of 117 APIs that HighLevel publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 60 JSON Schema definitions.

Tagged areas include Web Crawler. The published artifact set on APIs.io includes an OpenAPI specification and 60 JSON Schemas.

This API exposes 5 operations across 3 paths, and defines 19 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against a single base URL, https://services.leadconnectorhq.com.

5 operations 3 paths 19 schemas 1 DELETE2 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://api.gohighlevel.com
Authentication
HTTP Bearer, HTTP Bearer, HTTP Bearer
Resource Areas
1

Authentication & Security 3

HighLevel Web Crawler API declares 3 security schemes for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearer). It accepts HTTP bearer tokens (JWT) (Location-Access). It accepts HTTP bearer tokens (JWT) (Agency-Access).

  • bearer — Use the Access Token generated with user type as Sub-Account (OR) Private Integration Token of Sub-Account.
  • Location-Access — Use the Access Token generated with user type as Sub-Account (OR) Private Integration Token of Sub-Account.
  • Agency-Access — Use the Access Token generated with user type as Agency (OR) Private Integration Token of Agency.

Paths & Operations 5

Across 3 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Web Crawler 5

Documentation for Knowledge Base API

GET
/knowledge-bases/crawler
Get all trained page links by knowledge base
getAllWebsiteUrlsDataByKnowledgeBase 7 params → 200400401422500
POST
/knowledge-bases/crawler
Start crawling and discover pages for training
discoverWebsite 2 params body → 201400401422500
DELETE
/knowledge-bases/crawler
Delete trained pages
deleteTrainedUrlsForKnowledgeBase 2 params body → 200400401422500
GET
/knowledge-bases/crawler/status
Get crawling status for the latest operation
getCrawlingStatusForLatestOperation 5 params → 200400401422500
POST
/knowledge-bases/crawler/train
Train discovered website pages and ingest into the knowledge base
trainDiscoveredUrls 2 params body → 201400401422500

Schemas 19

The contract defines 19 schemas that model the data the API accepts and returns. The most detailed are OperationDetailsDTO (12 properties), CrawledUrlDTO (9 properties), ErrorDetailsDTO (6 properties), CrawlingRecordDTO (4 properties). Each schema is shown below with its type and property counts.

CrawlingStatusResponseDTO
object
2 properties 2 required
DiscoverWebsiteDataDTO
object
3 properties 3 required
UnprocessableDTO
object
3 properties
DeleteWebsiteUrlRequestDTO
object
3 properties 3 required
InternalServerErrorDTO
object
2 properties
CrawlingAggregateDTO
object
2 properties 2 required
TrainDiscoveredUrlsDTO
object
4 properties 4 required
CrawledUrlDTO
object
9 properties 9 required
ErrorDetailsDTO
object
6 properties 5 required
TrainDiscoveredUrlsResponseDTO
object
1 property 1 required
GetAllUrlsByKnowledgeBaseResponseDTO
object
2 properties 2 required
DeleteWebsiteUrlResponseDTO
object
1 property 1 required
UnauthorizedDTO
object
3 properties
OperationDetailsDTO
object
12 properties 11 required
BadRequestDTO
object
2 properties
CrawlingStatusDataDTO
object
2 properties 2 required
CrawlingRecordDTO
object
4 properties 2 required
DiscoverWebsiteRequestDTO
object
4 properties 4 required
DiscoverWebsiteResponseDTO
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

highlevel-web-crawler-api-openapi.yml Raw ↑

Other APIs HighLevel publishes across the network.

HighLevel Account API
HighLevel Actions API
HighLevel Affiliates API
HighLevel Agents API
HighLevel App Billing Management API
HighLevel App Management API
HighLevel Appointment Notes API
HighLevel Appointments API
HighLevel Associations API
HighLevel Availability API
HighLevel Blogs API
HighLevel Brand Boards API
Where this information came from

This is an independent, third-party profile of HighLevel Web Crawler API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.