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 Custom Provider API

Documentation for payments API

HighLevel Custom Provider 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 Custom Provider. The published artifact set on APIs.io includes an OpenAPI specification and 60 JSON Schemas.

This API exposes 6 operations across 4 paths, and defines 11 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.

6 operations 4 paths 11 schemas 1 DELETE1 GET3 POST1 PUT

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, HTTP Bearer, HTTP Bearer
Resource Areas
1

Authentication & Security 5

HighLevel Custom Provider API declares 5 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) (Location-Access-Only). It accepts HTTP bearer tokens (JWT) (Agency-Access). It accepts HTTP bearer tokens (JWT) (Agency-Access-Only).

  • 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.
  • Location-Access-Only — Use the Access Token generated with user type as Sub-Account.
  • Agency-Access — Use the Access Token generated with user type as Agency (OR) Private Integration Token of Agency.
  • Agency-Access-Only — Use the Access Token generated with user type as Agency.

Paths & Operations 6

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

Custom Provider 6

Documentation for payments API

POST
/payments/custom-provider/provider
Create new integration
create-integration 2 params body → 200400401422
DELETE
/payments/custom-provider/provider
Deleting an existing integration
delete-integration 2 params → 200400401422
GET
/payments/custom-provider/connect
Fetch given provider config
fetch-config 2 params → 200400401422
POST
/payments/custom-provider/connect
Create new provider config
create-config 2 params body → 200400401422
POST
/payments/custom-provider/disconnect
Disconnect existing provider config
disconnect-config 2 params body → 200400401422
PUT
/payments/custom-provider/capabilities
Custom-provider marketplace app update capabilities
custom-provider-marketplace-app-update-capabilities 1 param body → 200400401422

Schemas 11

The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are GetCustomProvidersResponseSchema (13 properties), CreateCustomProvidersResponseSchema (13 properties), ConnectCustomProvidersResponseSchema (13 properties), CreateCustomProvidersDto (6 properties). Each schema is shown below with its type and property counts.

UpdateCustomProviderCapabilitiesResponseSchema
object
1 property 1 required
UpdateCustomProviderCapabilitiesDto
object
3 properties 1 required
ConnectCustomProvidersConfigDto
object
2 properties 2 required
GetCustomProvidersResponseSchema
object
13 properties 11 required
DeleteCustomProvidersResponseSchema
object
1 property 1 required
ConnectCustomProvidersResponseSchema
object
13 properties 11 required
CreateCustomProvidersResponseSchema
object
13 properties 11 required
CreateCustomProvidersDto
object
6 properties 6 required
DeleteCustomProvidersConfigDto
object
1 property 1 required
CustomProviderKeys
object
2 properties 2 required
DisconnectCustomProvidersResponseSchema
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

highlevel-custom-provider-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 Custom Provider 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.