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

Documentation for Contacts API

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

This API exposes 8 operations across 7 paths, and defines 22 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.

8 operations 7 paths 22 schemas 5 GET3 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, HTTP Bearer, HTTP Bearer
Resource Areas
1

Authentication & Security 5

HighLevel Search 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 8

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

Search 8

Documentation for Contacts API

POST
/contacts/search
Search Contacts
search-contacts-advanced 1 param body → 200400401
GET
/contacts/search/duplicate
Get Duplicate Contact
get-duplicate-contact 4 params → 200400401
GET
/conversations/search
Search Conversations
search-conversation 22 params → 200400401
GET
/locations/search
Search
search-locations 6 params → 200400401422
GET
/opportunities/search
Search Opportunity
search-opportunity 21 params → 200400401422
POST
/opportunities/search
Search Opportunities
search-opportunities-advanced 1 param body → 200400401422
GET
/users/search
Search Users
search-users 12 params → 200400401422
POST
/users/search/filter-by-email
Filter Users by Email
filter-users-by-email 1 param body → 200400401422

Schemas 22

The contract defines 22 schemas that model the data the API accepts and returns. The most detailed are PermissionsDto (38 properties), SearchOpportunitiesResponseSchema (24 properties), GetLocationSchema (13 properties), UserSchema (13 properties). Each schema is shown below with its type and property counts.

SearchBodyV2DTO
object
SendConversationResponseDto
object
2 properties 2 required
StartAfterNumberSchema
object
1 property
ConversationSchema
object
11 properties 11 required
StartAfterArrayNumberSchema
object
1 property
GetLocationSchema
object
13 properties
SearchSuccessfulResponseDto
object
1 property
SocialSchema
object
11 properties
SettingsSchema
object
4 properties
OpportunitySearchBodyDTO
object
6 properties 6 required
SearchOpportunitiesResponseSchema
object
24 properties
SearchSuccessfulResponseDto_2
object
3 properties
SearchOpportunitiesContactResponseSchema
object
6 properties
CustomFieldResponseSchema
object
2 properties 2 required
PostSearchSuccessfulResponseDto
object
3 properties 1 required
SearchMetaResponseSchema
object
7 properties
AdditionalDetailsDTO
object
4 properties 4 required
RoleSchema
object
4 properties
UserSchema
object
13 properties
PermissionsDto
object
38 properties
FilterByEmailDto
object
6 properties 2 required
SearchUserSuccessfulResponseDto
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

highlevel-search-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 Search 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.