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

Documentation for AI Employees API

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

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

10 operations 6 paths 36 schemas 2 DELETE3 GET1 PATCH2 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 Actions 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 10

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

Actions 10

Documentation for AI Employees API

POST
/conversation-ai/agents/{agentId}/actions
Attach Action to Agent
create-action 2 params body → 201400401422
GET
/conversation-ai/agents/{agentId}/actions/list
List Actions for an Agent
list-actions 2 params → 200400401422
GET
/conversation-ai/agents/{agentId}/actions/{actionId}
Get Action by ID
get-action-by-id 3 params → 200400401422
PUT
/conversation-ai/agents/{agentId}/actions/{actionId}
Update Action
update-action 3 params body → 200400401422
DELETE
/conversation-ai/agents/{agentId}/actions/{actionId}
Remove Action from Agent
delete-action 3 params → 200400401422
PATCH
/conversation-ai/agents/{agentId}/followup-settings
Update Followup Settings
update-followup-settings 2 params body → 200400401422
POST
/voice-ai/actions
Create Agent Action
postVoiceAiActions 1 param body → 201400401422
PUT
/voice-ai/actions/{actionId}
Update Agent Action
putVoiceAiActionsByActionId 2 params body → 200400401422
GET
/voice-ai/actions/{actionId}
Get Agent Action
get-action 3 params → 200400401422
DELETE
/voice-ai/actions/{actionId}
Delete Agent Action
deleteVoiceAiActionsByActionId 4 params → 204400401422

Schemas 36

The contract defines 36 schemas that model the data the API accepts and returns. The most detailed are appointmentBookingDto (12 properties), humanHandOverDto (12 properties), stopBotDto (9 properties), FollowupSequence (8 properties). Each schema is shown below with its type and property counts.

Interval
object
4 properties 4 required
CreateActionDTO
object
3 properties 3 required
FollowupSequence
object
8 properties 3 required
WorkingHours
object
2 properties 1 required
humanHandOverDto
object
12 properties 5 required
appointmentBookingDto
object
12 properties 7 required
triggerWorkflowDto
object
3 properties 2 required
fetchActionsForEmployeeResponseDTO
object
2 properties 2 required
updateActionResponseDTO
object
2 properties 2 required
fetchActionDetailsResponseDTO
object
2 properties 2 required
transferBotDto
object
5 properties 3 required
deleteActionResponseDTO
object
2 properties 2 required
UpdateFollowupSettingsDTO
object
2 properties 2 required
ActionDataDTO
object
5 properties 4 required
createActionResponseDTO
object
2 properties 2 required
stopBotDto
object
9 properties 6 required
FollowupSettings
object
4 properties 1 required
updateContactFieldDto
object
3 properties 2 required
advancedFollowupDto
object
4 properties 3 required
DeleteActionDataDTO
object
1 property 1 required
InCallDataExtractionActionParameters
object
4 properties 3 required
UpdateSingleActionDTO
object
5 properties 5 required
CustomActionParameterDTO
object
4 properties 1 required
CustomActionApiDetailsDTO
object
6 properties 2 required
WorkflowTriggerParameters
object
3 properties 3 required
CustomActionParameters
object
4 properties 3 required
GetActionResponseDTO
object
4 properties 4 required
AppointmentBookingActionParameters
object
4 properties 4 required
KnowledgeBaseParameters
object
2 properties 2 required
CallTransferActionParameters
object
5 properties 4 required
CustomActionHeaderDTO
object
2 properties 2 required
CreateSingleActionDTO
object
5 properties 5 required
UpdateActionResponseDTO
object
4 properties 4 required
SMSParameters
object
3 properties 3 required
CreateActionResponseDTO
object
4 properties 4 required
DataExtractionActionParameters
object
4 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

highlevel-actions-api-openapi.yml Raw ↑

Other APIs HighLevel publishes across the network.

HighLevel Account 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
HighLevel Bulk API
Where this information came from

This is an independent, third-party profile of HighLevel Actions 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.