> ## Documentation Index
> Fetch the complete documentation index at: https://docs.neoagent.io/llms.txt
> Use this file to discover all available pages before exploring further.

# HighLevel API

> Read and update your HighLevel CRM in an agent: contacts, businesses, opportunities, and hot leads copied into your PSA

The agent connects with a HighLevel Private Integration token made in your sub-account, and each call is limited by the token's scopes and by the permission groups below.

> [!NOTE]
>
> Automatically enabled when you configure HighLevel permissions in your agent workflow.

## What it does

* Search contacts by any field, custom fields included, and read a contact, its business, notes, tasks and opportunities
* Copy each lead you mark as hot into your PSA once: the agent finds the contacts whose ready field holds your value and whose synced field is empty, finds or creates the PSA company and contact, and writes the PSA ids into the synced field
* Create and update contacts, businesses and opportunities, and log notes and tasks
* Reach the rest of HighLevel's API (conversations, calendars, invoices and payments, custom objects, marketing, workflows, AI agents, the sub-account) as the permission groups allow. Safety Controls below lists what Neo refuses and what always asks

## Permission groups

| Group | Covers |
| - | - |
| Contacts | Contacts, their custom field values, tags and followers |
| Businesses | The businesses your contacts belong to |
| Opportunities & Pipelines | Opportunities, pipelines and stages, lost reasons and followers |
| Notes & Tasks | Notes and tasks on contacts, the task search and recurring tasks |
| Conversations & Messages | Conversations, SMS, email and chat messages, recordings, transcriptions and message templates |
| Calendars & Appointments | Calendars, appointments and their notes, free slots, blocked slots, groups, services and schedules |
| Invoices, Payments & Products | Invoices, estimates, schedules, orders, transactions, subscriptions, coupons, products, the store, documents and contracts |
| Custom Object Records | Records of custom objects and the relations between records |
| Custom Fields, Tags & Schemas | Custom fields and folders, custom values, tags, custom object schemas and association types |
| Marketing, Social & Ads | Email campaigns and templates, social planner, ads, funnels, forms, surveys, trigger links, blogs, media, chat widgets and affiliates |
| Workflows, Campaigns & AI Agents | Workflows and campaigns a contact is in, Conversation AI and Voice AI agents, Agent Studio and knowledge bases |
| Sub-Account, Users & Billing | The sub-account and its settings, users, phone numbers, snapshots, and the agency's SaaS and wallet |
| Apps & Connected Accounts | Installed apps and app billing, custom menu links, payment providers, and connected ad and social accounts |

Each group can be Disabled, Read Only or Read / Write.

| Profile | What it does |
| - | - |
| Read Only | Reads every group, changes nothing |
| Helpdesk | Logs notes and tasks on its own. Changes to contacts, businesses, opportunities, messages and appointments ask a technician first. Every other group is read only |
| IT Admin | Changes on its own, except payments, marketing, automation, the sub-account and apps, which ask a technician first, and the changes Safety Controls lists |
| Full Automation | Every change with no approval, except those Safety Controls lists |

## Safety Controls

These always ask a technician, whatever the profile:

* Every change to users, to a sub-account's permissions, and creating a sub-account
* Every SaaS, wallet and app billing change, buying a phone number, and turning on a schedule's automatic payment
* Creating a snapshot share link
* Deleting a business, a custom field or a custom field folder
* Creating or removing a relation between two records
* Changing a contact's subscription, and any change that turns a contact's do-not-disturb off
* Every change to apps and connected accounts, which connect your account to an outside service

Neo never calls HighLevel's OAuth token endpoints or its connection migration, because each mints or moves a credential, and never deletes a sub-account. Neo hides passwords and keys in what HighLevel returns, and refuses a change that would write the hidden value back.

## Setup

See [Connecting HighLevel to Neo](/integrations/highlevel/connecting-to-neo).


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.