Skip to main content
HighLevel Agency logo
  • Category: crm
  • Auth: OAUTH2
  • Composio-managed OAuth available? No
  • Tools: 16
  • Triggers: 0
  • Slug: HIGHLEVEL_AGENCY
  • Version: 20261101_00

Tools

Slug: HIGHLEVEL_AGENCY_CREATE_CUSTOM_MENUCreate an agency-only custom menu link that is never shown in sub-accounts.

Input Parameters

string
required
Destination URL opened by the menu.
object
required
Font Awesome icon displayed for the menu.
string
required
Menu title shown to agency users.
string ("iframe" | "new_tab" | "current_tab")
required
How HighLevel opens the menu destination.
string ("all" | "admin" | "user")
Agency user role allowed to see the menu.
boolean
Whether an iframe menu may use the camera.
boolean
Whether an iframe menu may use the microphone.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_AGENCY_DELETE_CUSTOM_MENUPermanently delete one agency custom menu link by its ID. A newly created menu may take a few seconds to become deletable; retry after a short delay if HighLevel initially reports that its ID does not exist.

Input Parameters

string
required
Unique ID of the agency custom menu link to permanently delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_AGENCY_DELETE_USERRequest permanent deletion of an agency user by ID; HighLevel does not allow the agency owner to be deleted. A queued confirmation indicates the request was queued, not that deletion has completed.

Input Parameters

string
required
Unique ID of the agency user to permanently delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_AGENCY_FIND_USERS_BY_EMAILReturn one page of agency users matching an exact batch of email addresses, including deleted users when requested, for a HighLevel agency/company ID, never a location ID.

Input Parameters

integer
Maximum matching users to return in this page; the provider exposes no documented maximum.
string
Opaque continuation cursor returned by a previous call.
array
Email addresses to match exactly on the first call; omit when continuing with cursor. Accepts an array, JSON array string, CSV string, or one email address.
boolean
Whether to return deleted users instead of active users.
string
required
Agency/company ID from HighLevel; never a location ID.
string
Comma-separated response fields, or ‘all’; omit to return only ID and email.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_AGENCY_GET_COMPANYReturn a HighLevel agency’s company profile and plan summary using its agency/company ID, never a location ID.

Input Parameters

string
required
Agency/company ID from HighLevel; never a location ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_AGENCY_GET_CUSTOM_MENUReturn one agency custom menu link by its ID.

Input Parameters

string
required
Unique ID of the agency custom menu link to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_AGENCY_GET_INSTALLER_DETAILSReturn agency, installer, and Marketplace plan details for this OAuth installation using the Marketplace OAuth App ID stored in the auth config.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_AGENCY_GET_LATEST_SNAPSHOT_PUSH_BY_LOCATIONReturn the latest push status and asset progress for an agency snapshot at one target HighLevel sub-account. location_id selects the sub-account for reporting and is not a Location OAuth credential; the connection remains Agency OAuth.

Input Parameters

string
required
Agency/company ID from HighLevel; never a location ID.
string
required
Target HighLevel sub-account location ID for snapshot push reporting; this identifies the reported sub-account and is not a Location OAuth credential.
string
required
Agency snapshot ID whose latest push status should be reported.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_AGENCY_GET_USERReturn one agency user’s profile, role, permissions, and scopes by user ID.

Input Parameters

string
required
Agency user ID returned by SEARCH_USERS or FIND_USERS_BY_EMAIL.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_AGENCY_LIST_CUSTOM_MENUSReturn one page of agency-visible custom menu links, optionally filtered by title text.

Input Parameters

integer
Maximum custom menus to return in this page.
string
Partial or full custom-menu title to match.
string
Opaque continuation cursor returned by a previous call; omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_AGENCY_LIST_SNAPSHOT_PUSHESReturn one page of sub-account push statuses for an agency snapshot within an ISO 8601 date range. Continue manually by passing a returned record ID as last_doc. The company_id is a HighLevel agency/company ID, never a location ID.

Input Parameters

integer
Maximum push records to return; the provider documents a default of 20.
string
required
Inclusive end of the status window as YYYY-MM-DD or an ISO 8601 timestamp with timezone.
string
Provider document ID after which results begin. Omit or pass an empty string for the first page.
string
required
Inclusive start of the status window as YYYY-MM-DD or an ISO 8601 timestamp with timezone.
string
required
Agency/company ID from HighLevel; never a location ID.
string
required
Agency snapshot ID whose push statuses should be listed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_AGENCY_LIST_SNAPSHOTSReturn all owned and imported snapshots for a HighLevel agency/company ID, never a location ID.

Input Parameters

string
required
Agency/company ID from HighLevel; never a location ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_AGENCY_SEARCH_USERSReturn one page of agency users matching name, email, phone, role, IDs, or sync filters for a HighLevel agency/company ID, never a location ID.

Input Parameters

string ("admin" | "user")
Agency role to match.
string
Sort by date added; omit for the default name order.
integer
Maximum users to return in this page.
string
Text matched against user full name, email, or phone.
string
Opaque continuation cursor returned by a previous call; omit for the first page.
string
Comma-separated agency user IDs to include.
string
required
Agency/company ID from HighLevel; never a location ID.
string ("asc" | "desc")
Sort in ascending or descending order; omit for the provider default.
boolean
Filter by whether two-way sync is enabled.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_AGENCY_UPDATE_CUSTOM_MENUUpdate selected fields of an agency custom menu by ID. The update sets agency visibility on and disables sub-account visibility, clearing the location list.

Input Parameters

string
New destination URL; omit to preserve the current URL.
object
New Font Awesome icon; omit to preserve the current icon.
string
New menu title; omit to preserve the current title.
string ("iframe" | "new_tab" | "current_tab")
How HighLevel opens the menu destination; omit to preserve it.
string ("all" | "admin" | "user")
Agency user role allowed to see the menu; omit to preserve it.
boolean
Whether an iframe menu may use the camera; omit to preserve it.
string
required
Unique ID of the agency custom menu link to update.
boolean
Whether an iframe menu may use the microphone; omit to preserve it.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIGHLEVEL_AGENCY_UPDATE_USER_PROFILEUpdate an agency user’s name, phone, profile photo, or language without changing company, location access, permissions, scopes, email, or password. HighLevel does not allow the agency owner’s profile to be modified. The company_id is a HighLevel agency/company ID, never a location ID.

Input Parameters

string
New E.164 phone number; omit to leave unchanged.
string
required
Agency user ID to update.
string
New last name; omit to leave unchanged.
string
required
Agency/company ID from HighLevel; never a location ID.
string
New first name; omit to leave unchanged.
string
New profile photo URL; omit to leave unchanged.
string ("en_US" | "es" | "fr_CA" | "fr_FR" | "nl" | "de" | "pt_PT" | "pt_BR" | "it" | "sv" | "da" | "fi" | "no")
New HighLevel interface language; omit to leave unchanged.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not