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 Opportunities API

Documentation for Opportunities API

HighLevel Opportunities 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 Opportunities. 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 13 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 13 schemas 1 DELETE1 GET2 POST2 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 Opportunities 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, 2 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Opportunities 6

Documentation for Opportunities API

GET
/opportunities/{id}
Get Opportunity
get-opportunity 2 params → 200400401422
DELETE
/opportunities/{id}
Delete Opportunity
delete-opportunity 2 params → 200400401422
PUT
/opportunities/{id}
Update Opportunity
update-opportunity 2 params body → 200400401422
PUT
/opportunities/{id}/status
Update Opportunity Status
update-opportunity-status 2 params body → 200400401422
POST
/opportunities/upsert
Upsert Opportunity
Upsert-opportunity 1 param body → 200400401422
POST
/opportunities/
Create Opportunity
create-opportunity 1 param body → 201400401422

Schemas 13

The contract defines 13 schemas that model the data the API accepts and returns. The most detailed are SearchOpportunitiesResponseSchema (24 properties), UpsertOpportunityDto (12 properties), CreateDto (9 properties), UpdateOpportunityDto (7 properties). Each schema is shown below with its type and property counts.

customFieldsInputStringSchema
object
3 properties
UpsertOpportunitySuccessfulResponseDto
object
2 properties 2 required
customFieldsInputObjectSchema
object
3 properties 1 required
SearchOpportunitiesResponseSchema
object
24 properties
UpdateOpportunityDto
object
7 properties
SearchOpportunitiesContactResponseSchema
object
6 properties
GetPostOpportunitySuccessfulResponseDto
object
1 property
CustomFieldResponseSchema
object
2 properties 2 required
DeleteUpdateOpportunitySuccessfulResponseDto
object
1 property
customFieldsInputArraySchema
object
3 properties 1 required
CreateDto
object
9 properties 5 required
UpdateStatusDto
object
2 properties 1 required
UpsertOpportunityDto
object
12 properties 5 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

highlevel-opportunities-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 Opportunities 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.