@aiwerk/mcp-server-ghl
Click on "Deploy Server".
Wait a few minutes for the server to deploy. Once ready, it will show a "Started" state.
In the chat, type
@followed by the MCP server name and your instructions, e.g., "@@aiwerk/mcp-server-ghl List opportunities won this month and their total value"
That's it! The server will respond to your query, and you can continue using it as needed.
Here is a step-by-step guide with screenshots.
@aiwerk/mcp-server-ghl
MCP server for the GoHighLevel (GHL) API, the CRM and marketing automation platform used by agencies to run their clients' sales pipelines, calendars, conversations and campaigns.
569 tools across 41 domains, generated from GHL's official OpenAPI 3.0.0 specification.
Contacts Opportunities Conversations Calendars Invoices
Payments Workflows Campaigns Forms Surveys
Funnels Blogs Courses Products Store
Social Media Ad Manager SaaS API Snapshots Custom FieldsWhy generated
Every endpoint, HTTP verb, parameter and field name comes from the official specification rather than from prose documentation, so the tool surface can't drift from what GHL actually accepts. What the specification can't tell you, which endpoints need an agency-level token instead of a location one, which API version an endpoint expects, which fields the docs forgot to mark required, is layered on top by hand. See GHL specifics worth knowing.
Related MCP server: GoHighLevel (GHL) MCP Server
Install
npm install -g @aiwerk/mcp-server-ghlRequires Node.js 18 or newer.
Authentication
Create a Private Integration Token (PIT) in the target location under Settings > Private Integrations. A PIT is scoped to one location, it is not an agency-wide credential, and most tools need to know which location they're acting on.
export GHL_PIT_TOKEN="your-private-integration-token"
export GHL_LOCATION_ID="your-location-id"Usage
Claude Code
claude mcp add ghl \
--env GHL_PIT_TOKEN=your-token \
--env GHL_LOCATION_ID=your-location-id \
-- npx -y @aiwerk/mcp-server-ghlClaude Desktop
{
"mcpServers": {
"ghl": {
"command": "npx",
"args": ["-y", "@aiwerk/mcp-server-ghl"],
"env": {
"GHL_PIT_TOKEN": "your-token",
"GHL_LOCATION_ID": "your-location-id"
}
}
}
}AIWerk hosted service
Install it from the catalogue at aiwerkmcp.com and add your token in the interface. No local setup required.
Safety features
Dry run
export GHL_DRY_RUN=1Every write (POST/PUT/PATCH/DELETE) is stopped before it reaches GHL and
returns a description of the request that would have been sent. Reads still work
normally.
Agency-only endpoints get a clear error, not a bare 401
39 endpoints (snapshots, the SaaS API, agency OAuth token exchange, creating custom
objects) require an agency-level token. A location PIT gets a plain 401 from GHL for
these with no explanation in the body, the server knows which endpoints these are and
returns a message saying so, instead of making it look like a bad or expired token.
locationId is filled in automatically
A PIT is already scoped to one location, so 430 of the 569 tools accept locationId
(or altId/altType) as an optional parameter, if the calling agent doesn't supply
one, the server falls back to GHL_LOCATION_ID. This also means a tool call can't
accidentally target the wrong location by a copy-pasted id from a different account,
since the default always matches the token's own scope.
Configuration
Variable | Default | Purpose |
| required | Private Integration Token |
| required | Location the PIT is scoped to; default for |
|
| Override the host |
|
| Per request timeout |
| off |
|
|
| Longest wait before failing on a rate limit |
| all | Comma separated domain filter, for example |
Narrowing the tool set
All 569 tools are registered by default. A client that prefers a smaller surface can
restrict the server to specific domains (domain names are hyphenated, e.g.
social-media-posting, ad-manager):
export GHL_ENABLED_TAGS="contacts,opportunities,conversations,calendars"Unknown domain names are reported on startup rather than silently ignored.
A few GHL specifics worth knowing
The API version differs per endpoint, not globally. GHL sends a
Versionrequest header (2021-07-28or2021-04-15) that the server sets per call based on what each endpoint actually expects, a wrong version returns a different response shape silently, not an error, so there's no single default to fall back on. 29 endpoints send no version header at all; the server matches that too.A location PIT cannot call agency-only endpoints, ever, no scope fixes it.
snapshots/*,saas-api/*,oauth/locationToken,oauth/installedLocations, and creating custom objects (POST /objects) need an agency-level credential.11 endpoints in the official spec omit a path parameter's declaration (e.g. a
noteIdon some calendar/conversation routes, apostIdon blogs, atypeon contacts). The generator fills these in as required string fields since the parameter is clearly used in the path template, this is an upstream spec gap, not something introduced here.Rate limits have not yet been measured against a live account. The client retries on
429using whateverRetry-AfterGHL sends, but does not pre-emptively throttle with an invented number, an assumed limit that's wrong would either under-use the account or start failing calls that would have succeeded.
Testing
npm test # unit tests, mocked fetch
npm run smoke # read only, against a live accountDevelopment
The tool layer is generated and must not be edited by hand:
npm run gen-naming # specification -> tool names
npm run gen-tools # specification -> zod schemas and call sites
npm run buildLicence
MIT, see LICENSE.
Built by AIWerk. Not affiliated with GoHighLevel / HighLevel Inc.
Available Tools
569 toolsad_manager_fb_add_custom_audience_memberCIdempotent
Add custom audience member
Inputs: contactId (required), audienceId (required), locationId, fbAdAccountId.
ad_manager_fb_batch_update_audience_membersBIdempotent
Batch update audience members
Inputs: audienceId (required), operationType (required), csvPath, locationId, +2 more.
ad_manager_fb_create_conversation_formD
Create conversation form
Inputs: name (required), text (required), questions (required), locationId.
ad_manager_fb_create_integrationC
Create Facebook integration
Inputs: pageId (required), locationId, adAccountId.
ad_manager_fb_create_page_lead_formC
Create page lead form
Inputs: name (required), type (required), pageId (required), questions (required), +7 more.
ad_manager_fb_delete_adDDestructiveIdempotent
Delete ad
Inputs: adId (required), locationId.
ad_manager_fb_delete_ad_accountCDestructiveIdempotent
Delete ad account
Inputs: adAccountId (required), locationId.
ad_manager_fb_delete_adsetCDestructiveIdempotent
Delete ad set
Inputs: adsetId (required), locationId.
ad_manager_fb_delete_campaignCDestructiveIdempotent
Delete campaign
Inputs: campaignId (required), locationId.
ad_manager_fb_delete_custom_audienceBDestructiveIdempotent
Delete custom audience
Inputs: audienceId (required), locationId.
ad_manager_fb_delete_integrationBDestructiveIdempotent
Delete Facebook integration
Inputs: locationId.
ad_manager_fb_delete_pageCDestructiveIdempotent
Delete page connection
Inputs: pageId (required), locationId.
ad_manager_fb_duplicate_adD
Duplicate ad
Inputs: adId (required).
ad_manager_fb_duplicate_adsetC
Duplicate ad set
Inputs: adsetId (required).
ad_manager_fb_duplicate_campaignD
Duplicate campaign
Inputs: campaignId (required), locationId.
ad_manager_fb_get_ad_accountBRead-onlyIdempotent
Get ad account details
Inputs: adAccountId (required), locationId.
ad_manager_fb_get_ad_accountsCRead-onlyIdempotent
Get ad accounts
Inputs: next, type, limit, fetchAll, +1 more.
ad_manager_fb_get_campaignBRead-onlyIdempotent
Get campaign with linked entities
Inputs: campaignId (required), fields, source, locationId.
ad_manager_fb_get_campaign_reportingCRead-onlyIdempotent
Get campaign reporting
Inputs: endDate (required), startDate (required), campaignId (required), locationId.
ad_manager_fb_get_conversation_formsBRead-onlyIdempotent
Get conversation forms
Inputs: locationId.
ad_manager_fb_get_current_userBRead-onlyIdempotent
Get current Facebook user
Inputs: locationId.
ad_manager_fb_get_custom_audience_by_idCRead-onlyIdempotent
Get custom audience by ID
Inputs: audienceId (required), locationId.
ad_manager_fb_get_custom_audiencesDRead-onlyIdempotent
Get custom audiences
Inputs: type (required), adAccountId (required), source, locationId.
ad_manager_fb_get_entityDRead-onlyIdempotent
Get entities
Inputs: type (required), entityType (required), next, adSetId, +5 more.
ad_manager_fb_get_instagram_accountsCRead-onlyIdempotent
Get Instagram accounts for page
Inputs: pageId (required), type, locationId.
ad_manager_fb_get_integrationBRead-onlyIdempotent
Get Facebook integration
Inputs: locationId.
ad_manager_fb_get_lead_formBRead-onlyIdempotent
Get lead form by ID
Inputs: leadFormId (required), locationId.
ad_manager_fb_get_page_lead_formsBRead-onlyIdempotent
Get page lead forms
Inputs: pageId (required), locationId.
ad_manager_fb_get_pagesCRead-onlyIdempotent
Get Facebook pages
Inputs: locationId, fetchExisting.
ad_manager_fb_get_pixelsBRead-onlyIdempotent
Get conversion pixels
Inputs: pageId, channel, igUserId, locationId.
ad_manager_fb_get_reportingDRead-onlyIdempotent
Get reporting data
Inputs: type (required), fields (required), endDate (required), groupBy (required), +2 more.
ad_manager_fb_get_reporting_listDRead-onlyIdempotent
Get reporting list
Inputs: type (required), endDate (required), listType (required), startDate (required), +2 more.
ad_manager_fb_pause_adD
Pause ad
Inputs: adId (required), locationId.
ad_manager_fb_pause_adsetC
Pause ad set
Inputs: adsetId (required), locationId.
ad_manager_fb_pause_campaignC
Pause campaign
Inputs: campaignId (required), locationId.
ad_manager_fb_publish_campaignD
Publish campaign
Inputs: campaignId (required), locationId.
ad_manager_fb_remove_custom_audience_memberCDestructiveIdempotent
Remove custom audience member
Inputs: contactId (required), audienceId (required), locationId, fbAdAccountId.
ad_manager_fb_resume_adC
Resume ad
Inputs: adId (required), locationId.
ad_manager_fb_resume_adsetD
Resume ad set
Inputs: adsetId (required), locationId.
ad_manager_fb_resume_campaignD
Resume campaign
Inputs: campaignId (required), locationId.
ad_manager_fb_search_targetingCRead-onlyIdempotent
Search targeting options
Inputs: type (required), query (required), searchType.
ad_manager_fb_set_default_pageCIdempotent
Set default page
Inputs: pageId (required), locationId.
ad_manager_fb_update_custom_audienceBIdempotent
Update custom audience
Inputs: name (required), audienceId (required), description (required), locationId.
ad_manager_fb_upsert_adDIdempotent
Upsert ad
Inputs: adsetId (required), campaignId (required), id, cta, +12 more.
ad_manager_fb_upsert_adsetCIdempotent
Upsert adset
Inputs: campaignId (required), id, name, budget, +9 more.
ad_manager_fb_upsert_campaignCIdempotent
Upsert campaign
Inputs: id, name, source, objective, +2 more.
ad_manager_fb_upsert_pixelCIdempotent
Upsert conversion pixel
Inputs: type (required), name, igUserId, locationId, +1 more.
ad_manager_google_create_integrationC
Create Google integration
Inputs: mccId (required), adAccountId (required), locationId.
ad_manager_google_create_offline_user_list_jobD
Create offline user list job
Inputs: csvPath, isDynamic, locationId, userListId, +1 more.
ad_manager_google_delete_ad_accountCDestructiveIdempotent
Delete ad account
Inputs: adAccountId (required), locationId.
ad_manager_google_delete_conversionCDestructiveIdempotent
Delete conversion
Inputs: conversionId (required), locationId.
ad_manager_google_delete_segmentCDestructiveIdempotent
Delete segment
Inputs: type (required), segmentId (required), locationId.
ad_manager_google_get_ad_account_detailsCRead-onlyIdempotent
Get ad account details
Inputs: adAccountId (required), locationId.
ad_manager_google_get_ad_accountsCRead-onlyIdempotent
Get Google ad accounts
Inputs: type, locationId.
ad_manager_google_get_assetsCRead-onlyIdempotent
Get assets
Inputs: type (required), id, locationId, advertiserOnly.
ad_manager_google_get_audience_by_idCRead-onlyIdempotent
Get audience by ID
Inputs: audienceId (required), locationId.
ad_manager_google_get_audiencesDRead-onlyIdempotent
Get audiences
Inputs: locationId.
ad_manager_google_get_campaign_by_idCRead-onlyIdempotent
Get Google campaign by ID
Inputs: adId (required), locationId.
ad_manager_google_get_campaign_reportingDRead-onlyIdempotent
Get campaign reporting
Inputs: endDate (required), startDate (required), campaignId (required), locationId.
ad_manager_google_get_conversion_by_idBRead-onlyIdempotent
Get conversion by ID
Inputs: conversionId (required), locationId.
ad_manager_google_get_conversion_goalsCRead-onlyIdempotent
Get conversion goals
Inputs: locationId.
ad_manager_google_get_conversionsDRead-onlyIdempotent
Get conversions
Inputs: type, endDate, category, startDate, +2 more.
ad_manager_google_get_current_userCRead-onlyIdempotent
Get current Google user
Inputs: locationId.
ad_manager_google_get_entityDRead-onlyIdempotent
Get entities
Inputs: type (required), entityType (required), endDate, searchId, +5 more.
ad_manager_google_get_integrationCRead-onlyIdempotent
Get Google integration
Inputs: locationId.
ad_manager_google_get_keyword_ideasCRead-only
Get keyword ideas
Inputs: url (required), keywords, locations, locationId, +1 more.
ad_manager_google_get_reportingCRead-onlyIdempotent
Get reporting data
Inputs: type (required), fields (required), endDate (required), startDate (required), +2 more.
ad_manager_google_get_reporting_listDRead-onlyIdempotent
Get reporting list
Inputs: type (required), endDate (required), listType (required), startDate (required), +2 more.
ad_manager_google_get_segment_by_idBRead-onlyIdempotent
Get segment by ID
Inputs: type (required), segmentId (required), locationId.
ad_manager_google_get_segmentsCRead-onlyIdempotent
Get segments
Inputs: type, locationId.
ad_manager_google_get_target_interestsCRead-onlyIdempotent
Get target interests
Inputs: type (required), advertisingChannelType (required), locationId.
ad_manager_google_publish_adC
Publish ad
Inputs: adId (required).
ad_manager_google_search_targetingDRead-onlyIdempotent
Search targeting options
Inputs: type (required), query, locationId.
ad_manager_google_upsert_assetsD
Upsert assets
Inputs: type (required), payload (required), locationId.
ad_manager_google_upsert_audienceCIdempotent
Upsert audience
Inputs: name (required), dimensions, locationId, resourceName, +1 more.
ad_manager_google_upsert_campaignCIdempotent
Upsert Google campaign
Inputs: name (required), advertisingChannelType (required), id, assets, +18 more.
ad_manager_google_upsert_conversionDIdempotent
Upsert conversion
Inputs: name (required), type (required), category (required), countingType (required), +5 more.
ad_manager_google_upsert_segmentDIdempotent
Upsert segment
Inputs: name (required), type (required), id, status, +9 more.
ad_manager_li_create_integrationB
Create LinkedIn integration
Inputs: adAccountId (required), currencyCode (required), adAccountName (required), organizationId (required), +1 more.
ad_manager_li_create_lead_formC
Create lead form
Inputs: name (required), owner (required), state (required), content (required), +4 more.
ad_manager_li_delete_ad_accountCDestructiveIdempotent
Delete ad account
Inputs: adAccountId (required), locationId.
ad_manager_li_get_ad_account_detailsCRead-onlyIdempotent
Get ad account details
Inputs: adAccountId (required), locationId.
ad_manager_li_get_ad_accountsBRead-onlyIdempotent
Get LinkedIn ad accounts
Inputs: locationId.
ad_manager_li_get_ad_analyticsDRead-onlyIdempotent
Get ad analytics
Inputs: endDate (required), startDate (required), pivot, fields, +3 more.
ad_manager_li_get_campaign_groupCRead-onlyIdempotent
Get ad campaign group
Inputs: adId (required), locationId.
ad_manager_li_get_campaign_group_reportingCRead-onlyIdempotent
Get campaign group reporting
Inputs: endDate (required), startDate (required), campaignGroupId (required), fields, +1 more.
ad_manager_li_get_current_userBRead-onlyIdempotent
Get current LinkedIn user
Inputs: locationId.
ad_manager_li_get_integrationBRead-onlyIdempotent
Get LinkedIn integration
Inputs: locationId.
ad_manager_li_get_lead_formsCRead-onlyIdempotent
Get lead forms
Inputs: accountId (required), locationId.
ad_manager_li_get_reporting_listCRead-onlyIdempotent
Get reporting list
Inputs: endDate (required), listType (required), startDate (required), campaignId (required), +3 more.
ad_manager_li_publish_campaign_groupD
Publish ad campaign group
Inputs: adId (required), locationId.
ad_manager_li_search_targetingDRead-onlyIdempotent
Search targeting options
Inputs: facet (required), q, query, locationId.
ad_manager_li_update_ad_statusD
Update ad status
Inputs: adId (required), type (required), operationType (required), locationId.
ad_manager_li_upsert_campaign_groupCIdempotent
Upsert ad campaign group
Inputs: id, meta, name, budget, +9 more.
affiliate_manager_get_affiliateCRead-onlyIdempotent
Get Affiliate
Inputs: affiliateId (required), locationId.
affiliate_manager_list_affiliatesCRead-onlyIdempotent
List Affiliates
Inputs: skip, limit, query, active, +4 more.
affiliate_manager_list_commissionsDRead-onlyIdempotent
List Commissions
Inputs: skip, limit, query, status, +5 more.
affiliate_manager_list_payoutsCRead-onlyIdempotent
List Payouts
Inputs: end, skip, limit, query, +5 more.
agent_studio_create_agentD
Create Agent
Inputs: status (required), version (required), name, edges, +8 more.
agent_studio_delete_agentDDestructiveIdempotent
Delete Agent
Inputs: agentId (required), source, locationId.
agent_studio_execute_agentC
Execute Agent
Inputs: agentId (required), message (required), source, contactId, +5 more.
agent_studio_execute_agent_deprecatedD
Execute Agent (Deprecated)
Inputs: agentId (required), message (required), source, contactId, +5 more.
agent_studio_get_agent_by_idDRead-onlyIdempotent
Get Agent
Inputs: agentId (required), source, locationId.
agent_studio_get_agent_by_id_deprecatedCRead-onlyIdempotent
Get Agent (Deprecated)
Inputs: agentId (required), source, locationId.
agent_studio_get_agentsCRead-onlyIdempotent
List Agents
Inputs: limit (required), offset (required), source, locationId, +1 more.
agent_studio_get_agents_deprecatedDRead-onlyIdempotent
List Agents (Deprecated)
Inputs: limit (required), offset (required), source, locationId.
agent_studio_promote_and_publishD
Promote to Production
Inputs: versionId (required), source, userId, userName, +2 more.
agent_studio_update_agent_metadataC
Update Agent Metadata
Inputs: agentId (required), name, source, status, +2 more.
agent_studio_update_agent_versionD
Update Agent
Inputs: versionId (required), edges, nodes, source, +9 more.
associations_create_associationD
Create Association
Inputs: key (required), firstObjectKey (required), secondObjectKey (required), firstObjectLabel (required), +2 more.
associations_create_relationC
Create Relation for you associated entities.
Inputs: associationId (required), firstRecordId (required), secondRecordId (required), locationId.
associations_delete_associationCDestructiveIdempotent
Delete Association
Inputs: associationId (required).
associations_delete_relationDDestructiveIdempotent
Delete Relation
Inputs: relationId (required), locationId.
associations_find_associationsCRead-onlyIdempotent
Get all associations for a sub-account / location
Inputs: skip (required), limit (required), locationId.
associations_get_association_by_idBRead-onlyIdempotent
Get association by ID
Inputs: associationId (required).
associations_get_association_by_object_keysCRead-onlyIdempotent
Get association by object keys
Inputs: objectKey (required), locationId.
associations_get_association_key_by_key_nameDRead-onlyIdempotent
Get association key by key name
Inputs: key_name (required), locationId.
associations_get_relations_by_record_idCRead-onlyIdempotent
Get all relations By record Id
Inputs: skip (required), limit (required), recordId (required), locationId, +1 more.
associations_update_associationCIdempotent
Update Association By Id
Inputs: associationId (required), firstObjectLabel (required), secondObjectLabel (required).
blogs_check_url_slug_existsDRead-onlyIdempotent
Check url slug
Inputs: urlSlug (required), postId, locationId.
blogs_create_blog_postD
Create Blog Post
Inputs: title (required), author (required), blogId (required), status (required), +10 more.
blogs_get_all_blog_authors_by_locationCRead-onlyIdempotent
Get all authors
Inputs: limit (required), offset (required), locationId.
blogs_get_all_categories_by_locationCRead-onlyIdempotent
Get all categories
Inputs: limit (required), offset (required), locationId.
blogs_get_blog_postCRead-onlyIdempotent
Get Blog posts by Blog ID
Inputs: limit (required), blogId (required), offset (required), status, +2 more.
blogs_get_blogsCRead-onlyIdempotent
Get Blogs by Location ID
Inputs: skip (required), limit (required), locationId, searchTerm.
blogs_update_blog_postCIdempotent
Update Blog Post
Inputs: title (required), author (required), blogId (required), postId (required), +11 more.
brand_boards_create_brand_boardC
Create a new brand board
Inputs: name (required), type, fonts, logos, +5 more.
brand_boards_delete_brand_boardCDestructiveIdempotent
Delete a Brand Board
Inputs: id (required), locationId.
brand_boards_get_brand_board_by_idCRead-onlyIdempotent
Get Brand Board
Inputs: id (required), locationId.
brand_boards_get_brand_boards_by_locationDRead-onlyIdempotent
Get Brand Boards
Inputs: limit, offset, search, deleted, +1 more.
brand_boards_update_brand_boardC
Update a Brand Board
Inputs: id (required), name, fonts, logos, +4 more.
businesses_create_businessD
Create Business
Inputs: name (required), city, email, phone, +7 more.
businesses_delete_businessDDestructiveIdempotent
Delete Business
Inputs: businessId (required).
businesses_get_businessDRead-onlyIdempotent
Get Business
Inputs: businessId (required).
businesses_get_businesses_by_locationCRead-onlyIdempotent
Get Businesses by Location
Inputs: skip, limit, locationId.
businesses_update_businessDIdempotent
Update Business
Inputs: businessId (required), city, name, email, +7 more.
calendars_add_calendar_to_scheduleCIdempotent
Apply user availability schedule to a calendar
Inputs: id (required), calendarId (required).
calendars_create_appointmentD
Create appointment
Inputs: contactId (required), startTime (required), calendarId (required), rrule, +13 more.
calendars_create_appointment_noteD
Create Note
Inputs: body (required), appointmentId (required), userId.
calendars_create_block_slotD
Create Block Slot
Inputs: calendarId (required), title, endTime, startTime, +2 more.
calendars_create_calendarD
Create Calendar
Inputs: name (required), slug, notes, formId, +50 more.
calendars_create_calendar_groupD
Create Calendar Group
Inputs: name (required), slug (required), description (required), isActive, +1 more.
calendars_create_calendar_resourceC
Create Calendar Resource
Inputs: name (required), capacity (required), quantity (required), calendarIds (required), +4 more.
calendars_create_event_notificationD
Create notification
Inputs: body (required), calendarId (required).
calendars_create_scheduleC
Create user availability schedule
Inputs: name (required), userId (required), timezone (required), rules, +2 more.
calendars_delete_appointment_noteDDestructiveIdempotent
Delete Note
Inputs: noteId (required), appointmentId (required).
calendars_delete_calendarCDestructiveIdempotent
Delete Calendar
Inputs: calendarId (required).
calendars_delete_calendar_resourceCDestructiveIdempotent
Delete Calendar Resource
Inputs: id (required), resourceType (required).
calendars_delete_eventDDestructiveIdempotent
Delete Event
Inputs: body (required), eventId (required).
calendars_delete_event_notificationDDestructiveIdempotent
Delete Notification
Inputs: calendarId (required), notificationId (required).
calendars_delete_groupCDestructiveIdempotent
Delete Group
Inputs: groupId (required).
calendars_delete_scheduleCDestructiveIdempotent
Delete user availability schedule
Inputs: id (required).
calendars_disable_groupDIdempotent
Disable Group
Inputs: groupId (required), isActive (required).
calendars_edit_appointmentCIdempotent
Update Appointment
Inputs: eventId (required), rrule, title, address, +12 more.
calendars_edit_block_slotDIdempotent
Update Block Slot
Inputs: eventId (required), calendarId (required), title, endTime, +3 more.
calendars_edit_groupDIdempotent
Update Group
Inputs: name (required), slug (required), groupId (required), description (required).
calendars_fetch_calendar_resourcesCRead-onlyIdempotent
List Calendar Resources
Inputs: skip (required), limit (required), resourceType (required), locationId.
calendars_find_event_notificationDRead-onlyIdempotent
Get notification
Inputs: calendarId (required), notificationId (required).
calendars_get_all_schedulesCRead-onlyIdempotent
List user availability schedule
Inputs: userId (required), skip, limit, calendarId, +1 more.
calendars_get_appointmentDRead-onlyIdempotent
Get Appointment
Inputs: eventId (required).
calendars_get_appointment_notesCRead-onlyIdempotent
Get Notes
Inputs: limit (required), offset (required), appointmentId (required).
calendars_get_blocked_slotsCRead-onlyIdempotent
Get Blocked Slots
Inputs: endTime (required), startTime (required), userId, groupId, +2 more.
calendars_get_calendarCRead-onlyIdempotent
Get Calendar
Inputs: calendarId (required).
calendars_get_calendar_eventsCRead-onlyIdempotent
Get Calendar Events
Inputs: endTime (required), startTime (required), userId, groupId, +2 more.
calendars_get_calendar_resourceCRead-onlyIdempotent
Get Calendar Resource
Inputs: id (required), resourceType (required).
calendars_get_calendarsCRead-onlyIdempotent
Get Calendars
Inputs: groupId, locationId, showDrafted.
calendars_get_event_notificationDRead-onlyIdempotent
Get notifications
Inputs: calendarId (required), skip, limit, deleted, +1 more.
calendars_get_groupsDRead-onlyIdempotent
Get Groups
Inputs: locationId.
calendars_get_schedule_by_idCRead-onlyIdempotent
Get user availability schedule
Inputs: id (required).
calendars_get_slotsCRead-onlyIdempotent
Get Free Slots
Inputs: endDate (required), startDate (required), calendarId (required), userId, +2 more.
calendars_remove_calendar_from_scheduleCDestructiveIdempotent
Remove user availability schedule from a calendar
Inputs: id (required), calendarId (required).
calendars_update_appointment_noteCIdempotent
Update Note
Inputs: body (required), noteId (required), appointmentId (required), userId.
calendars_update_calendarCIdempotent
Update Calendar
Inputs: calendarId (required), name, slug, notes, +48 more.
calendars_update_calendar_resourceCIdempotent
Update Calendar Resource
Inputs: id (required), resourceType (required), name, capacity, +6 more.
calendars_update_event_notificationDIdempotent
Update notification
Inputs: calendarId (required), notificationId (required), body, channel, +14 more.
calendars_update_scheduleCIdempotent
Update user availability schedule
Inputs: id (required), name, rules, timezone.
calendars_validate_groups_slugC
Validate group slug
Inputs: slug (required), locationId.
campaigns_get_campaignsCRead-onlyIdempotent
Get Campaigns
Inputs: status, locationId.
companies_get_companyBRead-onlyIdempotent
Get Company (requires an agency-level token, not a location PIT)
Inputs: companyId (required).
contacts_add_contact_to_campaignC
Add Contact to Campaign
Inputs: body (required), contactId (required), campaignId (required).
contacts_add_contact_to_workflowC
Add Contact to Workflow
Inputs: contactId (required), workflowId (required), eventStartTime.
contacts_add_followers_contactC
Add Followers
Inputs: contactId (required), followers (required).
contacts_add_remove_contact_from_businessD
Add/Remove Contacts From Business
Inputs: ids (required), businessId (required), locationId.
contacts_add_tagsD
Add Tags
Inputs: tags (required), contactId (required).
contacts_create_associationC
Update Contacts Tags
Inputs: tags (required), type (required), contacts (required), locationId, +1 more.
contacts_create_contactD
Create Contact
Inputs: dnd, city, name, tags, +19 more.
contacts_create_noteD
Create Note
Inputs: body (required), contactId (required), color, title, +2 more.
contacts_create_taskC
Create Task
Inputs: title (required), dueDate (required), completed (required), contactId (required), +2 more.
contacts_delete_contactCDestructiveIdempotent
Delete Contact
Inputs: contactId (required).
contacts_delete_contact_from_workflowDDestructiveIdempotent
Delete Contact from Workflow
Inputs: contactId (required), workflowId (required), eventStartTime.
contacts_delete_noteDDestructiveIdempotent
Delete Note
Inputs: id (required), contactId (required).
contacts_delete_taskCDestructiveIdempotent
Delete Task
Inputs: taskId (required), contactId (required).
contacts_get_all_notesCRead-onlyIdempotent
Get All Notes
Inputs: contactId (required).
contacts_get_all_tasksCRead-onlyIdempotent
Get all Tasks
Inputs: contactId (required).
contacts_get_appointments_for_contactBRead-onlyIdempotent
Get Appointments for Contact
Inputs: contactId (required).
contacts_get_contactCRead-onlyIdempotent
Get Contact
Inputs: contactId (required).
contacts_get_contactsDRead-onlyIdempotent
Get Contacts
Inputs: limit, query, locationId, startAfter, +1 more.
contacts_get_contacts_by_business_idDRead-onlyIdempotent
Get Contacts By BusinessId
Inputs: businessId (required), skip, limit, query, +1 more.
contacts_get_duplicate_contactDRead-onlyIdempotent
Get Duplicate Contact
Inputs: email, number, locationId.
contacts_get_noteCRead-onlyIdempotent
Get Note
Inputs: id (required), contactId (required).
contacts_get_taskDRead-onlyIdempotent
Get Task
Inputs: taskId (required), contactId (required).
contacts_remove_contact_from_campaignCDestructiveIdempotent
Remove Contact From Campaign
Inputs: contactId (required), campaignId (required).
contacts_remove_contact_from_every_campaignCDestructiveIdempotent
Remove Contact From Every Campaign
Inputs: contactId (required).
contacts_remove_followers_contactDDestructiveIdempotent
Remove Followers
Inputs: contactId (required), followers (required).
contacts_remove_tagsDDestructiveIdempotent
Remove Tags
Inputs: tags (required), contactId (required).
contacts_search_contacts_advancedDRead-only
Search Contacts
Inputs: body (required).
contacts_update_contactDIdempotent
Update Contact
Inputs: contactId (required), dnd, city, name, +17 more.
contacts_update_noteCIdempotent
Update Note
Inputs: id (required), contactId (required), body, color, +3 more.
contacts_update_taskDIdempotent
Update Task
Inputs: taskId (required), contactId (required), body, title, +3 more.
contacts_update_task_completedDIdempotent
Update Task Completed
Inputs: taskId (required), completed (required), contactId (required).
contacts_upsert_contactD
Upsert Contact
Inputs: dnd, city, name, tags, +20 more.
conversation_ai_create_actionD
Attach Action to Agent
Inputs: name (required), type (required), agentId (required), details (required).
conversation_ai_create_agentC
Create an Agent
Inputs: goal (required), name (required), personality (required), instructions (required), +15 more.
conversation_ai_delete_actionBDestructiveIdempotent
Remove Action from Agent
Inputs: agentId (required), actionId (required).
conversation_ai_delete_agentCDestructiveIdempotent
Delete Agent
Inputs: agentId (required).
conversation_ai_get_action_by_idCRead-onlyIdempotent
Get Action by ID
Inputs: agentId (required), actionId (required).
conversation_ai_get_agentCRead-onlyIdempotent
Get Agent
Inputs: agentId (required).
conversation_ai_get_generation_detailsCRead-onlyIdempotent
Get the generation details
Inputs: source (required), messageId (required).
conversation_ai_list_actionsBRead-onlyIdempotent
List Actions for an Agent
Inputs: agentId (required).
conversation_ai_search_agentCRead-onlyIdempotent
Search Agents
Inputs: limit, query, startAfter.
conversation_ai_update_actionDIdempotent
Update Action
Inputs: name (required), type (required), agentId (required), details (required), +1 more.
conversation_ai_update_agentCIdempotent
Update Agent
Inputs: agentId (required), autoPilotMaxMessages (required), goal, mode, +16 more.
conversation_ai_update_followup_settingsD
Update Followup Settings
Inputs: agentId (required), actionIds (required), followupSettings (required).
conversations_add_an_inbound_messageC
Add an inbound message
Inputs: type (required), contactId (required), conversationId (required), conversationProviderId (required), +13 more.
conversations_add_an_outbound_messageB
Add an external outbound call
Inputs: type (required), conversationId (required), conversationProviderId (required), call, +3 more.
conversations_add_message_attachmentsCIdempotent
Add message attachments
Inputs: messageId (required), attachments (required).
conversations_cancel_scheduled_email_messageCDestructiveIdempotent
Cancel a scheduled email message.
Inputs: emailMessageId (required).
conversations_cancel_scheduled_messageBDestructiveIdempotent
Cancel a scheduled message.
Inputs: messageId (required).
conversations_complete_file_uploadD
Complete file upload
Inputs: filePath (required), filename (required), uploadId (required), conversationId (required), +1 more.
conversations_create_conversationD
Create Conversation
Inputs: contactId (required), locationId.
conversations_create_custom_subtypeC
Create Custom Subtype
Inputs: name (required), channel (required), language (required), locationId, +1 more.
conversations_delete_conversationCDestructiveIdempotent
Delete Conversation
Inputs: conversationId (required).
conversations_download_message_transcriptionBRead-onlyIdempotent
Download transcription by Message ID
Inputs: messageId (required), locationId.
conversations_export_messages_by_locationCRead-onlyIdempotent
Export messages by location ID
Inputs: limit, cursor, sortBy, channel, +6 more.
conversations_get_all_custom_subtypesCRead-onlyIdempotent
Get All Custom Subtypes
Inputs: locationId.
conversations_get_contact_unsubscription_statusBRead-onlyIdempotent
Get Contact Unsubscription Status
Inputs: contactId (required), email, locationId.
conversations_get_conversationCRead-onlyIdempotent
Get Conversation
Inputs: conversationId (required).
conversations_get_email_by_idDRead-onlyIdempotent
Get email by Id
Inputs: id (required).
conversations_get_messageARead-onlyIdempotent
Get message by message id
Inputs: id (required).
conversations_get_message_recordingCRead-onlyIdempotent
Get Recording by Message ID
Inputs: messageId (required), locationId.
conversations_get_messagesCRead-onlyIdempotent
Get messages by conversation id
Inputs: conversationId (required), type, limit, lastMessageId.
conversations_get_message_transcriptionCRead-onlyIdempotent
Get transcription by Message ID
Inputs: messageId (required), locationId.
conversations_initiate_file_uploadC
Initiate file upload to GCS
Inputs: channel (required), filename (required), contentType (required), conversationId (required), +2 more.
conversations_live_chat_agent_typingB
Agent/Ai-Bot is typing a message indicator for live chat
Inputs: isTyping (required), visitorId (required), conversationId (required), locationId.
conversations_search_conversationDRead-onlyIdempotent
Search Conversations
Inputs: id, sort, limit, query, +17 more.
conversations_send_a_new_messageC
Send a new message
Inputs: type (required), status (required), subType (required), contactId (required), +21 more.
conversations_send_review_replyB
Send a review reply to Google My Business
Inputs: message (required), conversationId (required), locationId.
conversations_update_conversationCIdempotent
Update Conversation
Inputs: conversationId (required), starred, feedback, locationId, +1 more.
conversations_update_custom_subtypeDIdempotent
Update Custom Subtype
Inputs: id (required), name, archived, locationId, +2 more.
conversations_update_message_statusCIdempotent
Update message status
Inputs: status (required), messageId (required), error, recipients, +1 more.
conversations_user_subscription_changeD
User Subscription Change
Inputs: email (required), contactId (required), subscription_action (required), locationId, +2 more.
courses_import_coursesC
Import Courses
Inputs: products (required), userId, locationId.
custom_fields_create_custom_fieldD
Create Custom Field
Inputs: dataType (required), fieldKey (required), parentId (required), objectKey (required), +9 more.
custom_fields_create_custom_field_folderD
Create Custom Field Folder
Inputs: name (required), objectKey (required), locationId.
custom_fields_delete_custom_fieldBDestructiveIdempotent
Delete Custom Field By Id
Inputs: id (required).
custom_fields_delete_custom_field_folderCDestructiveIdempotent
Delete Custom Field Folder
Inputs: id (required), locationId.
custom_fields_get_custom_field_by_idBRead-onlyIdempotent
Get Custom Field / Folder By Id
Inputs: id (required).
custom_fields_get_custom_fields_by_object_keyCRead-onlyIdempotent
Get Custom Fields By Object Key
Inputs: objectKey (required), locationId.
custom_fields_update_custom_fieldCIdempotent
Update Custom Field By Id
Inputs: id (required), showInForms (required), name, options, +5 more.
custom_fields_update_custom_field_folderBIdempotent
Update Custom Field Folder Name
Inputs: id (required), name (required), locationId.
email_isv_verify_emailD
Email Verification
Inputs: type (required), verify (required), locationId.
emails_create_templateC
Create a new template
Inputs: type (required), importProvider (required), name, title, +8 more.
emails_delete_templateCDestructiveIdempotent
Delete a template
Inputs: templateId (required), locationId.
emails_fetch_campaignsDRead-onlyIdempotent
Get Campaigns
Inputs: name, limit, offset, status, +7 more.
emails_fetch_templateCRead-onlyIdempotent
Fetch email templates
Inputs: name, limit, offset, search, +7 more.
emails_update_templateC
Update a template
Inputs: dnd (required), html (required), updatedBy (required), editorType (required), +4 more.
forms_get_formsDRead-onlyIdempotent
Get Forms
Inputs: skip, type, limit, locationId.
forms_get_forms_submissionsCRead-onlyIdempotent
Get Forms Submissions
Inputs: q, page, endAt, limit, +3 more.
funnels_create_redirectD
Create Redirect
Inputs: path (required), action (required), domain (required), target (required), +1 more.
funnels_delete_redirect_by_idDDestructiveIdempotent
Delete Redirect By Id
Inputs: id (required), locationId.
funnels_fetch_redirects_listCRead-onlyIdempotent
Fetch List of Redirects
Inputs: limit (required), offset (required), search, locationId.
funnels_get_funnelsCRead-onlyIdempotent
Fetch List of Funnels
Inputs: name, type, limit, offset, +3 more.
funnels_get_pages_by_funnel_idCRead-onlyIdempotent
Fetch list of funnel pages
Inputs: limit (required), offset (required), funnelId (required), name, +1 more.
funnels_get_pages_count_by_funnel_idCRead-onlyIdempotent
Fetch count of funnel pages
Inputs: funnelId (required), name, locationId.
funnels_update_redirect_by_idD
Update Redirect By Id
Inputs: id (required), action (required), target (required), locationId.
invoices_auto_payment_invoice_scheduleC
Manage Auto payment for an schedule invoice
Inputs: id (required), scheduleId (required), autoPayment (required), altId, +1 more.
invoices_cancel_invoice_scheduleC
Cancel an scheduled invoice
Inputs: scheduleId (required), altId, altType.
invoices_create_estimate_templateD
Create Estimate Template
Inputs: name (required), items (required), currency (required), discount (required), +12 more.
invoices_create_invoiceC
Create Invoice
Inputs: name (required), items (required), sentTo (required), currency (required), +19 more.
invoices_create_invoice_from_estimateC
Create Invoice from Estimate
Inputs: estimateId (required), markAsInvoiced (required), altId, altType, +1 more.
invoices_create_invoice_scheduleD
Create Invoice Schedule
Inputs: name (required), items (required), currency (required), discount (required), +15 more.
invoices_create_invoice_templateD
Create template
Inputs: name (required), items (required), currency (required), businessDetails (required), +13 more.
invoices_create_new_estimateD
Create New Estimate
Inputs: name (required), items (required), currency (required), discount (required), +21 more.
invoices_delete_estimateCDestructiveIdempotent
Delete Estimate
Inputs: estimateId (required), altId, altType.
invoices_delete_estimate_templateBDestructiveIdempotent
Delete Estimate Template
Inputs: templateId (required), altId, altType.
invoices_delete_invoiceBDestructiveIdempotent
Delete invoice
Inputs: invoiceId (required), altId, altType.
invoices_delete_invoice_scheduleCDestructiveIdempotent
Delete schedule
Inputs: scheduleId (required), altId, altType.
invoices_delete_invoice_templateDDestructiveIdempotent
Delete template
Inputs: templateId (required), altId, altType.
invoices_generate_estimate_numberCRead-onlyIdempotent
Generate Estimate Number
Inputs: altId, altType.
invoices_generate_invoice_numberDRead-onlyIdempotent
Generate Invoice Number
Inputs: altId, altType.
invoices_get_invoiceDRead-onlyIdempotent
Get invoice
Inputs: invoiceId (required), altId, altType.
invoices_get_invoice_scheduleCRead-onlyIdempotent
Get an schedule
Inputs: scheduleId (required), altId, altType.
invoices_get_invoice_settingsCRead-onlyIdempotent
Get Invoice Settings
Inputs: altId, altType.
invoices_get_invoice_templateDRead-onlyIdempotent
Get an template
Inputs: templateId (required), altId, altType.
invoices_list_estimatesDRead-onlyIdempotent
List Estimates
Inputs: limit (required), offset (required), altId, endAt, +5 more.
invoices_list_estimate_templatesCRead-onlyIdempotent
List Estimate Templates
Inputs: limit (required), offset (required), altId, search, +1 more.
invoices_list_invoicesBRead-onlyIdempotent
List invoices
Inputs: limit (required), offset (required), altId, endAt, +8 more.
invoices_list_invoice_schedulesCRead-onlyIdempotent
List schedules
Inputs: limit (required), offset (required), altId, endAt, +5 more.
invoices_list_invoice_templatesCRead-onlyIdempotent
List templates
Inputs: limit (required), offset (required), altId, endAt, +5 more.
invoices_preview_estimate_templateCRead-onlyIdempotent
Preview Estimate Template
Inputs: templateId (required), altId, altType.
invoices_record_invoiceB
Record a manual payment for an invoice
Inputs: card (required), mode (required), notes (required), cheque (required), +7 more.
invoices_schedule_invoice_scheduleD
Schedule an schedule invoice
Inputs: liveMode (required), scheduleId (required), altId, altType, +1 more.
invoices_send_estimateD
Send Estimate
Inputs: action (required), userId (required), liveMode (required), estimateId (required), +4 more.
invoices_send_invoiceC
Send invoice
Inputs: action (required), userId (required), liveMode (required), invoiceId (required), +4 more.
invoices_text2pay_invoiceD
Create & Send
Inputs: name (required), items (required), action (required), sentTo (required), +23 more.
invoices_update_and_schedule_invoice_scheduleC
Update scheduled recurring invoice
Inputs: scheduleId (required).
invoices_update_estimateDIdempotent
Update Estimate
Inputs: name (required), items (required), currency (required), discount (required), +23 more.
invoices_update_estimate_last_visited_atC
Update estimate last visited at
Inputs: estimateId (required).
invoices_update_estimate_templateCIdempotent
Update Estimate Template
Inputs: name (required), items (required), currency (required), discount (required), +13 more.
invoices_update_invoiceCIdempotent
Update invoice
Inputs: name (required), dueDate (required), currency (required), invoiceId (required), +21 more.
invoices_update_invoice_last_visited_atC
Update invoice last visited at
Inputs: invoiceId (required).
invoices_update_invoice_late_fees_configurationC
Update invoice late fees configuration
Inputs: invoiceId (required), lateFeesConfiguration (required), altId, altType.
invoices_update_invoice_payment_methods_configurationD
Update template late fees configuration
Inputs: templateId (required), altId, altType, paymentMethods.
invoices_update_invoice_scheduleDIdempotent
Update schedule
Inputs: name (required), items (required), currency (required), discount (required), +11 more.
invoices_update_invoice_templateDIdempotent
Update template
Inputs: name (required), items (required), currency (required), templateId (required), +8 more.
invoices_update_invoice_template_late_fees_configurationC
Update template late fees configuration
Inputs: templateId (required), lateFeesConfiguration (required), altId, altType.
invoices_void_invoiceC
Void invoice
Inputs: invoiceId (required), altId, altType.
knowledge_base_createC
Create a new FAQ inside knowledge base
Inputs: answer (required), question (required), knowledgeBaseId (required), locationId.
knowledge_base_create_knowledge_baseB
Create a new knowledge base (max 15 knowledge bases per location)
Inputs: name (required), locationId, description.
knowledge_base_deleteBDestructiveIdempotent
Delete an existing knowledge base FAQ
Inputs: id (required).
knowledge_base_delete_knowledge_baseCDestructiveIdempotent
Delete a knowledge base
Inputs: knowledgeBaseId (required).
knowledge_base_delete_trained_urls_for_knowledge_baseCDestructiveIdempotent
Delete trained pages
Inputs: urlIds (required), knowledgeBaseId (required), locationId.
knowledge_base_discover_websiteC
Start crawling and discover pages for training
Inputs: url (required), option (required), knowledgeBaseId (required), locationId.
knowledge_base_get_all_website_urls_data_by_knowledge_baseARead-onlyIdempotent
Get all trained page links by knowledge base
Inputs: knowledgeBaseId (required), page, query, locationId, +1 more.
knowledge_base_get_crawling_status_for_latest_operationBRead-onlyIdempotent
Get crawling status for the latest operation
Inputs: operationId (required), knowledgeBaseId (required), locationId.
knowledge_base_get_knowledge_base_by_idBRead-onlyIdempotent
Get knowledge base by ID
Inputs: knowledgeBaseId (required).
knowledge_base_listARead-onlyIdempotent
Get all FAQs by knowledge base with pagination support
Inputs: knowledgeBaseId (required), limit, lastFaqId, locationId.
knowledge_base_list_all_knowledge_bases_paginatedARead-onlyIdempotent
Get all knowledge bases for a location by location Id (paginated)
Inputs: limit, query, locationId, lastKnowledgeBaseId.
knowledge_base_train_discovered_urlsC
Train discovered website pages and ingest into the knowledge base
Inputs: urlIds (required), operationId (required), knowledgeBaseId (required), locationId.
knowledge_base_updateCIdempotent
Update an existing knowledge base FAQ
Inputs: id (required), answer (required), question (required).
knowledge_base_update_knowledge_baseCIdempotent
Update a knowledge base
Inputs: id (required), name, description.
links_create_linkD
Create Link
Inputs: name (required), redirectTo (required), locationId.
links_delete_linkBDestructiveIdempotent
Delete Link
Inputs: linkId (required).
links_get_link_by_idCRead-onlyIdempotent
Get Link by ID
Inputs: linkId (required), locationId.
links_get_linksCRead-onlyIdempotent
Get Links
Inputs: locationId.
links_search_trigger_linksCRead-onlyIdempotent
Search Trigger Links
Inputs: skip, limit, query, locationId.
links_update_linkDIdempotent
Update Link
Inputs: name (required), linkId (required), redirectTo (required).
locations_create_custom_fieldD
Create Custom Field
Inputs: name (required), dataType (required), model, position, +6 more.
locations_create_custom_valueD
Create Custom Value
Inputs: name (required), value (required), locationId.
locations_create_locationB
Create Sub-Account (Formerly Location) (requires an agency-level token, not a location PIT)
Inputs: name (required), companyId (required), city, phone, +12 more.
locations_create_recurring_taskC
Create Recurring Task
Inputs: title (required), rruleOptions (required), owners, contactIds, +3 more.
locations_create_tagC
Create Tag
Inputs: name (required), locationId.
locations_delete_an_email_sms_templateBDestructiveIdempotent
DELETE an email/sms template
Inputs: id (required), locationId.
locations_delete_custom_fieldCDestructiveIdempotent
Delete Custom Field
Inputs: id (required), locationId.
locations_delete_custom_valueCDestructiveIdempotent
Delete Custom Value
Inputs: id (required), locationId.
locations_delete_locationADestructiveIdempotent
Delete Sub-Account (Formerly Location) (requires an agency-level token, not a location PIT)
Inputs: deleteTwilioAccount (required), locationId.
locations_delete_recurring_taskDDestructiveIdempotent
Delete Recurring Task
Inputs: id (required), locationId.
locations_delete_tagCDestructiveIdempotent
Delete tag
Inputs: tagId (required), locationId.
locations_get_all_or_email_sms_templatesDRead-onlyIdempotent
GET all or email/sms templates
Inputs: originId (required), skip, type, limit, +2 more.
locations_get_custom_fieldDRead-onlyIdempotent
Get Custom Field
Inputs: id (required), locationId.
locations_get_custom_fieldsCRead-onlyIdempotent
Get Custom Fields
Inputs: model, locationId.
locations_get_custom_valueDRead-onlyIdempotent
Get Custom Value
Inputs: id (required), locationId.
locations_get_custom_valuesCRead-onlyIdempotent
Get Custom Values
Inputs: locationId.
locations_get_locationBRead-onlyIdempotent
Get Sub-Account (Formerly Location)
Inputs: locationId.
locations_get_location_tagsCRead-onlyIdempotent
Get Tags
Inputs: locationId.
locations_get_recurring_task_by_idCRead-onlyIdempotent
Get Recurring Task By Id
Inputs: id (required), locationId.
locations_get_tag_by_idBRead-onlyIdempotent
Get tag by id
Inputs: tagId (required), locationId.
locations_get_timezonesCRead-onlyIdempotent
Fetch Timezones
Inputs: locationId.
locations_put_locationBIdempotent
Put Sub-Account (Formerly Location) (requires an agency-level token, not a location PIT)
Inputs: companyId (required), city, name, phone, +13 more.
locations_search_locationsCRead-onlyIdempotent
Search
Inputs: skip, email, limit, order, +1 more.
locations_task_searchDRead-only
Task Search Filter
Inputs: skip, limit, query, completed, +4 more.
locations_update_custom_fieldDIdempotent
Update Custom Field
Inputs: id (required), name (required), model, position, +6 more.
locations_update_custom_valueCIdempotent
Update Custom Value
Inputs: id (required), name (required), value (required), locationId.
locations_update_recurring_taskCIdempotent
Update Recurring Task
Inputs: id (required), title, owners, contactIds, +4 more.
locations_update_tagCIdempotent
Update tag
Inputs: name (required), tagId (required), locationId.
marketplace_chargeC
Create a new wallet charge
Inputs: appId (required), units (required), eventId (required), meterId (required), +6 more.
marketplace_delete_chargeADestructiveIdempotent
Delete a wallet charge
Inputs: chargeId (required).
marketplace_get_chargesBRead-onlyIdempotent
Get all wallet charges
Inputs: skip, limit, userId, endDate, +3 more.
marketplace_get_installer_detailsCRead-onlyIdempotent
Get Installer Details
Inputs: appId (required).
marketplace_get_rebilling_config_for_appBRead-onlyIdempotent
Get rebilling config for an app subscription and usage plans
Inputs: appId (required), locationId.
marketplace_get_specific_chargeARead-onlyIdempotent
Get specific wallet charge details
Inputs: chargeId (required).
marketplace_has_fundsARead-onlyIdempotent
Check if account has sufficient funds
Inputs: no named parameters.
marketplace_migrate_connectionC
Migrate external authentication connection
Inputs: type (required), appId (required), accountId (required), appVersionId (required), +10 more.
marketplace_uninstall_applicationCDestructiveIdempotent
Uninstall an application
Inputs: appId (required), reason, companyId, locationId.
medias_bulk_delete_media_objectsCIdempotent
Bulk Delete / Trash Files or Folders
Inputs: status (required), filesToBeDeleted (required), altId, altType.
medias_bulk_update_media_objectsCIdempotent
Bulk Update Files/ Folders
Inputs: filesToBeUpdated (required), altId, altType.
medias_create_media_folderD
Create Folder
Inputs: name (required), altId, altType, parentId.
medias_delete_media_contentBDestructiveIdempotent
Delete File or Folder
Inputs: id (required), altId, altType.
medias_fetch_media_contentBRead-onlyIdempotent
Get List of Files/ Folders
Inputs: type (required), sortBy (required), sortOrder (required), altId, +6 more.
medias_update_media_objectC
Update File/ Folder
Inputs: id (required), name (required), altId, altType.
oauth_get_installed_locationARead-onlyIdempotent
Get Location where app is installed (requires an agency-level token, not a location PIT)
Inputs: appId (required), companyId (required), skip, limit, +6 more.
objects_create_custom_object_schemaA
Create Custom Object (requires an agency-level token, not a location PIT)
Inputs: key (required), labels (required), primaryDisplayPropertyDetails (required), locationId, +1 more.
objects_create_object_recordD
Create Record
Inputs: body (required), schemaKey (required).
objects_delete_object_recordCDestructiveIdempotent
Delete Record
Inputs: id (required), schemaKey (required).
objects_get_object_by_location_idARead-onlyIdempotent
Get all objects for a location
Inputs: locationId.
objects_get_object_schema_by_keyCRead-onlyIdempotent
Get Object Schema by key / id
Inputs: key (required), locationId, fetchProperties.
objects_get_record_by_idCRead-onlyIdempotent
Get Record By Id
Inputs: id (required), schemaKey (required).
objects_search_object_recordsCRead-only
Search Object Records
Inputs: page (required), query (required), pageLimit (required), schemaKey (required), +2 more.
objects_update_custom_objectCIdempotent
Update Object Schema By Key / Id
Inputs: key (required), searchableProperties (required), labels, locationId, +1 more.
objects_update_object_recordCIdempotent
Update Record
Inputs: id (required), body (required), schemaKey (required), locationId.
opportunities_add_followers_opportunityD
Add Followers
Inputs: id (required), followers (required).
opportunities_create_opportunityD
Create Opportunity
Inputs: name (required), status (required), contactId (required), pipelineId (required), +5 more.
opportunities_delete_opportunityCDestructiveIdempotent
Delete Opportunity
Inputs: id (required).
opportunities_get_lost_reasonDRead-onlyIdempotent
Get lost reason
Inputs: name, skip, limit, query, +3 more.
opportunities_get_opportunityCRead-onlyIdempotent
Get Opportunity
Inputs: id (required).
opportunities_get_pipelinesCRead-onlyIdempotent
Get Pipelines
Inputs: locationId.
opportunities_remove_followers_opportunityCDestructiveIdempotent
Remove Followers
Inputs: id (required), followers (required), isRemoveAllFollowers.
opportunities_search_opportunities_advancedDRead-only
Search Opportunities
Inputs: page (required), limit (required), query (required), searchAfter (required), +2 more.
opportunities_search_opportunityDRead-onlyIdempotent
Search Opportunity
Inputs: location_id (required), q, id, date, +16 more.
opportunities_update_opportunityDIdempotent
Update Opportunity
Inputs: id (required), name, status, assignedTo, +4 more.
opportunities_update_opportunity_statusCIdempotent
Update Opportunity Status
Inputs: id (required), status (required), lostReasonId.
opportunities_upsert_opportunityC
Upsert Opportunity
Inputs: followers (required), pipelineId (required), followersActionType (required), isRemoveAllFollowers (required), +8 more.
payments_create_configC
Create new provider config
Inputs: live (required), test (required), locationId.
payments_create_couponD
Create Coupon
Inputs: code (required), name (required), startDate (required), discountType (required), +9 more.
payments_create_integrationD
Create new integration
Inputs: name (required), imageUrl (required), queryUrl (required), description (required), +3 more.
payments_create_integration_providerC
Create White-label Integration Provider
Inputs: title (required), imageUrl (required), provider (required), uniqueName (required), +3 more.
payments_create_order_fulfillmentC
Create order fulfillment
Inputs: items (required), orderId (required), trackings (required), notifyCustomer (required), +2 more.
payments_custom_provider_marketplace_app_update_capabilitiesDIdempotent
Custom-provider marketplace app update capabilities
Inputs: supportsSubscriptionSchedules (required), companyId, locationId.
payments_delete_couponCDestructiveIdempotent
Delete Coupon
Inputs: id (required), altId, altType.
payments_delete_integrationCDestructiveIdempotent
Deleting an existing integration
Inputs: locationId.
payments_disconnect_configB
Disconnect existing provider config
Inputs: liveMode (required), locationId.
payments_fetch_configBRead-onlyIdempotent
Fetch given provider config
Inputs: locationId.
payments_get_couponCRead-onlyIdempotent
Fetch Coupon
Inputs: id (required), code (required), altId, altType.
payments_get_order_by_idBRead-onlyIdempotent
Get Order by ID
Inputs: altId (required), orderId (required), locationId.
payments_get_subscription_by_idCRead-onlyIdempotent
Get Subscription by ID
Inputs: subscriptionId (required), altId, altType.
payments_get_transaction_by_idCRead-onlyIdempotent
Get Transaction by ID
Inputs: altId (required), altType (required), transactionId (required), locationId.
payments_list_couponsCRead-onlyIdempotent
List Coupons
Inputs: altId, limit, offset, search, +2 more.
payments_list_integration_providersBRead-onlyIdempotent
List White-label Integration Providers
Inputs: altId, limit, offset, altType.
payments_list_order_fulfillmentDRead-onlyIdempotent
List fulfillment
Inputs: orderId (required), altId, altType.
payments_list_order_notesCRead-onlyIdempotent
List Order Notes
Inputs: orderId (required), altId, altType.
payments_list_ordersDRead-onlyIdempotent
List Orders
Inputs: altId (required), endAt, limit, offset, +9 more.
payments_list_subscriptionsCRead-onlyIdempotent
List Subscriptions
Inputs: id, altId, endAt, limit, +9 more.
payments_list_transactionsCRead-onlyIdempotent
List Transactions
Inputs: altId (required), altType (required), endAt, limit, +10 more.
payments_record_order_paymentC
Record Order Payment
Inputs: mode (required), orderId (required), card, meta, +6 more.
payments_update_couponCIdempotent
Update Coupon
Inputs: id (required), code (required), name (required), startDate (required), +10 more.
phone_system_active_numbersCRead-onlyIdempotent
List active numbers
Inputs: page, pageSize, locationId, searchFilter, +1 more.
phone_system_available_numbersCRead-onlyIdempotent
List available phone numbers
Inputs: countryCode (required), anywhere, lastPart, firstPart, +5 more.
phone_system_get_number_pool_listBRead-onlyIdempotent
List Number Pools
Inputs: locationId.
phone_system_purchase_phone_numberB
Purchase a phone number
Inputs: phoneNumber (required), region, locality, bundleSid, +6 more.
products_bulk_editC
Bulk Edit Products and Prices
Inputs: products (required), altId, altType.
products_bulk_updateD
Bulk Update Products
Inputs: type (required), productIds (required), altId, price, +6 more.
products_bulk_update_product_reviewC
Update Product Reviews
Inputs: status (required), reviews (required), altId, altType.
products_create_price_for_productB
Create Price for a Product
Inputs: name (required), type (required), amount (required), currency (required), +19 more.
products_create_productC
Create Product
Inputs: name (required), productType (required), seo, slug, +14 more.
products_create_product_collectionC
Create Product Collection
Inputs: name (required), slug (required), seo, altId, +3 more.
products_delete_price_by_id_for_productBDestructiveIdempotent
Delete Price by ID for a Product
Inputs: priceId (required), productId (required), locationId.
products_delete_product_by_idBDestructiveIdempotent
Delete Product by ID
Inputs: productId (required), locationId, sendWishlistStatus.
products_delete_product_collectionBDestructiveIdempotent
Delete Product Collection
Inputs: collectionId (required), altId, altType.
products_delete_product_reviewCDestructiveIdempotent
Delete Product Review
Inputs: reviewId (required), productId (required), altId, altType.
products_get_list_inventoryCRead-onlyIdempotent
List Inventory
Inputs: altId, limit, offset, search, +1 more.
products_get_price_by_id_for_productCRead-onlyIdempotent
Get Price by ID for a Product
Inputs: priceId (required), productId (required), locationId.
products_get_product_by_idCRead-onlyIdempotent
Get Product by ID
Inputs: productId (required), locationId, sendWishlistStatus.
products_get_product_collectionCRead-onlyIdempotent
Fetch Product Collections
Inputs: name, altId, limit, offset, +2 more.
products_get_product_collection_idCRead-onlyIdempotent
Get Details about individual product collection
Inputs: collectionId (required), altId.
products_get_product_reviewsCRead-onlyIdempotent
Fetch Product Reviews
Inputs: altId, limit, offset, rating, +7 more.
products_get_product_store_statsCRead-onlyIdempotent
Fetch Product Store Stats
Inputs: storeId (required), altId, search, altType, +1 more.
products_get_reviews_countDRead-onlyIdempotent
Fetch Review Count as per status
Inputs: altId, rating, altType, endDate, +3 more.
products_list_invoicesDRead-onlyIdempotent
List Products
Inputs: limit, expand, offset, search, +8 more.
products_list_prices_for_productARead-onlyIdempotent
List Prices for a Product
Inputs: productId (required), ids, limit, offset, +1 more.
products_update_display_priorityC
Update product display priorities in store
Inputs: storeId (required), products (required), altId, altType.
products_update_inventoryC
Update Inventory
Inputs: items (required), altId, altType.
products_update_price_by_id_for_productDIdempotent
Update Price by ID for a Product
Inputs: name (required), type (required), amount (required), priceId (required), +20 more.
products_update_product_by_idCIdempotent
Update Product by ID
Inputs: name (required), productId (required), productType (required), seo, +16 more.
products_update_product_collectionCIdempotent
Update Product Collection
Inputs: collectionId (required), seo, name, slug, +3 more.
products_update_product_reviewCIdempotent
Update Product Reviews
Inputs: status (required), reviewId (required), productId (required), altId, +5 more.
products_update_store_statusC
Action to include/exclude the product in store
Inputs: action (required), storeId (required), productIds (required), altId, +1 more.
proposals_list_documents_contractsDRead-onlyIdempotent
List documents
Inputs: skip, limit, query, dateTo, +4 more.
proposals_list_documents_contracts_templatesCRead-onlyIdempotent
List templates
Inputs: name, skip, type, limit, +5 more.
proposals_send_documents_contractsD
Send document
Inputs: sentBy (required), documentId (required), medium, locationId, +3 more.
proposals_send_documents_contracts_templateD
Send template
Inputs: userId (required), contactId (required), templateId (required), locationId, +2 more.
saas_api_bulk_disable_saasB
Disable SaaS for locations (requires an agency-level token, not a location PIT)
Inputs: companyId (required), locationIds (required).
saas_api_bulk_disable_saas_deprecatedB
Disable SaaS for locations (requires an agency-level token, not a location PIT)
Inputs: companyId (required), locationIds (required).
saas_api_bulk_enable_saasB
Bulk Enable SaaS (requires an agency-level token, not a location PIT)
Inputs: isSaaSV2 (required), companyId (required), locationIds (required), actionPayload (required).
saas_api_bulk_enable_saas_deprecatedC
Bulk Enable SaaS (requires an agency-level token, not a location PIT)
Inputs: isSaaSV2 (required), companyId (required), locationIds (required), actionPayload (required).
saas_api_enable_saas_locationA
Enable SaaS for Sub-Account (Formerly Location) (requires an agency-level token, not a location PIT)
Inputs: isSaaSV2 (required), companyId (required), name, email, +8 more.
saas_api_enable_saas_location_deprecatedB
Enable SaaS for Sub-Account (Formerly Location) (requires an agency-level token, not a location PIT)
Inputs: isSaaSV2 (required), companyId (required), name, email, +8 more.
saas_api_generate_payment_linkDIdempotent
Update SaaS subscription (requires an agency-level token, not a location PIT)
Inputs: companyId (required), customerId (required), subscriptionId (required), locationId.
saas_api_get_agency_plansBRead-onlyIdempotent
Get Agency Plans (requires an agency-level token, not a location PIT)
Inputs: companyId (required).
saas_api_get_agency_plans_deprecatedBRead-onlyIdempotent
Get Agency Plans (requires an agency-level token, not a location PIT)
Inputs: companyId (required).
saas_api_get_location_subscriptionARead-onlyIdempotent
Get Location Subscription Details (requires an agency-level token, not a location PIT)
Inputs: companyId (required), locationId.
saas_api_get_location_subscription_deprecatedARead-onlyIdempotent
Get Location Subscription Details (requires an agency-level token, not a location PIT)
Inputs: companyId (required), locationId.
saas_api_get_saas_locationsCRead-onlyIdempotent
Get SaaS Locations (requires an agency-level token, not a location PIT)
Inputs: page (required), companyId (required).
saas_api_get_saas_locations_deprecatedBRead-onlyIdempotent
Get SaaS Locations (requires an agency-level token, not a location PIT)
Inputs: companyId (required), page.
saas_api_get_saas_planARead-onlyIdempotent
Get SaaS Plan (requires an agency-level token, not a location PIT)
Inputs: planId (required), companyId (required).
saas_api_get_saas_plan_deprecatedARead-onlyIdempotent
Get SaaS Plan (requires an agency-level token, not a location PIT)
Inputs: planId (required), companyId (required).
saas_api_locationsBRead-onlyIdempotent
Get locations by stripeId with companyId (requires an agency-level token, not a location PIT)
Inputs: companyId (required), customerId (required), subscriptionId (required).
saas_api_locations_deprecatedARead-onlyIdempotent
Get locations by stripeId with companyId (requires an agency-level token, not a location PIT)
Inputs: companyId (required), customerId, subscriptionId.
saas_api_pause_locationB
Pause location (requires an agency-level token, not a location PIT)
Inputs: paused (required), companyId (required), locationId.
saas_api_pause_location_deprecatedA
Pause location (requires an agency-level token, not a location PIT)
Inputs: paused (required), companyId (required), locationId.
saas_api_update_rebillingB
Update Rebilling (requires an agency-level token, not a location PIT)
Inputs: config (required), product (required), companyId (required), locationIds (required).
saas_api_update_rebilling_deprecatedA
Update Rebilling (requires an agency-level token, not a location PIT)
Inputs: config (required), product (required), companyId (required), locationIds (required).
saas_api_update_saas_subscription_deprecatedBIdempotent
Update SaaS subscription (requires an agency-level token, not a location PIT)
Inputs: companyId (required), customerId (required), subscriptionId (required), locationId.
snapshots_get_custom_snapshotsCRead-onlyIdempotent
Get Snapshots (requires an agency-level token, not a location PIT)
Inputs: companyId (required).
snapshots_get_latest_snapshot_pushARead-onlyIdempotent
Get Last Snapshot Push (requires an agency-level token, not a location PIT)
Inputs: companyId (required), snapshotId (required), locationId.
snapshots_get_snapshot_pushBRead-onlyIdempotent
Get Snapshot Push between Dates (requires an agency-level token, not a location PIT)
Inputs: to (required), from (required), limit (required), lastDoc (required), +2 more.
social_media_posting_attach_instagram_page_groupD
Attach Instagram Professional Accounts
Inputs: pageId (required), accountId (required), name, avatar, +3 more.
social_media_posting_attach_linkedin_page_profileC
Attach linkedin pages and profile
Inputs: accountId (required), urn, name, type, +4 more.
social_media_posting_attach_tiktok_profileC
Attach Tiktok profile
Inputs: accountId (required), name, type, avatar, +5 more.
social_media_posting_attach_twitter_profileD
Attach Twitter profile
Inputs: accountId (required), name, avatar, originId, +5 more.
social_media_posting_bulk_delete_social_planner_postsC
Bulk Delete Social Planner Posts
Inputs: postIds, locationId.
social_media_posting_create_postD
Create post
Inputs: type (required), userId (required), accountIds (required), tags, +13 more.
social_media_posting_delete_accountCDestructiveIdempotent
Delete Account
Inputs: id (required), userId, companyId, locationId.
social_media_posting_delete_csvDDestructiveIdempotent
Delete CSV
Inputs: id (required), locationId.
social_media_posting_delete_csv_postBDestructiveIdempotent
Delete CSV Post
Inputs: csvId (required), postId (required), locationId.
social_media_posting_delete_postCDestructiveIdempotent
Delete Post
Inputs: id (required), locationId.
social_media_posting_edit_postCIdempotent
Edit post
Inputs: id (required), type (required), tags, media, +14 more.
social_media_posting_get_accountDRead-onlyIdempotent
Get Accounts
Inputs: locationId.
social_media_posting_get_categories_idCRead-onlyIdempotent
Get categories by id
Inputs: id (required), locationId.
social_media_posting_get_categories_location_idBRead-onlyIdempotent
Get categories by location id
Inputs: skip, limit, locationId, searchText.
social_media_posting_get_csv_postCRead-onlyIdempotent
Get CSV Post
Inputs: id (required), skip, limit, locationId.
social_media_posting_get_facebook_page_groupCRead-onlyIdempotent
Get facebook pages
Inputs: accountId (required), locationId.
social_media_posting_get_google_locationsCRead-onlyIdempotent
Get google business locations
Inputs: accountId (required), locationId.
social_media_posting_get_instagram_page_groupBRead-onlyIdempotent
Get Instagram Professional Accounts
Inputs: accountId (required), locationId.
social_media_posting_get_linkedin_page_profileCRead-onlyIdempotent
Get Linkedin pages and profile
Inputs: accountId (required), locationId.
social_media_posting_get_postCRead-onlyIdempotent
Get post
Inputs: id (required), locationId.
social_media_posting_get_postsCRead-only
Get posts
Inputs: skip (required), limit (required), toDate (required), fromDate (required), +5 more.
social_media_posting_get_social_media_statisticsCRead-only
Get Social Media Statistics
Inputs: profileIds (required), platforms, locationId.
social_media_posting_get_tags_by_idsBRead-only
Get tags by ids
Inputs: tagIds (required), locationId.
social_media_posting_get_tags_location_idCRead-onlyIdempotent
Get tags by location id
Inputs: skip, limit, locationId, searchText.
social_media_posting_get_tiktok_business_profileCRead-onlyIdempotent
Get Tiktok Business profile
Inputs: accountId (required), locationId.
social_media_posting_get_tiktok_profileCRead-onlyIdempotent
Get Tiktok profile
Inputs: accountId (required), locationId.
social_media_posting_get_twitter_profileBRead-onlyIdempotent
Get Twitter profile
Inputs: accountId (required), locationId.
social_media_posting_get_upload_statusDRead-onlyIdempotent
Get Upload Status
Inputs: skip, limit, userId, locationId, +1 more.
social_media_posting_set_accountsD
Set Accounts
Inputs: fileName (required), filePath (required), rowsCount (required), accountIds (required), +3 more.
social_media_posting_set_google_locationsC
Set google business locations
Inputs: accountId (required), account, location, companyId, +1 more.
social_media_posting_start_csv_finalizeD
Start CSV Finalize
Inputs: id (required), userId, locationId.
social_media_posting_start_facebook_oauthCRead-onlyIdempotent
Starts OAuth For Facebook Account
Inputs: userId (required), page, reconnect, locationId.
social_media_posting_start_google_oauthBRead-onlyIdempotent
Starts OAuth For Google Account
Inputs: userId (required), page, reconnect, locationId.
social_media_posting_start_instagram_oauthCRead-onlyIdempotent
Starts OAuth For Instagram Account
Inputs: userId (required), page, reconnect, locationId.
social_media_posting_start_linkedin_oauthCRead-onlyIdempotent
Starts OAuth For LinkedIn Account
Inputs: userId (required), page, reconnect, locationId.
social_media_posting_start_tiktok_business_oauthBRead-onlyIdempotent
Starts OAuth For Tiktok Business Account
Inputs: userId (required), page, reconnect, locationId.
social_media_posting_start_tiktok_oauthCRead-onlyIdempotent
Starts OAuth For Tiktok Account
Inputs: userId (required), page, reconnect, locationId.
social_media_posting_start_twitter_oauthCRead-onlyIdempotent
Starts OAuth For Twitter Account
Inputs: userId (required), page, reconnect, locationId.
store_create_shipping_carrierC
Create Shipping Carrier
Inputs: name (required), callbackUrl (required), altId, altType, +2 more.
store_create_shipping_rateC
Create Shipping Rate
Inputs: name (required), amount (required), currency (required), maxCondition (required), +10 more.
store_create_shipping_zoneC
Create Shipping Zone
Inputs: name (required), countries (required), altId, altType.
store_create_store_settingC
Create/Update Store Settings
Inputs: shippingOrigin (required), altId, altType, storeOrderNotification, +1 more.
store_delete_shipping_carrierCDestructiveIdempotent
Delete shipping carrier
Inputs: shippingCarrierId (required), altId, altType.
store_delete_shipping_rateCDestructiveIdempotent
Delete shipping rate
Inputs: shippingRateId (required), shippingZoneId (required), altId, altType.
store_delete_shipping_zoneBDestructiveIdempotent
Delete shipping zone
Inputs: shippingZoneId (required), altId, altType.
store_get_available_shipping_zonesCRead-only
Get available shipping rates
Inputs: source (required), country (required), products (required), totalOrderAmount (required), +7 more.
store_get_shipping_carriersBRead-onlyIdempotent
Get Shipping Carrier
Inputs: shippingCarrierId (required), altId, altType.
store_get_shipping_ratesCRead-onlyIdempotent
Get Shipping Rate
Inputs: shippingRateId (required), shippingZoneId (required), altId, altType.
store_get_shipping_zonesDRead-onlyIdempotent
Get Shipping Zone
Inputs: shippingZoneId (required), altId, altType, withShippingRate.
store_get_store_settingsBRead-onlyIdempotent
Get Store Settings
Inputs: altId, altType.
store_list_shipping_carriersCRead-onlyIdempotent
List Shipping Carriers
Inputs: altId, altType.
store_list_shipping_ratesDRead-onlyIdempotent
List Shipping Rates
Inputs: shippingZoneId (required), altId, limit, offset, +1 more.
store_list_shipping_zonesCRead-onlyIdempotent
List Shipping Zones
Inputs: altId, limit, offset, altType, +1 more.
store_update_shipping_carrierCIdempotent
Update Shipping Carrier
Inputs: shippingCarrierId (required), name, altId, altType, +3 more.
store_update_shipping_rateCIdempotent
Update Shipping Rate
Inputs: shippingRateId (required), shippingZoneId (required), name, altId, +11 more.
store_update_shipping_zoneCIdempotent
Update Shipping Zone
Inputs: shippingZoneId (required), name, altId, altType, +1 more.
surveys_get_surveysCRead-onlyIdempotent
Get Surveys
Inputs: skip, type, limit, locationId.
surveys_get_surveys_submissionsDRead-onlyIdempotent
Get Surveys Submissions
Inputs: q, page, endAt, limit, +3 more.
users_create_userD
Create User
Inputs: role (required), type (required), email (required), lastName (required), +11 more.
users_delete_userCDestructiveIdempotent
Delete User
Inputs: userId (required).
users_filter_users_by_emailARead-only
Filter Users by Email (requires an agency-level token, not a location PIT)
Inputs: emails (required), companyId (required), skip, limit, +2 more.
users_get_userDRead-onlyIdempotent
Get User
Inputs: userId (required).
users_get_user_by_locationDRead-onlyIdempotent
Get User by Location
Inputs: locationId.
users_search_usersCRead-onlyIdempotent
Search Users
Inputs: companyId (required), ids, role, skip, +7 more.
users_update_userCIdempotent
Update User
Inputs: userId (required), role, type, email, +12 more.
voice_ai_create_actionC
Create Agent Action
Inputs: name (required), agentId (required), actionType (required), actionParameters (required), +1 more.
voice_ai_create_agentD
Create Agent
Inputs: voiceId, language, timezone, agentName, +15 more.
voice_ai_delete_actionBDestructiveIdempotent
Delete Agent Action
Inputs: agentId (required), actionId (required), locationId.
voice_ai_delete_agentCDestructiveIdempotent
Delete Agent
Inputs: agentId (required), locationId.
voice_ai_get_actionCRead-onlyIdempotent
Get Agent Action
Inputs: actionId (required), locationId.
voice_ai_get_agentDRead-onlyIdempotent
Get Agent
Inputs: agentId (required), locationId.
voice_ai_get_agentsCRead-onlyIdempotent
List Agents
Inputs: page, query, pageSize, locationId.
voice_ai_get_call_logCRead-onlyIdempotent
Get Call Log
Inputs: callId (required), locationId.
voice_ai_get_call_logsCRead-onlyIdempotent
List Call Logs
Inputs: page, sort, sortBy, agentId, +7 more.
voice_ai_patch_agentD
Patch Agent
Inputs: agentId (required), voiceId, language, timezone, +16 more.
voice_ai_update_actionCIdempotent
Update Agent Action
Inputs: name (required), agentId (required), actionId (required), actionType (required), +2 more.
workflows_get_workflowDRead-onlyIdempotent
Get Workflow
Inputs: locationId.
Tool Schema Changelog
Recent tool additions, removals, and schema changes observed during successful MCP inspections.
Loading tool schema changelog…
TDQS
Scored across 569 tools
Many tools are cleanly separated by domain prefixes, but there are numerous exact deprecated duplicates (e.g. agent_studio_get_agent_by_id vs _deprecated, saas_api_get_saas_plan vs _deprecated), and cross-module pairs such as locations_create_custom_field/custom_fields_create_custom_field and emails_fetch_campaigns/campaigns_get_campaigns have identical descriptions. This makes misselection likely despite the mostly clear prefixes.
Tool names overwhelmingly follow a domain_prefix_verb_noun snake_case pattern (calendars_create_calendar, payments_delete_coupon), which is predictable. There are blemishes like the undocumented text2pay verb, deprecated suffixes, and a few mismatched descriptions/names (products_list_invoices says 'List Products'), but the convention is broadly consistent.
At 569 tools, this is an extreme count for an MCP server and far exceeds the 50+ threshold. Even though it wraps a broad platform, the surface is too large for an agent to navigate reliably.
Coverage is extensive across CRM, invoicing, products, ad management, social media, and SaaS, with many full CRUD lifecycles. However, several modules are read-only or one-off (campaigns_get_campaigns, forms_get_forms, surveys_get_surveys, courses_import_courses), creating notable gaps for those domains.
Related MCP Connectors
Automate GoHighLevel across CRM, messaging, calendars, marketing, e-commerce, and billing. Manage…
LeadConnector / GoHighLevel MCP Pack — wraps the GoHighLevel CRM for AI agents.
Operate the Plixana CRM from any AI: contacts, deals, quotes, WhatsApp and metrics.
Run B2B outreach from your AI agent: 250+ tools for campaigns, leads, LinkedIn and email workflows.
Related MCP Servers
- AlicenseNot gradedqualityDmaintenanceEnables AI assistants to interact with GoHighLevel's complete API including contacts, opportunities, calendars, workflows, communications, and business management tools. Supports both Bearer token and OAuth2 authentication with automatic token management.32 npm10MIT
- AlicenseNot gradedqualityBmaintenanceProvides access to over 460 tools within the GoHighLevel CRM, allowing AI assistants to manage contacts, opportunities, messaging, and business workflows through natural language.16 npm127ISC
- AlicenseNot gradedqualityDmaintenanceEnables AI assistants to interact with GoHighLevel's CRM, marketing automation, and business management tools via the API v2, with support for contacts, conversations, calendars, opportunities, payments, and workflows.70 npmMIT
- AlicenseNot gradedqualityBmaintenanceEnables AI assistants to directly interact with the entire GoHighLevel CRM via 563+ tools across 44 categories, allowing natural language control for contacts, messaging, opportunities, calendars, and more.16 npm1ISC
social_media_posting_attach_facebook_page_groupD
Attach facebook pages
Inputs: accountId (required), name, type, avatar, +3 more.