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

Documentation for Sub-Account (Formerly location) API

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

This API exposes 6 operations across 3 paths, and defines 9 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 3 paths 9 schemas 1 DELETE2 GET2 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
Resource Areas
1

Authentication & Security 4

HighLevel Custom Field API declares 4 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).

  • 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.

Paths & Operations 6

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

Custom Field 6

Documentation for Sub-Account (Formerly location) API

GET
/locations/{locationId}/customFields
Get Custom Fields
get-custom-fields 3 params → 200400401422
POST
/locations/{locationId}/customFields
Create Custom Field
create-custom-field 2 params body → 201400401422
GET
/locations/{locationId}/customFields/{id}
Get Custom Field
get-custom-field 3 params → 200400401422
PUT
/locations/{locationId}/customFields/{id}
Update Custom Field
update-custom-field 3 params body → 200400401422
DELETE
/locations/{locationId}/customFields/{id}
Delete Custom Field
delete-custom-field 3 params → 200400401422
POST
/locations/{locationId}/customFields/upload
Uploads File to customFields
upload-file-customFields 2 params body → 200400401422

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are CustomFieldSchema (13 properties), CreateCustomFieldsDTO (9 properties), UpdateCustomFieldsDTO (8 properties), FileUploadBody (2 properties). Each schema is shown below with its type and property counts.

textBoxListOptionsSchema
object
2 properties
CreateCustomFieldsDTO
object
9 properties 2 required
CustomFieldsListSuccessfulResponseDto
object
1 property
CustomFieldSchema
object
13 properties
UpdateCustomFieldsDTO
object
8 properties 1 required
FileUploadResponseDto
object
2 properties
CustomFieldDeleteSuccessfulResponseDto
object
1 property
CustomFieldSuccessfulResponseDto
object
1 property
FileUploadBody
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

highlevel-custom-field-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 Field 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.