# HighLevel API v3 > Index of HighLevel API version v3: 812 endpoints in 46 services. Base URL https://services.leadconnectorhq.com. Each service links a compact file with every endpoint of that service; each endpoint links its full markdown page. - Send `Version: v3` on every request to use this version. - This is the latest version; use it unless a specific older version is required. - Full compact reference of this version in one file: https://marketplace.gohighlevel.com/docs/llms/v3/llms-full.txt ## ad-publishing - [ad-publishing: all 96 endpoints, compact](https://marketplace.gohighlevel.com/docs/llms/v3/ad-publishing.md): Ad Manager API v3 - [Add custom audience member](https://marketplace.gohighlevel.com/docs/ghl/ad-publishing/fb-add-custom-audience-member.md): PUT /ad-publishing/facebook/custom-audience/{customAudienceId}/member - Add a single contact to a Facebook custom audience. The contact is resolved from `contactId` and its identifiers are hashed before being sent to Meta. Use th... - [Batch update audience members](https://marketplace.gohighlevel.com/docs/ghl/ad-publishing/fb-batch-update-audience-members.md): PUT /ad-publishing/facebook/custom-audience/{customAudienceId}/member/batch - Add or remove members in bulk from a Facebook custom audience, sourced from a CSV or one or more smart lists — at least one of `csvPath` or `smartlistIds` is... - [Create conversation form](https://marketplace.gohighlevel.com/docs/ghl/ad-publishing/fb-create-conversation-form.md): POST /ad-publishing/facebook/conversation-forms - Create a Messenger conversation form. Note the created record is returned in its raw stored form rather than the shape the listing endpoint uses: the identif... - [Create Facebook integration](https://marketplace.gohighlevel.com/docs/ghl/ad-publishing/fb-create-integration.md): POST /ad-publishing/facebook/integration - Create a Facebook ad integration for a location with page and ad account - [Create page lead form](https://marketplace.gohighlevel.com/docs/ghl/ad-publishing/fb-create-page-lead-form.md): POST /ad-publishing/facebook/page/{pageId}/forms - Create a lead gen form. With `isDraft: true` the form is stored locally and returned as a draft; without it the form is published to Facebook and the Meta re... - [Delete ad](https://marketplace.gohighlevel.com/docs/ghl/ad-publishing/fb-delete-ad.md): DELETE /ad-publishing/facebook/ads/{adId} - Delete a Facebook ad by ID - [Delete ad account](https://marketplace.gohighlevel.com/docs/ghl/ad-publishing/fb-delete-ad-account.md): DELETE /ad-publishing/facebook/ad-accounts/{adAccountId} - Remove a Facebook ad account connection from a location - [Delete ad set](https://marketplace.gohighlevel.com/docs/ghl/ad-publishing/fb-delete-adset.md): DELETE /ad-publishing/facebook/adsets/{adSetId} - Delete a Facebook ad set by ID - [Delete campaign](https://marketplace.gohighlevel.com/docs/ghl/ad-publishing/fb-delete-campaign.md): DELETE /ad-publishing/facebook/campaigns/{campaignId} - Delete a Facebook campaign by ID - [Delete custom audience](https://marketplace.gohighlevel.com/docs/ghl/ad-publishing/fb-delete-custom-audience.md): DELETE /ad-publishing/facebook/custom-audience/{customAudienceId} - Delete a Facebook custom audience by ID - [Delete Facebook integration](https://marketplace.gohighlevel.com/docs/ghl/ad-publishing/fb-delete-integration.md): DELETE /ad-publishing/facebook/integration - Remove the Facebook ad integration from a location - [Delete page connection](https://marketplace.gohighlevel.com/docs/ghl/ad-publishing/fb-delete-page.md): DELETE /ad-publishing/facebook/page - Remove a Facebook page connection from a location. Deprecated: use DELETE /ad-publishing/facebook/pages/{pageId} with header version: v4. - [Duplicate ad](https://marketplace.gohighlevel.com/docs/ghl/ad-publishing/fb-duplicate-ad.md): POST /ad-publishing/facebook/ads/{adId}/duplicate - Duplicate an existing Facebook ad - [Duplicate ad set](https://marketplace.gohighlevel.com/docs/ghl/ad-publishing/fb-duplicate-adset.md): POST /ad-publishing/facebook/adsets/{adSetId}/duplicate - Duplicate an existing Facebook ad set - [Duplicate campaign](https://marketplace.gohighlevel.com/docs/ghl/ad-publishing/fb-duplicate-campaign.md): POST /ad-publishing/facebook/campaigns/{campaignId}/duplicate - Duplicate an existing Facebook campaign - [Get ad account details](https://marketplace.gohighlevel.com/docs/ghl/ad-publishing/fb-get-ad-account.md): GET /ad-publishing/facebook/ad-accounts/{adAccountId} - Retrieve details of a specific Facebook ad account - [Get ad accounts](https://marketplace.gohighlevel.com/docs/ghl/ad-publishing/fb-get-ad-accounts.md): GET /ad-publishing/facebook/ad-accounts - Retrieve Facebook ad accounts available for the connected user - [Get campaign with linked entities](https://marketplace.gohighlevel.com/docs/ghl/ad-publishing/fb-get-campaign.md): GET /ad-publishing/facebook/campaign/{campaignId} - Retrieve a Facebook campaign with its linked adsets and ads - [Get campaign publishing progress](https://marketplace.gohighlevel.com/docs/ghl/ad-publishing/fb-get-campaign-publishing-progress.md): GET /ad-publishing/facebook/campaigns/{campaignId}/publishing-progress - Returns Redis-backed publish progress for a campaign while it is publishing to Meta. Used by the validation funnel UI to poll step counts and completion state. - [Get campaign reporting](https://marketplace.gohighlevel.com/docs/ghl/ad-publishing/fb-get-campaign-reporting.md): GET /ad-publishing/facebook/reporting/campaign/{campaignId} - Retrieve reporting for one campaign as a flat object, not the `{ grouped, totals }` envelope the account-level report uses. Merges the locally stored campaig... - [Get conversation forms](https://marketplace.gohighlevel.com/docs/ghl/ad-publishing/fb-get-conversation-forms.md): GET /ad-publishing/facebook/conversation-forms - Retrieve Facebook conversation lead forms for a location. Without `limit` the response is a plain array. When `limit` is provided (max 100) the response is a... - [Get current Facebook user](https://marketplace.gohighlevel.com/docs/ghl/ad-publishing/fb-get-current-user.md): GET /ad-publishing/facebook/me - Retrieve the authenticated Facebook user profile for a location - [Get custom audience by ID](https://marketplace.gohighlevel.com/docs/ghl/ad-publishing/fb-get-custom-audience-by-id.md): GET /ad-publishing/facebook/custom-audience/{customAudienceId} - Retrieve one custom audience with its full detail. Returns more than the listing endpoint: Meta adds the fields relevant to the audience subtype (`retentionD... - [Get custom audiences](https://marketplace.gohighlevel.com/docs/ghl/ad-publishing/fb-get-custom-audiences.md): GET /ad-publishing/facebook/custom-audience - Retrieve Facebook custom audiences for a location. Without `limit` the response is a plain array. When `limit` is provided (max 100) the response is a pagina... - [Get entities](https://marketplace.gohighlevel.com/docs/ghl/ad-publishing/fb-get-entity.md): GET /ad-publishing/facebook/entity - Retrieve campaigns, ad sets, or ads for a location. `entityType` selects which, and each returns a `{ data }` envelope whose item shape differs — the id key... - [Get Instagram accounts for page](https://marketplace.gohighlevel.com/docs/ghl/ad-publishing/fb-get-instagram-accounts.md): GET /ad-publishing/facebook/page/{pageId}/instagram - Retrieve Instagram accounts linked to a specific Facebook page - [Get Facebook integration](https://marketplace.gohighlevel.com/docs/ghl/ad-publishing/fb-get-integration.md): GET /ad-publishing/facebook/integration - Retrieve the Facebook ad integration details for a location - [Get lead form by ID](https://marketplace.gohighlevel.com/docs/ghl/ad-publishing/fb-get-lead-form.md): GET /ad-publishing/facebook/lead-form/{leadFormId} - Retrieve a lead form by id. Pass `isDraft=true` to read an unpublished local draft instead, in which case `leadFormId` accepts either the bare id or the `dra... - [Get page lead forms](https://marketplace.gohighlevel.com/docs/ghl/ad-publishing/fb-get-page-lead-forms.md): GET /ad-publishing/facebook/page/{pageId}/forms - Retrieve lead gen forms for a specific Facebook page (published + drafts), sorted newest-first by `createdTime`. By default each form is returned in full (in... - [Get Facebook pages](https://marketplace.gohighlevel.com/docs/ghl/ad-publishing/fb-get-pages.md): GET /ad-publishing/facebook/pages - Retrieve Facebook pages for the connected account. Without `limit` the response is an array of pages (this array response will soon be deprecated — migrate t... - [Get conversion pixels](https://marketplace.gohighlevel.com/docs/ghl/ad-publishing/fb-get-pixels.md): GET /ad-publishing/facebook/pixels - Retrieve Facebook conversion pixels for a location. `channel` selects between two unrelated behaviours. For `FACEBOOK` (the default) the response is `{ items... - [Get reporting data](https://marketplace.gohighlevel.com/docs/ghl/ad-publishing/fb-get-reporting.md): GET /ad-publishing/facebook/reporting - Retrieve aggregated Facebook ad reporting metrics for a location. `grouped` holds one row per `groupBy` period, or a single row covering the whole range when... - [Get reporting list](https://marketplace.gohighlevel.com/docs/ghl/ad-publishing/fb-get-reporting-list.md): GET /ad-publishing/facebook/reporting/list - Retrieve campaigns, ad sets, or ads with their reporting metrics. `listType` selects the entity and changes the item shape; `adsets` and `ads` additionally r... - [Pause ad](https://marketplace.gohighlevel.com/docs/ghl/ad-publishing/fb-pause-ad.md): POST /ad-publishing/facebook/ads/{adId}/pause - Pause a running Facebook ad - [Pause ad set](https://marketplace.gohighlevel.com/docs/ghl/ad-publishing/fb-pause-adset.md): POST /ad-publishing/facebook/adsets/{adSetId}/pause - Pause a running Facebook ad set - [Pause campaign](https://marketplace.gohighlevel.com/docs/ghl/ad-publishing/fb-pause-campaign.md): POST /ad-publishing/facebook/campaigns/{campaignId}/pause - Pause a running Facebook campaign - [Publish campaign](https://marketplace.gohighlevel.com/docs/ghl/ad-publishing/fb-publish-campaign.md): POST /ad-publishing/facebook/campaigns/{campaignId}/publish - Queue a Facebook campaign for publishing and push it live to Facebook. Publishing runs asynchronously, so the campaign comes back in the state it was queued... - [Remove custom audience member](https://marketplace.gohighlevel.com/docs/ghl/ad-publishing/fb-remove-custom-audience-member.md): DELETE /ad-publishing/facebook/custom-audience/{customAudienceId}/member - Remove a single contact from a Facebook custom audience. Note this DELETE takes a request body carrying `locationId` and `contactId`, rather than identifying... - [Resume ad](https://marketplace.gohighlevel.com/docs/ghl/ad-publishing/fb-resume-ad.md): POST /ad-publishing/facebook/ads/{adId}/resume - Resume a paused Facebook ad - [Resume ad set](https://marketplace.gohighlevel.com/docs/ghl/ad-publishing/fb-resume-adset.md): POST /ad-publishing/facebook/adsets/{adSetId}/resume - Resume a paused Facebook ad set - [Resume campaign](https://marketplace.gohighlevel.com/docs/ghl/ad-publishing/fb-resume-campaign.md): POST /ad-publishing/facebook/campaigns/{campaignId}/resume - Resume a paused Facebook campaign - [Search targeting options](https://marketplace.gohighlevel.com/docs/ghl/ad-publishing/fb-search-targeting.md): GET /ad-publishing/facebook/targeting/search - Search Facebook targeting options for ad set audience building. `type` selects which taxonomy is searched and determines the response shape: `geolocation` re... - [Set default page](https://marketplace.gohighlevel.com/docs/ghl/ad-publishing/fb-set-default-page.md): PUT /ad-publishing/facebook/page/default - Set the default Facebook page for a location - [Update custom audience](https://marketplace.gohighlevel.com/docs/ghl/ad-publishing/fb-update-custom-audience.md): PUT /ad-publishing/facebook/custom-audience/{customAudienceId} - Rename a Facebook custom audience or change its description. Only those two fields can be updated; membership is changed through the member endpoints. The au... - [Upsert ad](https://marketplace.gohighlevel.com/docs/ghl/ad-publishing/fb-upsert-ad.md): PUT /ad-publishing/facebook/ads - Create or update a Facebook ad - [Upsert adset](https://marketplace.gohighlevel.com/docs/ghl/ad-publishing/fb-upsert-adset.md): PUT /ad-publishing/facebook/adsets - Create or update a Facebook ad set - [Upsert campaign](https://marketplace.gohighlevel.com/docs/ghl/ad-publishing/fb-upsert-campaign.md): PUT /ad-publishing/facebook/campaigns - Create or update a Facebook campaign - [Upsert conversion pixel](https://marketplace.gohighlevel.com/docs/ghl/ad-publishing/fb-upsert-pixel.md): PUT /ad-publishing/facebook/pixels - Create a Facebook conversion pixel, or rename an existing one by passing `conversionPixelId`. The two paths acknowledge differently: a create returns the new... - [Create Google integration](https://marketplace.gohighlevel.com/docs/ghl/ad-publishing/google-create-integration.md): POST /ad-publishing/google/integration - Create a Google Ads integration for a location - [Create offline user list job](https://marketplace.gohighlevel.com/docs/ghl/ad-publishing/google-create-offline-user-list-job.md): POST /ad-publishing/google/segments/offline-user-list-job - Create a job to upload users to a Google customer match list - [Delete ad account](https://marketplace.gohighlevel.com/docs/ghl/ad-publishing/google-delete-ad-account.md): DELETE /ad-publishing/google/ad-accounts/{adAccountId} - Remove a Google Ads account connection from a location - [Delete conversion](https://marketplace.gohighlevel.com/docs/ghl/ad-publishing/google-delete-conversion.md): DELETE /ad-publishing/google/conversions/{conversionId} - Delete a Google Ads conversion action by ID - [Delete segment](https://marketplace.gohighlevel.com/docs/ghl/ad-publishing/google-delete-segment.md): DELETE /ad-publishing/google/segments/{segmentId} - Delete a Google Ads audience segment by ID - [Get ad account details](https://marketplace.gohighlevel.com/docs/ghl/ad-publishing/google-get-ad-account-details.md): GET /ad-publishing/google/ad-accounts/{adAccountId} - Retrieve details of a specific Google Ads account - [Get Google ad accounts](https://marketplace.gohighlevel.com/docs/ghl/ad-publishing/google-get-ad-accounts.md): GET /ad-publishing/google/ad-accounts - Retrieve Google Ads accounts available for the connected user - [Get assets](https://marketplace.gohighlevel.com/docs/ghl/ad-publishing/google-get-assets.md): GET /ad-publishing/google/assets - Retrieve Google Ads creative assets for a location. Without `limit` the response is a plain array of assets. When `limit` is provided (max 100, default 100)... - [Get audience by ID](https://marketplace.gohighlevel.com/docs/ghl/ad-publishing/google-get-audience-by-id.md): GET /ad-publishing/google/audiences/{audienceId} - Retrieve a specific Google Ads combined audience by ID - [Get audiences](https://marketplace.gohighlevel.com/docs/ghl/ad-publishing/google-get-audiences.md): GET /ad-publishing/google/audiences - Retrieve Google Ads combined audiences for a location. Without `limit` the response is a plain array. When `limit` is provided (max 100, default 100) the res... - [Get Google campaign by ID](https://marketplace.gohighlevel.com/docs/ghl/ad-publishing/google-get-campaign-by-id.md): GET /ad-publishing/google/ads/{adId} - Retrieve a specific Google Ads campaign by ID - [Get campaign reporting](https://marketplace.gohighlevel.com/docs/ghl/ad-publishing/google-get-campaign-reporting.md): GET /ad-publishing/google/reporting/campaign/{campaignId} - Retrieve reporting metrics for a specific Google campaign - [Get conversion by ID](https://marketplace.gohighlevel.com/docs/ghl/ad-publishing/google-get-conversion-by-id.md): GET /ad-publishing/google/conversions/{conversionId} - Retrieve a specific Google Ads conversion action by ID - [Get conversion goals](https://marketplace.gohighlevel.com/docs/ghl/ad-publishing/google-get-conversion-goals.md): GET /ad-publishing/google/conversion-goals - Retrieve Google Ads conversion goals for a location. Without `limit` the response is a plain array. When `limit` is provided (max 100, default 100) the respo... - [Get conversions](https://marketplace.gohighlevel.com/docs/ghl/ad-publishing/google-get-conversions.md): GET /ad-publishing/google/conversions - Retrieve Google Ads conversion actions for a location. The response shape is selected by `type`. When `type` is `AD_MANAGER`: without `limit` a plain array o... - [Get current Google user](https://marketplace.gohighlevel.com/docs/ghl/ad-publishing/google-get-current-user.md): GET /ad-publishing/google/me - Retrieve the authenticated Google user info for a location - [Get entities](https://marketplace.gohighlevel.com/docs/ghl/ad-publishing/google-get-entity.md): GET /ad-publishing/google/entity - Retrieve Google campaigns, ad groups, or ads based on entity type - [Get Google integration](https://marketplace.gohighlevel.com/docs/ghl/ad-publishing/google-get-integration.md): GET /ad-publishing/google/integration - Retrieve the Google Ads integration details for a location - [Get keyword ideas](https://marketplace.gohighlevel.com/docs/ghl/ad-publishing/google-get-keyword-ideas.md): POST /ad-publishing/google/keyword-ideas - Retrieve keyword suggestions for Google Ads campaigns - [Get ad publishing progress](https://marketplace.gohighlevel.com/docs/ghl/ad-publishing/google-get-publishing-progress.md): GET /ad-publishing/google/ads/{adId}/publishing-progress - Returns Redis-backed publish progress for a Google campaign while it is publishing. Used by the publish progress UI to poll step counts and completion state. - [Get reporting data](https://marketplace.gohighlevel.com/docs/ghl/ad-publishing/google-get-reporting.md): GET /ad-publishing/google/reporting - Retrieve aggregated Google Ads reporting metrics for a location - [Get reporting list](https://marketplace.gohighlevel.com/docs/ghl/ad-publishing/google-get-reporting-list.md): GET /ad-publishing/google/reporting/list - Retrieve a list of Google campaigns or ad groups with reporting data. Deprecated: use GET /ad-publishing/google/reporting/rows with header version: v4. - [Get segment by ID](https://marketplace.gohighlevel.com/docs/ghl/ad-publishing/google-get-segment-by-id.md): GET /ad-publishing/google/segments/{segmentId} - Retrieve a specific Google Ads audience segment by ID - [Get segments](https://marketplace.gohighlevel.com/docs/ghl/ad-publishing/google-get-segments.md): GET /ad-publishing/google/segments - Retrieve Google Ads audience segments for a location. Without `limit` the response is a plain array. When `limit` is provided (max 100, default 100) the resp... - [Get target interests](https://marketplace.gohighlevel.com/docs/ghl/ad-publishing/google-get-target-interests.md): GET /ad-publishing/google/target-interests - Retrieve affinity and in-market audience options for Google Ads targeting. Without `limit` the response is a plain array of root interests (each with a neste... - [Publish ad](https://marketplace.gohighlevel.com/docs/ghl/ad-publishing/google-publish-ad.md): POST /ad-publishing/google/ads/{adId}/publish - Publish a Google ad and push it live - [Search targeting options](https://marketplace.gohighlevel.com/docs/ghl/ad-publishing/google-search-targeting.md): GET /ad-publishing/google/targeting/search - Search Google geo-locations for ad targeting - [Upsert assets](https://marketplace.gohighlevel.com/docs/ghl/ad-publishing/google-upsert-assets.md): POST /ad-publishing/google/assets - Create or update Google Ads creative assets - [Upsert audience](https://marketplace.gohighlevel.com/docs/ghl/ad-publishing/google-upsert-audience.md): PUT /ad-publishing/google/audiences - Create or update a Google Ads combined audience - [Upsert Google campaign](https://marketplace.gohighlevel.com/docs/ghl/ad-publishing/google-upsert-campaign.md): PUT /ad-publishing/google/ads - Create or update a full Google Ads campaign structure - [Upsert conversion](https://marketplace.gohighlevel.com/docs/ghl/ad-publishing/google-upsert-conversion.md): PUT /ad-publishing/google/conversions - Create or update a Google Ads conversion action - [Upsert segment](https://marketplace.gohighlevel.com/docs/ghl/ad-publishing/google-upsert-segment.md): PUT /ad-publishing/google/segments - Create or update a Google Ads audience segment - [Create LinkedIn integration](https://marketplace.gohighlevel.com/docs/ghl/ad-publishing/li-create-integration.md): POST /ad-publishing/linkedin/integration - Create a LinkedIn Ads integration for a location with ad account details - [Create lead form](https://marketplace.gohighlevel.com/docs/ghl/ad-publishing/li-create-lead-form.md): POST /ad-publishing/linkedin/{accountId}/form - Create a new LinkedIn lead gen form for an ad account. Deprecated: use POST /ad-publishing/linkedin/accounts/{accountId}/form with header version: v4. - [Delete ad account](https://marketplace.gohighlevel.com/docs/ghl/ad-publishing/li-delete-ad-account.md): DELETE /ad-publishing/linkedin/ad-account - Remove a LinkedIn ad account connection from a location. Deprecated: use DELETE /ad-publishing/linkedin/ad-accounts/{adAccountId} with header version: v4. - [Get ad account details](https://marketplace.gohighlevel.com/docs/ghl/ad-publishing/li-get-ad-account-details.md): GET /ad-publishing/linkedin/ad-account - Retrieve details of a specific LinkedIn ad account. Deprecated: use GET /ad-publishing/linkedin/ad-accounts/{adAccountId} with header version: v4. - [Get LinkedIn ad accounts](https://marketplace.gohighlevel.com/docs/ghl/ad-publishing/li-get-ad-accounts.md): GET /ad-publishing/linkedin/ad-accounts - Retrieve LinkedIn Ads accounts available for the connected user - [Get ad analytics](https://marketplace.gohighlevel.com/docs/ghl/ad-publishing/li-get-ad-analytics.md): GET /ad-publishing/linkedin/reporting - Retrieve LinkedIn Ads analytics data with configurable pivot and time grouping - [Get ad campaign group](https://marketplace.gohighlevel.com/docs/ghl/ad-publishing/li-get-campaign-group.md): GET /ad-publishing/linkedin/ads/{adId} - Retrieve a LinkedIn ad campaign group by ID - [Get campaign group reporting](https://marketplace.gohighlevel.com/docs/ghl/ad-publishing/li-get-campaign-group-reporting.md): GET /ad-publishing/linkedin/reporting/campaign-group/{campaignGroupId} - Retrieve reporting metrics for a specific LinkedIn campaign group - [Get current LinkedIn user](https://marketplace.gohighlevel.com/docs/ghl/ad-publishing/li-get-current-user.md): GET /ad-publishing/linkedin/me - Retrieve the authenticated LinkedIn user info for a location - [Get LinkedIn integration](https://marketplace.gohighlevel.com/docs/ghl/ad-publishing/li-get-integration.md): GET /ad-publishing/linkedin/integration - Retrieve the LinkedIn Ads integration details for a location - [Get lead forms](https://marketplace.gohighlevel.com/docs/ghl/ad-publishing/li-get-lead-forms.md): GET /ad-publishing/linkedin/{accountId}/forms - Retrieve LinkedIn lead gen forms for an ad account. By default each form is returned in full as a plain array; pass `projection` (comma-separated, dot-notati... - [Get reporting list](https://marketplace.gohighlevel.com/docs/ghl/ad-publishing/li-get-reporting-list.md): GET /ad-publishing/linkedin/reporting/list - Retrieve a list of LinkedIn campaigns or campaign groups with reporting data. Deprecated: use GET /ad-publishing/linkedin/reporting/rows with header version:... - [Publish ad campaign group](https://marketplace.gohighlevel.com/docs/ghl/ad-publishing/li-publish-campaign-group.md): POST /ad-publishing/linkedin/ads/{adId}/publish - Publish a LinkedIn ad campaign group and push it live - [Search targeting options](https://marketplace.gohighlevel.com/docs/ghl/ad-publishing/li-search-targeting.md): GET /ad-publishing/linkedin/targeting/search - Search LinkedIn targeting facets such as locations, industries, and job titles - [Update ad status](https://marketplace.gohighlevel.com/docs/ghl/ad-publishing/li-update-ad-status.md): PATCH /ad-publishing/linkedin/{adId}/status - Pause or resume a LinkedIn ad, campaign, or ad group. Deprecated: use PATCH /ad-publishing/linkedin/ads/{adId}/status with header version: v4. - [Upsert ad campaign group](https://marketplace.gohighlevel.com/docs/ghl/ad-publishing/li-upsert-campaign-group.md): PUT /ad-publishing/linkedin/ads - Create or update a LinkedIn ad campaign group with campaigns and ads ## affiliate-manager - [affiliate-manager: all 32 endpoints, compact](https://marketplace.gohighlevel.com/docs/llms/v3/affiliate-manager.md): Affiliate Manager API v3 - [Create Affiliate](https://marketplace.gohighlevel.com/docs/ghl/affiliate-manager/create-affiliate.md): POST /affiliate-manager/{locationId}/affiliates - Create an affiliate for a location. An affiliate already registered with the same email in this location is updated instead of duplicated. - [Create commission](https://marketplace.gohighlevel.com/docs/ghl/affiliate-manager/create-commission.md): POST /affiliate-manager/{locationId}/commission - Create a manual commission for a customer. - [Create customer lead](https://marketplace.gohighlevel.com/docs/ghl/affiliate-manager/create-customer-lead.md): POST /affiliate-manager/{locationId}/affiliates/{affiliateId}/lead/create - Create or update a lead for an affiliate customer. - [Create Payout Method](https://marketplace.gohighlevel.com/docs/ghl/affiliate-manager/create-payout-method.md): POST /affiliate-manager/{locationId}/affiliate/{affiliateId}/payout-method - Store a payout method for an affiliate. An affiliate can hold one PayPal and one bank method; the first method stored becomes the primary one. Bank fields ar... - [Delete affiliate media](https://marketplace.gohighlevel.com/docs/ghl/affiliate-manager/delete-affiliate-media.md): DELETE /affiliate-manager/{locationId}/media/{mediaId} - Delete a media file or folder for a location. - [Delete commission](https://marketplace.gohighlevel.com/docs/ghl/affiliate-manager/delete-commission.md): DELETE /affiliate-manager/{locationId}/commission/{commissionId} - Delete a commission and update its associated payout. - [Delete customer](https://marketplace.gohighlevel.com/docs/ghl/affiliate-manager/delete-customer.md): DELETE /affiliate-manager/{locationId}/affiliates/{affiliateId}/customer/{customerId} - Delete a lead or customer for an affiliate. - [Delete Payout Method](https://marketplace.gohighlevel.com/docs/ghl/affiliate-manager/delete-payout-method.md): DELETE /affiliate-manager/{locationId}/affiliate/{affiliateId}/payout-method/{payoutMethodId} - Delete a payout method. The primary method cannot be deleted while the affiliate holds more than one. - [Deny commission](https://marketplace.gohighlevel.com/docs/ghl/affiliate-manager/deny-commission.md): PUT /affiliate-manager/{locationId}/commission/{commissionId}/deny - Deny a commission and move its payout to denied status. - [Get Affiliate](https://marketplace.gohighlevel.com/docs/ghl/affiliate-manager/get-affiliate.md): GET /affiliate-manager/{locationId}/affiliates/{affiliateId} - Retrieve a single affiliate by id for a location. - [Get Campaign](https://marketplace.gohighlevel.com/docs/ghl/affiliate-manager/get-campaign.md): GET /affiliate-manager/{locationId}/campaigns/{campaignId} - Retrieve a single affiliate campaign by id for a location. - [List affiliate media](https://marketplace.gohighlevel.com/docs/ghl/affiliate-manager/list-affiliate-media.md): GET /affiliate-manager/{locationId}/media - Retrieve media files and folders for a location. - [List Affiliates](https://marketplace.gohighlevel.com/docs/ghl/affiliate-manager/list-affiliates.md): GET /affiliate-manager/{locationId}/affiliates - Retrieve the list of affiliates for a location. - [List Campaigns](https://marketplace.gohighlevel.com/docs/ghl/affiliate-manager/list-campaigns.md): GET /affiliate-manager/{locationId}/campaigns - Retrieve the list of affiliate campaigns for a location. - [List Commissions](https://marketplace.gohighlevel.com/docs/ghl/affiliate-manager/list-commissions.md): GET /affiliate-manager/{locationId}/commissions - Retrieve the list of commissions for a location. - [List Country Bank Mappings](https://marketplace.gohighlevel.com/docs/ghl/affiliate-manager/list-country-bank-mappings.md): GET /affiliate-manager/{locationId}/country-bank-mapping - List the bank fields each supported country requires, for building a bank payout method. This is shared reference data, identical for every location. - [List customers](https://marketplace.gohighlevel.com/docs/ghl/affiliate-manager/list-customers.md): GET /affiliate-manager/{locationId}/affiliates/{affiliateId}/customers - Retrieve the list of customers for an affiliate. - [List Payout Methods](https://marketplace.gohighlevel.com/docs/ghl/affiliate-manager/list-payout-methods.md): GET /affiliate-manager/{locationId}/affiliate/{affiliateId}/payout-method - List the payout methods stored for an affiliate. Bank account values are returned as their last four characters only. - [List Payouts](https://marketplace.gohighlevel.com/docs/ghl/affiliate-manager/list-payouts.md): GET /affiliate-manager/{locationId}/payouts - Retrieve the list of payouts for a location. - [Mark Payout Method As Primary](https://marketplace.gohighlevel.com/docs/ghl/affiliate-manager/mark-payout-method-primary.md): PATCH /affiliate-manager/{locationId}/affiliate/{affiliateId}/payout-method/{payoutMethodId}/primary - Make this payout method the one payouts default to. Any other method stops being primary. - [Move Affiliate To Campaign](https://marketplace.gohighlevel.com/docs/ghl/affiliate-manager/move-affiliate-campaign.md): POST /affiliate-manager/affiliate-campaign/{locationId}/affiliate/{affiliateId}/move-campaign - Move an affiliate from one campaign to another. The target campaign must be live and belong to the same location, and the affiliate must not already be enrol... - [Update Affiliate](https://marketplace.gohighlevel.com/docs/ghl/affiliate-manager/update-affiliate.md): PUT /affiliate-manager/{locationId}/affiliates/{affiliateId} - Replace an affiliate for a location. Fields omitted from the body are cleared, so send the complete affiliate. - [Update affiliate media](https://marketplace.gohighlevel.com/docs/ghl/affiliate-manager/update-affiliate-media.md): PUT /affiliate-manager/{locationId}/media/{mediaId} - Update a media file or folder for a location. - [Update Affiliate Referral Id](https://marketplace.gohighlevel.com/docs/ghl/affiliate-manager/update-affiliate-referral-id.md): PUT /affiliate-manager/affiliate-campaign/{locationId}/affiliate/{affiliateId}/referral-id - Set the referral id an affiliate is tracked by on a campaign. The referral link is rebuilt around the new id, and the id must be unused across the location. - [Update Affiliate Status](https://marketplace.gohighlevel.com/docs/ghl/affiliate-manager/update-affiliate-status.md): PUT /affiliate-manager/{locationId}/affiliates/{affiliateId}/status - Activate or deactivate an affiliate. Sending the same value again leaves the affiliate unchanged. - [Update Affiliate Suspension](https://marketplace.gohighlevel.com/docs/ghl/affiliate-manager/update-affiliate-suspension.md): PUT /affiliate-manager/affiliate-campaign/{locationId}/campaign/{campaignId}/affiliate/{affiliateId}/suspension - Suspend or reinstate an affiliate on a campaign. Suspending cancels their pending and denied payouts, commissions and transactions; reinstating returns cance... - [Update commission status](https://marketplace.gohighlevel.com/docs/ghl/affiliate-manager/update-commission-status.md): PUT /affiliate-manager/{locationId}/commission/{commissionId}/status - Update the status of a commission and its associated payout. - [Update customer state](https://marketplace.gohighlevel.com/docs/ghl/affiliate-manager/update-customer-state.md): PATCH /affiliate-manager/{locationId}/affiliates/{affiliateId}/customers/{customerId}/state - Update the disabled state of a customer for an affiliate. - [Update Payout Method](https://marketplace.gohighlevel.com/docs/ghl/affiliate-manager/update-payout-method.md): PUT /affiliate-manager/{locationId}/affiliate/{affiliateId}/payout-method/{payoutMethodId} - Replace the stored details of a payout method. The payout method type cannot be changed, and the method must belong to the affiliate named in the path. - [Upload affiliate tax form](https://marketplace.gohighlevel.com/docs/ghl/affiliate-manager/upload-affiliate-tax-form.md): POST /affiliate-manager/{locationId}/affiliates/{affiliateId}/tax-form - Upload a W-8 or W-9 document for an affiliate. Send the document as multipart/form-data; the storage location is assigned by the server. - [Validate customer lead](https://marketplace.gohighlevel.com/docs/ghl/affiliate-manager/validate-customer-lead.md): GET /affiliate-manager/{locationId}/affiliates/{affiliateId}/lead/validate - Check whether a lead already exists for an affiliate customer. - [Validate Referral Id](https://marketplace.gohighlevel.com/docs/ghl/affiliate-manager/validate-referral-id.md): GET /affiliate-manager/affiliate-campaign/{locationId}/referral-id/validate - Check whether a referral id is free to use. Referral ids are unique across a location, so a taken id reports as unavailable even when it belongs to a differe... ## agent-studio - [agent-studio: all 14 endpoints, compact](https://marketplace.gohighlevel.com/docs/llms/v3/agent-studio.md): Agent Studio APIs - [Create Agent](https://marketplace.gohighlevel.com/docs/ghl/agent-studio/create-agent.md): POST /agent-studio/agent - Creates a new agent with staging version. The agent will be created with an initial staging version that can later be promoted to production. - [Delete Agent](https://marketplace.gohighlevel.com/docs/ghl/agent-studio/delete-agent.md): DELETE /agent-studio/agent/{agentId} - Deletes an agent and all its versions. - [Execute Agent](https://marketplace.gohighlevel.com/docs/ghl/agent-studio/execute-agent.md): POST /agent-studio/agent/{agentId}/execute - Executes the specified agent and returns a non-streaming JSON response with the complete agent output. The agent must be in active status and belong to the s... - [Execute Agent (Deprecated)](https://marketplace.gohighlevel.com/docs/ghl/agent-studio/execute-agent-deprecated.md): POST /agent-studio/public-api/agents/{agentId}/execute - **Deprecated endpoint - use POST /agent/:agentId/execute instead.** - [Execute a published Managed Agent](https://marketplace.gohighlevel.com/docs/ghl/agent-studio/execute-managed-agent.md): POST /agent-studio/managed-agents/{managedAgentId}/execute - Runs one JSON turn against the published production snapshot. Omit sessionId on the first turn and pass the returned sessionId on subsequent turns. Reuse the... - [Get Agent](https://marketplace.gohighlevel.com/docs/ghl/agent-studio/get-agent-by-id.md): GET /agent-studio/agent/{agentId} - Gets a specific agent by its ID for the specified location with all its versions. Returns complete agent metadata and all non-deleted versions (draft, stagin... - [Get Agent (Deprecated)](https://marketplace.gohighlevel.com/docs/ghl/agent-studio/get-agent-by-id-deprecated.md): GET /agent-studio/public-api/agents/{agentId} - **Deprecated endpoint - use GET /agent/:agentId instead.** - [List Agents](https://marketplace.gohighlevel.com/docs/ghl/agent-studio/get-agents.md): GET /agent-studio/agent - Lists all active agents for the specified location. locationId is required parameter to ensure optimal performance. Supports pagination using limit and offse... - [List Agents (Deprecated)](https://marketplace.gohighlevel.com/docs/ghl/agent-studio/get-agents-deprecated.md): GET /agent-studio/public-api/agents - **Deprecated endpoint - use GET /agent instead.** - [Get a published Managed Agent](https://marketplace.gohighlevel.com/docs/ghl/agent-studio/get-managed-agent.md): GET /agent-studio/managed-agents/{managedAgentId} - Returns public metadata for a published production Managed Agent. Unknown, unpublished, and cross-location identifiers return 404. - [List published Managed Agents](https://marketplace.gohighlevel.com/docs/ghl/agent-studio/list-managed-agents.md): GET /agent-studio/managed-agents - Returns only Managed Agents with a published production version in the authorized sub-account. - [Promote to Production](https://marketplace.gohighlevel.com/docs/ghl/agent-studio/promote-and-publish.md): POST /agent-studio/agent/versions/{versionId}/publish - Promotes a draft version to production. - [Update Agent Metadata](https://marketplace.gohighlevel.com/docs/ghl/agent-studio/update-agent-metadata.md): PATCH /agent-studio/agent/{agentId} - Updates agent metadata such as name, description, and status. - [Update Agent](https://marketplace.gohighlevel.com/docs/ghl/agent-studio/update-agent-version.md): PATCH /agent-studio/agent/versions/{versionId} - Updates a specific agent version by versionId. Supports updating nodes, edges, variables, and configuration. ## associations - [associations: all 10 endpoints, compact](https://marketplace.gohighlevel.com/docs/llms/v3/associations.md): Associations API - [Create Association](https://marketplace.gohighlevel.com/docs/ghl/associations/create-association.md): POST /associations/ - Allow you to create contact - contact , contact - custom objects and business - contact associations, will add more in the future.Documentation Link - https:... - [Create Relation for you associated entities.](https://marketplace.gohighlevel.com/docs/ghl/associations/create-relation.md): POST /associations/relations - Create Relation.Documentation Link - https://doc.clickup.com/8631005/d/h/87cpx-293776/cd0f4122abc04d3 - [Delete Association](https://marketplace.gohighlevel.com/docs/ghl/associations/delete-association.md): DELETE /associations/{associationId} - Delete USER_DEFINED Association By Id, deleting an association will also all the relations for that association - [Delete Relation](https://marketplace.gohighlevel.com/docs/ghl/associations/delete-relation.md): DELETE /associations/relations/{relationId} - [Get all associations for a sub-account / location](https://marketplace.gohighlevel.com/docs/ghl/associations/find-associations.md): GET /associations/ - Get all Associations - [Get association by ID](https://marketplace.gohighlevel.com/docs/ghl/associations/get-association-by-id.md): GET /associations/{associationId} - Using this api you can get SYSTEM_DEFINED / USER_DEFINED association by id - [Get association by object keys](https://marketplace.gohighlevel.com/docs/ghl/associations/get-association-by-object-keys.md): GET /associations/objectKey/{objectKey} - Get association by object keys like contacts, custom objects and opportunities. Documentation Link - https://doc.clickup.com/8631005/d/h/87cpx-293776/cd0f412... - [Get association key by key name](https://marketplace.gohighlevel.com/docs/ghl/associations/get-association-key-by-key-name.md): GET /associations/key/{key_name} - Using this api you can get standard / user defined association by key - [Get all relations By record Id](https://marketplace.gohighlevel.com/docs/ghl/associations/get-relations-by-record-id.md): GET /associations/relations/{recordId} - Get all relations by record Id - [Update Association By Id](https://marketplace.gohighlevel.com/docs/ghl/associations/update-association.md): PUT /associations/{associationId} - Update Association , Allows you to update labels of an associations. Documentation Link - https://doc.clickup.com/8631005/d/h/87cpx-293776/cd0f4122abc04d3 ## blogs - [blogs: all 8 endpoints, compact](https://marketplace.gohighlevel.com/docs/llms/v3/blogs.md): Blogs API - [Check url slug](https://marketplace.gohighlevel.com/docs/ghl/blogs/check-url-slug-exists.md): GET /blogs/posts/url-slug-exists - The "Check url slug" API checks whether a blog post url slug is already in use for the location. Call it before publishing a blog post. - [Create Blog Post](https://marketplace.gohighlevel.com/docs/ghl/blogs/create-blog-post.md): POST /blogs/posts - The "Create Blog Post" API allows you to create a blog post for any given blog site. - [Get all blog authors](https://marketplace.gohighlevel.com/docs/ghl/blogs/get-all-blog-authors-by-location.md): GET /blogs/authors - The "Get all blog authors" API returns the blog authors for a given location ID. - [Get all blog categories](https://marketplace.gohighlevel.com/docs/ghl/blogs/get-all-categories-by-location.md): GET /blogs/categories - The "Get all blog categories" API returns the blog categories for a given location ID. - [Get Blog posts by Blog ID](https://marketplace.gohighlevel.com/docs/ghl/blogs/get-blog-post.md): GET /blogs/posts/all - The "Get Blog posts by Blog ID" API returns the blog posts for a given blog site. Use searchTerm to search across post title, description, url slug and categ... - [Get Blog Post by ID](https://marketplace.gohighlevel.com/docs/ghl/blogs/get-blog-post-by-id.md): GET /blogs/posts/post/{postId} - The "Get Blog Post by ID" API returns a single published blog post, including its content/body, for the given location. - [Get Blogs by Location ID](https://marketplace.gohighlevel.com/docs/ghl/blogs/get-blogs.md): GET /blogs/site/all - The "Get Blogs by Location ID" API allows you get blogs using Location ID. - [Update Blog Post](https://marketplace.gohighlevel.com/docs/ghl/blogs/update-blog-post.md): PUT /blogs/posts/{postId} - The "Update Blog Post" API updates an existing blog post for any given blog site. ## brand-boards - [brand-boards: all 12 endpoints, compact](https://marketplace.gohighlevel.com/docs/llms/v3/brand-boards.md): Brand Boards API v3 - [Create Brand Voice](https://marketplace.gohighlevel.com/docs/ghl/brand-boards/create-brand-voice.md): POST /brand-boards/locations/{locationId}/brand-voices - Create a brand voice for a location - [Create Design Kit](https://marketplace.gohighlevel.com/docs/ghl/brand-boards/create-design-kit.md): POST /brand-boards/locations/{locationId}/design-kits - Create a design kit for a location - [Delete Brand Voice](https://marketplace.gohighlevel.com/docs/ghl/brand-boards/delete-brand-voice.md): DELETE /brand-boards/locations/{locationId}/brand-voices/{brandVoiceId} - Delete a brand voice by ID - [Delete Design Kit](https://marketplace.gohighlevel.com/docs/ghl/brand-boards/delete-design-kit.md): DELETE /brand-boards/locations/{locationId}/design-kits/{designKitId} - Delete a design kit by ID - [Get Brand Voice](https://marketplace.gohighlevel.com/docs/ghl/brand-boards/get-brand-voice.md): GET /brand-boards/locations/{locationId}/brand-voices/{brandVoiceId} - Get a brand voice by ID - [Get Design Kit](https://marketplace.gohighlevel.com/docs/ghl/brand-boards/get-design-kit.md): GET /brand-boards/locations/{locationId}/design-kits/{designKitId} - Get a design kit by ID - [List Brand Voices](https://marketplace.gohighlevel.com/docs/ghl/brand-boards/list-brand-voices.md): GET /brand-boards/locations/{locationId}/brand-voices - Get list of brand voices for a location - [List Design Kits](https://marketplace.gohighlevel.com/docs/ghl/brand-boards/list-design-kits.md): GET /brand-boards/locations/{locationId}/design-kits - Get list of design kits for a location - [Set Default Brand Voice](https://marketplace.gohighlevel.com/docs/ghl/brand-boards/set-default-brand-voice.md): POST /brand-boards/locations/{locationId}/brand-voices/{brandVoiceId}/default - Set a brand voice as the default for a location. The previous default will be unset. - [Set Default Design Kit](https://marketplace.gohighlevel.com/docs/ghl/brand-boards/set-default-design-kit.md): POST /brand-boards/locations/{locationId}/design-kits/{designKitId}/default - Set a design kit as the default for a location. The previous default will be unset. - [Update Brand Voice](https://marketplace.gohighlevel.com/docs/ghl/brand-boards/update-brand-voice.md): PATCH /brand-boards/locations/{locationId}/brand-voices/{brandVoiceId} - Update a brand voice by ID - [Update Design Kit](https://marketplace.gohighlevel.com/docs/ghl/brand-boards/update-design-kit.md): PATCH /brand-boards/locations/{locationId}/design-kits/{designKitId} - Update a design kit by ID ## businesses - [businesses: all 5 endpoints, compact](https://marketplace.gohighlevel.com/docs/llms/v3/businesses.md): Business API - [Create Business](https://marketplace.gohighlevel.com/docs/ghl/businesses/create-business.md): POST /businesses/ - [Delete Business](https://marketplace.gohighlevel.com/docs/ghl/businesses/delete-business.md): DELETE /businesses/{businessId} - [Get Business](https://marketplace.gohighlevel.com/docs/ghl/businesses/get-business.md): GET /businesses/{businessId} - [Get Businesses by Location](https://marketplace.gohighlevel.com/docs/ghl/businesses/get-businesses-by-location.md): GET /businesses/ - [Update Business](https://marketplace.gohighlevel.com/docs/ghl/businesses/update-business.md): PUT /businesses/{businessId} ## calendars - [calendars: all 59 endpoints, compact](https://marketplace.gohighlevel.com/docs/llms/v3/calendars.md): Calendars API - [Apply user availability schedule to a calendar](https://marketplace.gohighlevel.com/docs/ghl/calendars/add-calendar-to-schedule.md): PUT /calendars/schedules/{id}/associations/{calendarId} - Associates a calendar with the given schedule by adding the calendarId to a schedule - [Create appointment](https://marketplace.gohighlevel.com/docs/ghl/calendars/create-appointment.md): POST /calendars/events/appointments - [Create Note](https://marketplace.gohighlevel.com/docs/ghl/calendars/create-appointment-note.md): POST /calendars/appointments/{appointmentId}/notes - [Create Block Slot](https://marketplace.gohighlevel.com/docs/ghl/calendars/create-block-slot.md): POST /calendars/events/block-slots - Create block slot - [Create Calendar](https://marketplace.gohighlevel.com/docs/ghl/calendars/create-calendar.md): POST /calendars/ - Create calendar in a location. - [Create Calendar Group](https://marketplace.gohighlevel.com/docs/ghl/calendars/create-calendar-group.md): POST /calendars/groups - [Create Calendar Resource](https://marketplace.gohighlevel.com/docs/ghl/calendars/create-calendar-resource.md): POST /calendars/resources/{resourceType} - Create calendar resource by resource type (Services V1) - [Create event calendar availability schedule](https://marketplace.gohighlevel.com/docs/ghl/calendars/create-calendar-schedule.md): POST /calendars/schedules/event-calendar/{calendarId} - Create a new availability schedule specifically for an event calendar. The calendar ID is provided in the path, and schedule rules and timezone are provided... - [Create notification](https://marketplace.gohighlevel.com/docs/ghl/calendars/create-event-notification.md): POST /calendars/{calendarId}/notifications - Create Calendar notifications, either one or multiple. All notification settings must be for single calendar only - [Create user availability schedule](https://marketplace.gohighlevel.com/docs/ghl/calendars/create-schedule.md): POST /calendars/schedules - Create new schedule with specified rules, timezone, location, user and calendar associations. - [Create Service Booking](https://marketplace.gohighlevel.com/docs/ghl/calendars/create-service-booking.md): POST /calendars/services/bookings - Create a new service booking - [Create Service](https://marketplace.gohighlevel.com/docs/ghl/calendars/create-service-catalog.md): POST /calendars/services/catalog - Create new service in a location. - [Create Service Location](https://marketplace.gohighlevel.com/docs/ghl/calendars/create-service-location.md): POST /calendars/services/locations - Create a new service location - [Delete Note](https://marketplace.gohighlevel.com/docs/ghl/calendars/delete-appointment-note.md): DELETE /calendars/appointments/{appointmentId}/notes/{noteId} - [Delete Calendar](https://marketplace.gohighlevel.com/docs/ghl/calendars/delete-calendar.md): DELETE /calendars/{calendarId} - Delete calendar by ID - [Delete Calendar Resource](https://marketplace.gohighlevel.com/docs/ghl/calendars/delete-calendar-resource.md): DELETE /calendars/resources/{resourceType}/{id} - Delete calendar resource by ID (Services V1) - [Delete Event](https://marketplace.gohighlevel.com/docs/ghl/calendars/delete-event.md): DELETE /calendars/events/{eventId} - Delete event by ID - [Delete Notification](https://marketplace.gohighlevel.com/docs/ghl/calendars/delete-event-notification.md): DELETE /calendars/{calendarId}/notifications/{notificationId} - Delete notification - [Delete Group](https://marketplace.gohighlevel.com/docs/ghl/calendars/delete-group.md): DELETE /calendars/groups/{groupId} - [Delete user availability schedule](https://marketplace.gohighlevel.com/docs/ghl/calendars/delete-schedule.md): DELETE /calendars/schedules/{id} - Permanently remove a schedule and all its associated rules. This action cannot be undone. - [Delete Service Booking](https://marketplace.gohighlevel.com/docs/ghl/calendars/delete-service-booking.md): DELETE /calendars/services/bookings/{bookingId} - Delete a service booking by ID - [Delete Service](https://marketplace.gohighlevel.com/docs/ghl/calendars/delete-service-catalog.md): DELETE /calendars/services/catalog/{serviceId} - Delete service by ID. - [Delete Service Location](https://marketplace.gohighlevel.com/docs/ghl/calendars/delete-service-location.md): DELETE /calendars/services/locations/{serviceLocationId} - Delete a service location by ID - [Disable Group](https://marketplace.gohighlevel.com/docs/ghl/calendars/disable-group.md): PUT /calendars/groups/{groupId}/status - [Update Appointment](https://marketplace.gohighlevel.com/docs/ghl/calendars/edit-appointment.md): PUT /calendars/events/appointments/{eventId} - Update appointment - [Update Block Slot](https://marketplace.gohighlevel.com/docs/ghl/calendars/edit-block-slot.md): PUT /calendars/events/block-slots/{eventId} - Update block slot by ID - [Update Group](https://marketplace.gohighlevel.com/docs/ghl/calendars/edit-group.md): PUT /calendars/groups/{groupId} - Update Group by group ID - [List Calendar Resources](https://marketplace.gohighlevel.com/docs/ghl/calendars/fetch-calendar-resources.md): GET /calendars/resources/{resourceType} - List calendar resources by resource type and location ID (Services V1) - [Get notification](https://marketplace.gohighlevel.com/docs/ghl/calendars/find-event-notification.md): GET /calendars/{calendarId}/notifications/{notificationId} - Find Event notification by notificationId - [List user availability schedule](https://marketplace.gohighlevel.com/docs/ghl/calendars/get-all-schedules.md): GET /calendars/schedules/search - Retrieve user availability schedules based on various filters including location, calendar, and user. Supports pagination. - [Get Appointment](https://marketplace.gohighlevel.com/docs/ghl/calendars/get-appointment.md): GET /calendars/events/appointments/{eventId} - Get appointment by ID - [Get Notes](https://marketplace.gohighlevel.com/docs/ghl/calendars/get-appointment-notes.md): GET /calendars/appointments/{appointmentId}/notes - Get Appointment Notes - [Get Blocked Slots](https://marketplace.gohighlevel.com/docs/ghl/calendars/get-blocked-slots.md): GET /calendars/blocked-slots - [Get Calendar](https://marketplace.gohighlevel.com/docs/ghl/calendars/get-calendar.md): GET /calendars/{calendarId} - Get calendar by ID - [Get Calendar Events](https://marketplace.gohighlevel.com/docs/ghl/calendars/get-calendar-events.md): GET /calendars/events - [Get Calendar Resource](https://marketplace.gohighlevel.com/docs/ghl/calendars/get-calendar-resource.md): GET /calendars/resources/{resourceType}/{id} - Get calendar resource by ID (Services V1) - [Get event calendar availability schedule](https://marketplace.gohighlevel.com/docs/ghl/calendars/get-calendar-schedule.md): GET /calendars/schedules/event-calendar/{calendarId} - Retrieve the availability schedule for a specific event calendar. Returns the schedule associated with the calendar ID provided in the path. - [Get Calendars](https://marketplace.gohighlevel.com/docs/ghl/calendars/get-calendars.md): GET /calendars/ - Get all calendars in a location. - [Get notifications](https://marketplace.gohighlevel.com/docs/ghl/calendars/get-event-notification.md): GET /calendars/{calendarId}/notifications - Get calendar notifications based on query - [Get Groups](https://marketplace.gohighlevel.com/docs/ghl/calendars/get-groups.md): GET /calendars/groups - Get all calendar groups in a location. - [Get user availability schedule](https://marketplace.gohighlevel.com/docs/ghl/calendars/get-schedule-by-id.md): GET /calendars/schedules/{id} - Retrieve a specific schedule by its unique identifier. Returns detailed information including rules, timezone, and associated calendars/users. - [Get Service Booking by ID](https://marketplace.gohighlevel.com/docs/ghl/calendars/get-service-booking-by-id.md): GET /calendars/services/bookings/{bookingId} - Get a specific service booking by ID - [Get Service Bookings](https://marketplace.gohighlevel.com/docs/ghl/calendars/get-service-bookings.md): GET /calendars/services/bookings - Retrieve service bookings for a location within a given date range, with an optional service location filter. - [Get Service by ID](https://marketplace.gohighlevel.com/docs/ghl/calendars/get-service-catalog-by-id.md): GET /calendars/services/catalog/{serviceId} - Get service by ID. - [Get Service Location by ID](https://marketplace.gohighlevel.com/docs/ghl/calendars/get-service-location-by-id.md): GET /calendars/services/locations/{serviceLocationId} - Get service location by ID - [Get Service Locations](https://marketplace.gohighlevel.com/docs/ghl/calendars/get-service-locations.md): GET /calendars/services/locations - Get all service locations - [Get Services](https://marketplace.gohighlevel.com/docs/ghl/calendars/get-services-catalog.md): GET /calendars/services/catalog - Get all services in a location. - [Get Free Slots](https://marketplace.gohighlevel.com/docs/ghl/calendars/get-slots.md): GET /calendars/{calendarId}/free-slots - Get free slots for a calendar between a date range. Optionally a consumer can also request free slots in a particular timezone and also for a particular user. - [Remove user availability schedule from a calendar](https://marketplace.gohighlevel.com/docs/ghl/calendars/remove-calendar-from-schedule.md): DELETE /calendars/schedules/{id}/associations/{calendarId} - Removes the association between a team calendar and the given schedule by removing the calendarId from the schedule - [Update Note](https://marketplace.gohighlevel.com/docs/ghl/calendars/update-appointment-note.md): PUT /calendars/appointments/{appointmentId}/notes/{noteId} - [Update Calendar](https://marketplace.gohighlevel.com/docs/ghl/calendars/update-calendar.md): PUT /calendars/{calendarId} - Update calendar by ID. - [Update Calendar Resource](https://marketplace.gohighlevel.com/docs/ghl/calendars/update-calendar-resource.md): PUT /calendars/resources/{resourceType}/{id} - Update calendar resource by ID (Services V1) - [Update event calendar availability schedule](https://marketplace.gohighlevel.com/docs/ghl/calendars/update-calendar-schedule.md): PUT /calendars/schedules/event-calendar/{calendarId} - Update the availability schedule for a specific event calendar. Only provided fields will be updated. The calendar ID is provided in the path. - [Update notification](https://marketplace.gohighlevel.com/docs/ghl/calendars/update-event-notification.md): PUT /calendars/{calendarId}/notifications/{notificationId} - Update Event notification by id - [Update user availability schedule](https://marketplace.gohighlevel.com/docs/ghl/calendars/update-schedule.md): PUT /calendars/schedules/{id} - Modify an existing schedule by updating its rules, timezone, and name All fields are optional - only provided fields will be updated. - [Update Service Booking](https://marketplace.gohighlevel.com/docs/ghl/calendars/update-service-booking.md): PUT /calendars/services/bookings/{bookingId} - Update an existing service booking - [Update Service](https://marketplace.gohighlevel.com/docs/ghl/calendars/update-service-catalog.md): PUT /calendars/services/catalog/{serviceId} - Update service by ID. - [Update Service Location](https://marketplace.gohighlevel.com/docs/ghl/calendars/update-service-location.md): PUT /calendars/services/locations/{serviceLocationId} - Update an existing service location - [Validate group slug](https://marketplace.gohighlevel.com/docs/ghl/calendars/validate-groups-slug.md): POST /calendars/groups/validate-slug - Validate if group slug is available or not. ## campaigns - [campaigns: all 1 endpoints, compact](https://marketplace.gohighlevel.com/docs/llms/v3/campaigns.md): Campaigns API - [Get Campaigns](https://marketplace.gohighlevel.com/docs/ghl/campaigns/get-campaigns.md): GET /campaigns/ ## chat-widget - [chat-widget: all 7 endpoints, compact](https://marketplace.gohighlevel.com/docs/llms/v3/chat-widget.md): Chat Widget API - [Clone a Chat Widget](https://marketplace.gohighlevel.com/docs/ghl/chat-widget/clone-chat-widget.md): POST /chat-widget/clone - Clones an existing chat widget into a new widget - [Create a new chat widget](https://marketplace.gohighlevel.com/docs/ghl/chat-widget/create-chat-widget.md): POST /chat-widget/ - Creates a new chat widget for a specific location - [Delete a Chat Widget](https://marketplace.gohighlevel.com/docs/ghl/chat-widget/delete-chat-widget.md): DELETE /chat-widget/{locationId}/{id} - Deletes a chat widget by ID - [Get Chat Widget by ID](https://marketplace.gohighlevel.com/docs/ghl/chat-widget/get-chat-widget-by-id.md): GET /chat-widget/data/{locationId}/{id} - Returns the full chat widget configuration for the given location and widget ID - [List Chat Widgets](https://marketplace.gohighlevel.com/docs/ghl/chat-widget/list-chat-widgets.md): GET /chat-widget/list - Retrieves a list of chat widgets for a specific location - [Patch Chat Widget](https://marketplace.gohighlevel.com/docs/ghl/chat-widget/patch-chat-widget.md): PATCH /chat-widget/data/{locationId}/{id} - Applies a partial update to an existing chat widget - [Update Chat Widget](https://marketplace.gohighlevel.com/docs/ghl/chat-widget/update-chat-widget.md): PUT /chat-widget/data/{locationId}/{id} - Replaces an existing chat widget with the provided configuration ## clientportal-ai - [clientportal-ai: all 29 endpoints, compact](https://marketplace.gohighlevel.com/docs/llms/v3/clientportal-ai.md): ClientPortal AI - [Answer every question of one form in a single write.](https://marketplace.gohighlevel.com/docs/ghl/clientportal-ai/answer-agent-run-questions-batch.md): POST /ai-builder-api/projects/{projectId}/runs/{runId}/answers/batch - Records up to 12 answers in one run write and resumes the run once, so a multi-question form does not resume the planner per answer. Same per-answer rules as... - [Apply a signed plan once.](https://marketplace.gohighlevel.com/docs/ghl/clientportal-ai/apply-project-change.md): POST /ai-builder-api/projects/{projectId}/changes/apply - Idempotent on `planId`: a second (or concurrent) apply of the same plan returns the first apply's result without writing again (`queued` while the first is s... - [Read an app's stack and open its sandbox for editing.](https://marketplace.gohighlevel.com/docs/ghl/clientportal-ai/cli-get-project-context.md): GET /ai-builder-api/cli/projects/{projectId}/context - Returns the app's stack, which decides how its code is written, and its kernel bundle, and opens the app's sandbox: read and edit it once `sandbox.status` is... - [Save the app's sandbox files as the point it restarts from.](https://marketplace.gohighlevel.com/docs/ghl/clientportal-ai/cli-sandbox-checkpoint.md): POST /ai-builder-api/cli/projects/{projectId}/sandbox/checkpoint - Saves the sandbox's files so a sandbox that restarts comes back with them. Call it after a set of `POST .../sandbox/edit` calls and before starting the run t... - [Write or delete one file in the app's sandbox.](https://marketplace.gohighlevel.com/docs/ghl/clientportal-ai/cli-sandbox-edit.md): POST /ai-builder-api/cli/projects/{projectId}/sandbox/edit - Writes or deletes one file in the app's sandbox. After a set of edits, save them with `POST .../sandbox/checkpoint`, then start a run with `externalAgent: tr... - [Register, rename or remove a React Native app's screens.](https://marketplace.gohighlevel.com/docs/ghl/clientportal-ai/cli-sandbox-register-extension-route.md): POST /ai-builder-api/cli/projects/{projectId}/sandbox/extension-routes - Changes the screen list of a React Native app (`react_native_app_kernel_v1`) once its screen files are written with `POST .../sandbox/edit`: `app-extensions/... - [Search the app's code for literal text.](https://marketplace.gohighlevel.com/docs/ghl/clientportal-ai/cli-sandbox-search.md): POST /ai-builder-api/cli/projects/{projectId}/sandbox/search - Finds where text appears in the app's source files (ts, tsx, js, jsx, vue, json, md, css), with dependencies and build output left out. The text is matched l... - [Read a file in the app's sandbox, or list a folder.](https://marketplace.gohighlevel.com/docs/ghl/clientportal-ai/cli-sandbox-view.md): POST /ai-builder-api/cli/projects/{projectId}/sandbox/view - Reads one file of the app's code, or lists a folder's files and subfolders, so an agent sees what is there before it edits. A folder path always lists. The k... - [Create a preview link token for a phone app.](https://marketplace.gohighlevel.com/docs/ghl/clientportal-ai/create-mobile-experience-preview-token.md): POST /ai-builder-api/projects/{projectId}/app-config/mobile-preview-token - A short-lived token that makes the app's preview show this app. Open `sandbox.devUrl` from `GET .../cli/projects/{projectId}/context` with `#previewToken=
If `Allow Duplicate Contact` is disabled under Settings, the global unique identifier will be used for searching the contact.... - [Get Note](https://marketplace.gohighlevel.com/docs/ghl/contacts/get-note.md): GET /contacts/{contactId}/notes/{id} - [Get Task](https://marketplace.gohighlevel.com/docs/ghl/contacts/get-task.md): GET /contacts/{contactId}/tasks/{taskId} - [Lookup Contact By Email Or Phone](https://marketplace.gohighlevel.com/docs/ghl/contacts/lookup-contact.md): GET /contacts/lookup - Look up contacts matching an exact `email` or `phone`, scoped to a location, up to `limit` contacts (max 20) per page. Also matches against a contact's addit... - [Remove Contact From Campaign](https://marketplace.gohighlevel.com/docs/ghl/contacts/remove-contact-from-campaign.md): DELETE /contacts/{contactId}/campaigns/{campaignId} - [Remove Contact From Every Campaign](https://marketplace.gohighlevel.com/docs/ghl/contacts/remove-contact-from-every-campaign.md): DELETE /contacts/{contactId}/campaigns/remove-all - Removes the contact from every campaign it is enrolled in. - [Remove Followers](https://marketplace.gohighlevel.com/docs/ghl/contacts/remove-followers-contact.md): DELETE /contacts/{contactId}/followers - [Remove Tags](https://marketplace.gohighlevel.com/docs/ghl/contacts/remove-tags.md): DELETE /contacts/{contactId}/tags - [Search Contacts](https://marketplace.gohighlevel.com/docs/ghl/contacts/search-contacts-advanced.md): POST /contacts/search - Search contacts based on combinations of advanced filters. Documentation Link - https://doc.clickup.com/8631005/d/h/87cpx-158396/6e629989abe7fad - [Update Contact](https://marketplace.gohighlevel.com/docs/ghl/contacts/update-contact.md): PUT /contacts/{contactId} - Update a contact using contactId - [Update Note](https://marketplace.gohighlevel.com/docs/ghl/contacts/update-note.md): PUT /contacts/{contactId}/notes/{id} - [Update Task](https://marketplace.gohighlevel.com/docs/ghl/contacts/update-task.md): PUT /contacts/{contactId}/tasks/{taskId} - [Update Task Completed](https://marketplace.gohighlevel.com/docs/ghl/contacts/update-task-completed.md): PUT /contacts/{contactId}/tasks/{taskId}/completed - [Upsert Contact](https://marketplace.gohighlevel.com/docs/ghl/contacts/upsert-contact.md): POST /contacts/upsert - The Upsert API will adhere to the configuration defined under the "Allow Duplicate Contact" setting at the Location level. If the setting is configured to ch... ## conversation-ai - [conversation-ai: all 17 endpoints, compact](https://marketplace.gohighlevel.com/docs/llms/v3/conversation-ai.md): Conversation AI API - [Attach Action to Agent](https://marketplace.gohighlevel.com/docs/ghl/conversation-ai/create-action.md): POST /conversation-ai/agents/{agentId}/actions - Creates and attach a new action for an AI agent. Actions define specific tasks or behaviors that the agent can perform, such as booking appointments, sending... - [Create an Agent](https://marketplace.gohighlevel.com/docs/ghl/conversation-ai/create-agent.md): POST /conversation-ai/agents - Creates a new AI agent for the location. The agent will be created with the specified configuration including name, role, actions, and behavior settings. - [Create Agent Working Hours](https://marketplace.gohighlevel.com/docs/ghl/conversation-ai/create-agent-working-hours.md): POST /conversation-ai/agents/{agentId}/working-hours - Creates the working-hours configuration for an AI agent. Returns 409 when one already exists — use the update endpoint to replace it. - [Remove Action from Agent](https://marketplace.gohighlevel.com/docs/ghl/conversation-ai/delete-action.md): DELETE /conversation-ai/agents/{agentId}/actions/{actionId} - Permanently deletes an action. This will remove the action from all associated agents and cannot be undone. Applies to both classic and `customApi` ("API Cal... - [Delete Agent](https://marketplace.gohighlevel.com/docs/ghl/conversation-ai/delete-agent.md): DELETE /conversation-ai/agents/{agentId} - Deletes an AI agent permanently. This action cannot be undone. All associated configurations and conversation history will be removed. - [Delete Agent Working Hours](https://marketplace.gohighlevel.com/docs/ghl/conversation-ai/delete-agent-working-hours.md): DELETE /conversation-ai/agents/{agentId}/working-hours - Deletes the working-hours configuration for an AI agent. The agent then replies at any time. Succeeds with deleted=false when there was nothing to delete. - [Get Action by ID](https://marketplace.gohighlevel.com/docs/ghl/conversation-ai/get-action-by-id.md): GET /conversation-ai/agents/{agentId}/actions/{actionId} - Retrieves detailed information about a specific action using its unique identifier. Returns the action configuration, associated agents, and performance metr... - [Get Agent](https://marketplace.gohighlevel.com/docs/ghl/conversation-ai/get-agent.md): GET /conversation-ai/agents/{agentId} - Retrieves a specific AI agent by its ID. Returns the complete agent configuration including name, status, actions, and settings. - [List Actions for an Agent](https://marketplace.gohighlevel.com/docs/ghl/conversation-ai/get-agent-actions.md): GET /conversation-ai/agents/{agentId}/actions - List for actions for an agent, including any `customApi` ("API Call") actions. - [Get Agent Working Hours](https://marketplace.gohighlevel.com/docs/ghl/conversation-ai/get-agent-working-hours.md): GET /conversation-ai/agents/{agentId}/working-hours - Retrieves the working-hours configuration for an AI agent: the weekly schedule, the channels it applies to, the timezone mode, and the off-hours auto-reply a... - [Get the generation details](https://marketplace.gohighlevel.com/docs/ghl/conversation-ai/get-generation-details.md): GET /conversation-ai/generations - Retrieves detailed information about AI responses including the System Prompt, Conversation history, Knowledge base, website, FAQ chunks, and Rich Text chunks. - [List Actions for an Agent](https://marketplace.gohighlevel.com/docs/ghl/conversation-ai/list-actions.md): GET /conversation-ai/agents/{agentId}/actions/list - Deprecated — use GET /conversation-ai/agents/{agentId}/actions instead. List for actions for an agent, including any `customApi` ("API Call") actions. - [Search Agents](https://marketplace.gohighlevel.com/docs/ghl/conversation-ai/search-agent.md): GET /conversation-ai/agents/search - Searches for AI agents based on various criteria including name, status, and configuration. Supports advanced filtering and full-text search capabilities. - [Update Action](https://marketplace.gohighlevel.com/docs/ghl/conversation-ai/update-action.md): PUT /conversation-ai/agents/{agentId}/actions/{actionId} - Updates an existing action's configuration — name, description, trigger condition and behaviour settings. For `customApi` ("API Call") actions `details.apiCo... - [Update Agent](https://marketplace.gohighlevel.com/docs/ghl/conversation-ai/update-agent.md): PUT /conversation-ai/agents/{agentId} - Updates an existing AI agent's configuration. All fields in the agent configuration can be updated including name, status, actions, and behavior settings. - [Update Agent Working Hours](https://marketplace.gohighlevel.com/docs/ghl/conversation-ai/update-agent-working-hours.md): PUT /conversation-ai/agents/{agentId}/working-hours - Fully replaces the working-hours configuration for an AI agent. Returns 404 when none exists yet — use the create endpoint first. This is a replace, not a me... - [Update Followup Settings](https://marketplace.gohighlevel.com/docs/ghl/conversation-ai/update-followup-settings.md): PATCH /conversation-ai/agents/{agentId}/followup-settings - Update the followup settings for an action ## conversations - [conversations: all 22 endpoints, compact](https://marketplace.gohighlevel.com/docs/llms/v3/conversations.md): Conversations API - [Add an inbound message](https://marketplace.gohighlevel.com/docs/ghl/conversations/add-an-inbound-message.md): POST /conversations/messages/inbound - Post the necessary fields for the API to add a new inbound message.

**Note:** Either `conversationId` or `contactId` is required - [Add an external outbound call](https://marketplace.gohighlevel.com/docs/ghl/conversations/add-an-outbound-message.md): POST /conversations/messages/outbound - Post the necessary fields for the API to add a new outbound call. - [Add message attachments](https://marketplace.gohighlevel.com/docs/ghl/conversations/add-message-attachments.md): PUT /conversations/messages/{messageId}/attachments - Set attachments on an existing message (replaces existing). Maximum 5 URLs. Supported for Custom Call message type. - [Cancel a scheduled email message.](https://marketplace.gohighlevel.com/docs/ghl/conversations/cancel-scheduled-email-message.md): DELETE /conversations/messages/email/{emailMessageId}/schedule - Post the messageId for the API to delete a scheduled email message.
- [Cancel a scheduled message.](https://marketplace.gohighlevel.com/docs/ghl/conversations/cancel-scheduled-message.md): DELETE /conversations/messages/{messageId}/schedule - Post the messageId for the API to delete a scheduled message.
- [Create Conversation](https://marketplace.gohighlevel.com/docs/ghl/conversations/create-conversation.md): POST /conversations/ - Creates a new conversation with the data provided - [Delete Conversation](https://marketplace.gohighlevel.com/docs/ghl/conversations/delete-conversation.md): DELETE /conversations/{conversationId} - Delete the conversation details based on the conversation ID - [Download transcription by Message ID](https://marketplace.gohighlevel.com/docs/ghl/conversations/download-message-transcription.md): GET /conversations/locations/{locationId}/messages/{messageId}/transcription/download - Download the recording transcription for a message by passing the message id - [Export messages by location ID](https://marketplace.gohighlevel.com/docs/ghl/conversations/export-messages-by-location.md): GET /conversations/messages/export - Export messages for a specific location with cursor-based pagination support. - [Get Conversation](https://marketplace.gohighlevel.com/docs/ghl/conversations/get-conversation.md): GET /conversations/{conversationId} - Get the conversation details based on the conversation ID - [Get email by Id](https://marketplace.gohighlevel.com/docs/ghl/conversations/get-email-by-id.md): GET /conversations/messages/email/{id} - [Get message by message id](https://marketplace.gohighlevel.com/docs/ghl/conversations/get-message.md): GET /conversations/messages/{id} - Get message by message id. - [Get Recording by Message ID](https://marketplace.gohighlevel.com/docs/ghl/conversations/get-message-recording.md): GET /conversations/messages/{messageId}/locations/{locationId}/recording - Get the recording for a message by passing the message id - [Get transcription by Message ID](https://marketplace.gohighlevel.com/docs/ghl/conversations/get-message-transcription.md): GET /conversations/locations/{locationId}/messages/{messageId}/transcription - Get the recording transcription for a message by passing the message id - [Get messages by conversation id](https://marketplace.gohighlevel.com/docs/ghl/conversations/get-messages.md): GET /conversations/{conversationId}/messages - Get messages by conversation id. - [Agent/Ai-Bot is typing a message indicator for live chat](https://marketplace.gohighlevel.com/docs/ghl/conversations/live-chat-agent-typing.md): POST /conversations/providers/live-chat/typing - Agent/AI-Bot will call this when they are typing a message in live chat message - [Search Conversations](https://marketplace.gohighlevel.com/docs/ghl/conversations/search-conversation.md): GET /conversations/search - Returns a list of all conversations matching the search criteria along with the sort and filter options selected. - [Send a new message](https://marketplace.gohighlevel.com/docs/ghl/conversations/send-a-new-message.md): POST /conversations/messages - Post the necessary fields for the API to send a new message. - [Update Conversation](https://marketplace.gohighlevel.com/docs/ghl/conversations/update-conversation.md): PUT /conversations/{conversationId} - Update the conversation details based on the conversation ID - [Update email message status](https://marketplace.gohighlevel.com/docs/ghl/conversations/update-email-message-status.md): PUT /conversations/messages/email/{emailMessageId}/status - Update delivery events, per-recipient statuses, and the overall message status for an email sent via a custom conversation provider. - [Update message status](https://marketplace.gohighlevel.com/docs/ghl/conversations/update-message-status.md): PUT /conversations/messages/{messageId}/status - Post the necessary fields for the API to update message status. - [Upload file attachments](https://marketplace.gohighlevel.com/docs/ghl/conversations/upload-file-attachments.md): POST /conversations/messages/upload - Post the necessary fields for the API to upload files. The files need to be a buffer with the key "fileAttachment".

Note: One of conversa... ## countdown-timer - [countdown-timer: all 6 endpoints, compact](https://marketplace.gohighlevel.com/docs/llms/v3/countdown-timer.md): Countdown Timer API v3 - [Create Countdown Timer](https://marketplace.gohighlevel.com/docs/ghl/countdown-timer/create-countdown-timer.md): POST /countdown-timer/timers - Create a countdown timer for the access token's location - [Delete Countdown Timer](https://marketplace.gohighlevel.com/docs/ghl/countdown-timer/delete-countdown-timer.md): DELETE /countdown-timer/timers/{timerId} - Soft-delete a countdown timer - [Get Countdown Timer](https://marketplace.gohighlevel.com/docs/ghl/countdown-timer/get-countdown-timer.md): GET /countdown-timer/timers/{timerId} - Get a countdown timer by ID - [List Timer Templates](https://marketplace.gohighlevel.com/docs/ghl/countdown-timer/list-countdown-timer-templates.md): GET /countdown-timer/templates - Get the available countdown timer templates with their default design configuration - [List Countdown Timers](https://marketplace.gohighlevel.com/docs/ghl/countdown-timer/list-countdown-timers.md): GET /countdown-timer/timers - Get a paginated list of the countdown timers belonging to the access token's location - [Update Countdown Timer](https://marketplace.gohighlevel.com/docs/ghl/countdown-timer/update-countdown-timer.md): PATCH /countdown-timer/timers/{timerId} - Update an existing countdown timer ## courses - [courses: all 42 endpoints, compact](https://marketplace.gohighlevel.com/docs/llms/v3/courses.md): Courses API v3 - [Create Category](https://marketplace.gohighlevel.com/docs/ghl/courses/create-category.md): POST /courses/products/{productId}/categories - Create a category in a course. Requires a Location token with courses.write. Accepts category columns (title required). locationId, userId, productId, origin... - [Create Course](https://marketplace.gohighlevel.com/docs/ghl/courses/create-course.md): POST /courses/products - Create a course in the location. Requires a Location token with courses.write. Accepts product columns and nested customizations. locationId, userId, id, ori... - [Enroll Contact](https://marketplace.gohighlevel.com/docs/ghl/courses/create-enrollment.md): POST /courses/enrollments - Grant a contact access to a membership offer. Requires a Location token with courses.write. Send Version: v3. Uses POST smart-list/user with source public_ap... - [Create Lesson](https://marketplace.gohighlevel.com/docs/ghl/courses/create-lesson.md): POST /courses/products/{productId}/lessons - Create a lesson. Requires title and categoryId. Accepts lesson columns. locationId, userId, productId, originId are not accepted. Requires a Location token w... - [Create Lesson Assignment](https://marketplace.gohighlevel.com/docs/ghl/courses/create-lesson-assignment.md): POST /courses/products/{productId}/lessons/{lessonId}/assignment - Create an assignment on a lesson. Requires a Location token with courses.write. Send Version: v3. Path lessonId is sent to membership as postId. locationId,... - [Create Lesson Quiz](https://marketplace.gohighlevel.com/docs/ghl/courses/create-lesson-quiz.md): POST /courses/products/{productId}/lessons/{lessonId}/quiz - Create a quiz on a lesson. Requires a Location token with courses.write. Send Version: v3. Path lessonId is sent to membership as postId. locationId, userId,... - [Create Offer](https://marketplace.gohighlevel.com/docs/ghl/courses/create-offer.md): POST /courses/offers - Create a membership offer. Requires a Location token with courses.write. Send Version: v3. Returns the full offer. source is always membership. locationId, u... - [Delete Assignment](https://marketplace.gohighlevel.com/docs/ghl/courses/delete-assignment.md): DELETE /courses/products/{productId}/assignments/{assignmentId} - Delete an assignment. Requires a Location token with courses.write. Send Version: v3. - [Delete Category](https://marketplace.gohighlevel.com/docs/ghl/courses/delete-category.md): DELETE /courses/products/{productId}/categories/{categoryId} - Delete a category. Requires a Location token with courses.write. - [Delete Course](https://marketplace.gohighlevel.com/docs/ghl/courses/delete-course.md): DELETE /courses/products/{productId} - Delete a course. Requires a Location token with courses.write. - [Revoke Enrollment](https://marketplace.gohighlevel.com/docs/ghl/courses/delete-enrollment.md): DELETE /courses/enrollments - Revoke a contact from a membership offer. Requires a Location token with courses.write. Send Version: v3. Uses DELETE smart-list/user (offer revoke, not prod... - [Delete Lesson](https://marketplace.gohighlevel.com/docs/ghl/courses/delete-lesson.md): DELETE /courses/products/{productId}/lessons/{lessonId} - Delete a lesson. Requires a Location token with courses.write. - [Delete Offer](https://marketplace.gohighlevel.com/docs/ghl/courses/delete-offer.md): DELETE /courses/offers/{offerId} - Delete a membership offer. Requires a Location token with courses.write. Send Version: v3. - [Delete Quiz](https://marketplace.gohighlevel.com/docs/ghl/courses/delete-quiz.md): DELETE /courses/products/{productId}/quizzes/{quizId} - Delete a quiz. Requires a Location token with courses.write. Send Version: v3. - [Get Assessment](https://marketplace.gohighlevel.com/docs/ghl/courses/get-assessment.md): GET /courses/products/{productId}/assessments/{assessmentId} - Get one assessment submission. Requires a Location token with courses.readonly. Send Version: v3. - [Get Category](https://marketplace.gohighlevel.com/docs/ghl/courses/get-category.md): GET /courses/products/{productId}/categories/{categoryId} - Get a category by id. Requires a Location token with courses.readonly. Returns the full category object. - [Get Course](https://marketplace.gohighlevel.com/docs/ghl/courses/get-course.md): GET /courses/products/{productId} - Get a course by id. Requires a Location token with courses.readonly. Returns product columns and nested customizations. - [Get Lesson](https://marketplace.gohighlevel.com/docs/ghl/courses/get-lesson.md): GET /courses/products/{productId}/lessons/{lessonId} - Get a lesson by id. Requires a Location token with courses.readonly. Returns the full lesson object. - [Get Lesson Assignment](https://marketplace.gohighlevel.com/docs/ghl/courses/get-lesson-assignment.md): GET /courses/products/{productId}/lessons/{lessonId}/assignment - Get the assignment for a lesson. Requires a Location token with courses.readonly. Send Version: v3. - [Get Lesson Quiz](https://marketplace.gohighlevel.com/docs/ghl/courses/get-lesson-quiz.md): GET /courses/products/{productId}/lessons/{lessonId}/quiz - Get the quiz for a lesson. Requires a Location token with courses.readonly. Send Version: v3. - [Get Offer](https://marketplace.gohighlevel.com/docs/ghl/courses/get-offer.md): GET /courses/offers/{offerId} - Get a membership offer by id. Requires a Location token with courses.readonly. Send Version: v3. Default-offer rows (source other than membership) return 404. - [List Quiz Questions](https://marketplace.gohighlevel.com/docs/ghl/courses/get-quiz-questions.md): GET /courses/products/{productId}/quizzes/{quizId}/questions - List questions for a quiz. Requires a Location token with courses.readonly. Send Version: v3. - [Import Courses](https://marketplace.gohighlevel.com/docs/ghl/courses/import-courses.md): POST /courses/courses-exporter/public/import - Import Courses through public channels - [List Assessments](https://marketplace.gohighlevel.com/docs/ghl/courses/list-assessments.md): GET /courses/products/{productId}/assessments - List assessment submissions for a course. Requires a Location token with courses.readonly. Send Version: v3. - [List Product Progress](https://marketplace.gohighlevel.com/docs/ghl/courses/list-bulk-progress.md): GET /courses/progress - Return progress for the given contact across productIds. Requires a Location token with courses.readonly. Send Version: v3. productIds is a comma-separated l... - [List Categories](https://marketplace.gohighlevel.com/docs/ghl/courses/list-categories.md): GET /courses/products/{productId}/categories - List categories for a course. Requires a Location token with courses.readonly. Each item is the full category object. - [List Category Progress](https://marketplace.gohighlevel.com/docs/ghl/courses/list-category-progress.md): GET /courses/products/{productId}/categories/progress - Return per-category progress for a contact in a product. Requires a Location token with courses.readonly. Send Version: v3. - [List Completions](https://marketplace.gohighlevel.com/docs/ghl/courses/list-completions.md): GET /courses/products/{productId}/completions - With contactId, return that learner's completed lessons. Without contactId, return a paginated creator rollup by contact. Requires a Location token with cour... - [List Courses](https://marketplace.gohighlevel.com/docs/ghl/courses/list-courses.md): GET /courses/products - List courses in the location. Requires a Location token with courses.readonly. Send Version: v3. Each item is the full course object including customizations. - [List Product Enrollments](https://marketplace.gohighlevel.com/docs/ghl/courses/list-enrollments.md): GET /courses/products/{productId}/enrollments - List contacts enrolled in a product. Requires a Location token with courses.readonly. Send Version: v3. Reads user_purchases in the bound location. Does not... - [List Lessons](https://marketplace.gohighlevel.com/docs/ghl/courses/list-lessons.md): GET /courses/products/{productId}/lessons - List lessons for a course. Pass categoryId to list one category; omit it to list every category (N+1 membership reads). Requires a Location token with course... - [List Offers](https://marketplace.gohighlevel.com/docs/ghl/courses/list-offers.md): GET /courses/offers - List membership offers in the location. Requires a Location token with courses.readonly. Send Version: v3. Uses membership listView pagination (cursor encode... - [Review Assessment](https://marketplace.gohighlevel.com/docs/ghl/courses/review-assessment.md): PUT /courses/products/{productId}/assessments/{assessmentId}/review - Review an assessment submission. Requires a Location token with courses.write. Send Version: v3. Location tokens are not a staff reviewer. - [Sequence Categories](https://marketplace.gohighlevel.com/docs/ghl/courses/sequence-categories.md): PUT /courses/products/{productId}/categories/sequence - Reorder categories in a course. Requires a Location token with courses.write. - [Sequence Lessons](https://marketplace.gohighlevel.com/docs/ghl/courses/sequence-lessons.md): PUT /courses/products/{productId}/categories/{categoryId}/lessons/sequence - Reorder lessons in a category. Requires a Location token with courses.write. - [Update Assignment](https://marketplace.gohighlevel.com/docs/ghl/courses/update-assignment.md): PUT /courses/products/{productId}/assignments/{assignmentId} - Update an assignment. Requires a Location token with courses.write. Send Version: v3. - [Update Category](https://marketplace.gohighlevel.com/docs/ghl/courses/update-category.md): PUT /courses/products/{productId}/categories/{categoryId} - Update a category. Requires a Location token with courses.write. Accepts the same category columns as create. All fields optional. - [Update Course](https://marketplace.gohighlevel.com/docs/ghl/courses/update-course.md): PUT /courses/products/{productId} - Update a course. Requires a Location token with courses.write. Accepts the same product columns and nested customizations as create. All fields optional. - [Update Lesson](https://marketplace.gohighlevel.com/docs/ghl/courses/update-lesson.md): PUT /courses/products/{productId}/lessons/{lessonId} - Update a lesson. Requires a Location token with courses.write. Accepts the same lesson columns as create. All fields optional. Omit categoryId to keep the cu... - [Update Offer](https://marketplace.gohighlevel.com/docs/ghl/courses/update-offer.md): PUT /courses/offers/{offerId} - Update a membership offer. Requires a Location token with courses.write. Send Version: v3. Returns the full offer. locationId, id, userId, originId, and addP... - [Update Quiz](https://marketplace.gohighlevel.com/docs/ghl/courses/update-quiz.md): PUT /courses/products/{productId}/quizzes/{quizId} - Update a quiz. Requires a Location token with courses.write. Send Version: v3. - [Replace Quiz Questions](https://marketplace.gohighlevel.com/docs/ghl/courses/upsert-quiz-questions.md): PUT /courses/products/{productId}/quizzes/{quizId}/questions - Batch upsert quiz questions. Requires a Location token with courses.write. Send Version: v3. quizId is taken from the path, not the body. ## custom-fields - [custom-fields: all 8 endpoints, compact](https://marketplace.gohighlevel.com/docs/llms/v3/custom-fields.md): Custom Fields V2 API - [Create Custom Field](https://marketplace.gohighlevel.com/docs/ghl/custom-fields/create-custom-field.md): POST /custom-fields/ -

Create Custom Field

:::info Only supports Custom Objects and Company (Business) today. Will be extended to other Standard Objects in th... - [Create Custom Field Folder](https://marketplace.gohighlevel.com/docs/ghl/custom-fields/create-custom-field-folder.md): POST /custom-fields/folder -

Create Custom Field Folder

:::info Only supports Custom Objects and Company (Business) today. Will be extended to other Standard Object... - [Delete Custom Field By Id](https://marketplace.gohighlevel.com/docs/ghl/custom-fields/delete-custom-field.md): DELETE /custom-fields/{id} -

Delete Custom Field By Id

:::info Only supports Custom Objects and Company (Business) today. Will be extended to other Standard Objects... - [Delete Custom Field Folder](https://marketplace.gohighlevel.com/docs/ghl/custom-fields/delete-custom-field-folder.md): DELETE /custom-fields/folder/{id} -

Create Custom Field Folder

:::info Only supports Custom Objects and Company (Business) today. Will be extended to other Standard Object... - [Get Custom Field / Folder By Id](https://marketplace.gohighlevel.com/docs/ghl/custom-fields/get-custom-field-by-id.md): GET /custom-fields/{id} -

Get Custom Field / Folder By Id.

:::info Only supports Custom Objects and Company (Business) today. Will be extended to other Standard O... - [Get Custom Fields By Object Key](https://marketplace.gohighlevel.com/docs/ghl/custom-fields/get-custom-fields-by-object-key.md): GET /custom-fields/object-key/{objectKey} -

Get Custom Fields By Object Key

:::info Only supports Custom Objects and Company (Business) today. Will be extended to other Standard O... - [Update Custom Field By Id](https://marketplace.gohighlevel.com/docs/ghl/custom-fields/update-custom-field.md): PUT /custom-fields/{id} -

Update Custom Field By Id

:::info Only supports Custom Objects and Company (Business) today. Will be extended to other Standard Objects... - [Update Custom Field Folder Name](https://marketplace.gohighlevel.com/docs/ghl/custom-fields/update-custom-field-folder.md): PUT /custom-fields/folder/{id} -

Create Custom Field Folder

:::info Only supports Custom Objects and Company (Business) today. Will be extended to other Standard Object... ## custom-menus - [custom-menus: all 5 endpoints, compact](https://marketplace.gohighlevel.com/docs/llms/v3/custom-menus.md): Custom menus API - [Create Custom Menu Link](https://marketplace.gohighlevel.com/docs/ghl/custom-menus/create-custom-menu.md): POST /custom-menus/ - Creates a new custom menu for a company. Requires authentication and proper permissions. For Icon Usage Details please refer to https://doc.clickup.com/86310... - [Delete Custom Menu Link](https://marketplace.gohighlevel.com/docs/ghl/custom-menus/delete-custom-menu.md): DELETE /custom-menus/{customMenuId} - Removes a specific custom menu from the system. This operation requires authentication and proper permissions. The custom menu is identified by its unique ID... - [Get Custom Menu Link](https://marketplace.gohighlevel.com/docs/ghl/custom-menus/get-custom-menu-by-id.md): GET /custom-menus/{customMenuId} - Fetches a single custom menus based on id. This endpoint allows clients to retrieve custom menu configurations, which may include menu items, categories, and... - [Get Custom Menu Links](https://marketplace.gohighlevel.com/docs/ghl/custom-menus/get-custom-menus.md): GET /custom-menus/ - Fetches a collection of custom menus based on specified criteria. This endpoint allows clients to retrieve custom menu configurations, which may include menu... - [Update Custom Menu Link](https://marketplace.gohighlevel.com/docs/ghl/custom-menus/update-custom-menu.md): PUT /custom-menus/{customMenuId} - Updates an existing custom menu for a given company. Requires authentication and proper permissions. ## email-isv - [email-isv: all 1 endpoints, compact](https://marketplace.gohighlevel.com/docs/llms/v3/email-isv.md): Email ISV API v3 - [Email Verification](https://marketplace.gohighlevel.com/docs/ghl/email-isv/verify-email.md): POST /email/verify - Verify Email ## emails - [emails: all 18 endpoints, compact](https://marketplace.gohighlevel.com/docs/llms/v3/emails.md): Email API v3 - [Create Email Campaign](https://marketplace.gohighlevel.com/docs/ghl/emails/create-email-campaign.md): POST /emails/locations/{locationId}/campaigns/emails - Create a new email campaign - [Create an email template](https://marketplace.gohighlevel.com/docs/ghl/emails/create-email-template.md): POST /emails/locations/{locationId}/templates - Create a new email template - [Create a template folder](https://marketplace.gohighlevel.com/docs/ghl/emails/create-template-folder.md): POST /emails/locations/{locationId}/templates/folders - Create a new template folder - [Delete Campaign](https://marketplace.gohighlevel.com/docs/ghl/emails/delete-campaign.md): DELETE /emails/locations/{locationId}/campaigns/emails/{campaignId} - Delete a campaign - [Delete a template](https://marketplace.gohighlevel.com/docs/ghl/emails/delete-email-template.md): DELETE /emails/locations/{locationId}/templates/{templateId} - [Get Bulk Action Campaign by ID](https://marketplace.gohighlevel.com/docs/ghl/emails/get-bulk-action-campaign.md): GET /emails/locations/{locationId}/campaigns/bulk-actions/{campaignId} - Get a single bulk action campaign by its ID - [Get Campaign Statistics](https://marketplace.gohighlevel.com/docs/ghl/emails/get-campaign-stats.md): GET /emails/locations/{locationId}/campaigns/stats/{source}/{sourceId} - Get statistics for email campaigns, workflows, or bulk actions - [Get Email Campaign by ID](https://marketplace.gohighlevel.com/docs/ghl/emails/get-email-campaign.md): GET /emails/locations/{locationId}/campaigns/emails/{campaignId} - Get a single email campaign by its ID - [Get Email Template by ID](https://marketplace.gohighlevel.com/docs/ghl/emails/get-email-template.md): GET /emails/locations/{locationId}/templates/{templateId} - Get a single email template by its ID - [Get Workflow Campaign by ID](https://marketplace.gohighlevel.com/docs/ghl/emails/get-workflow-campaign.md): GET /emails/locations/{locationId}/campaigns/workflows/{campaignId} - Get a single workflow campaign by its ID - [Import an email template](https://marketplace.gohighlevel.com/docs/ghl/emails/import-email-template.md): POST /emails/locations/{locationId}/templates/import - Import a template from a provider URL - [List Bulk Action Campaigns](https://marketplace.gohighlevel.com/docs/ghl/emails/list-bulk-action-campaigns.md): GET /emails/locations/{locationId}/campaigns/bulk-actions - Get list of bulk action campaigns for a location - [List Email Campaigns](https://marketplace.gohighlevel.com/docs/ghl/emails/list-email-campaigns.md): GET /emails/locations/{locationId}/campaigns/emails - Get list of email campaigns for a location - [List templates](https://marketplace.gohighlevel.com/docs/ghl/emails/list-email-templates.md): GET /emails/locations/{locationId}/templates - Get list of templates by location - [List Workflow Campaigns](https://marketplace.gohighlevel.com/docs/ghl/emails/list-workflow-campaigns.md): GET /emails/locations/{locationId}/campaigns/workflows - Get list of workflow campaigns for a location - [Schedule Campaign](https://marketplace.gohighlevel.com/docs/ghl/emails/schedule-campaign.md): POST /emails/locations/{locationId}/campaigns/emails/{campaignId}/schedule - Schedule or start an email campaign. The campaign must be in draft, cancelled, or paused status. - [Update Email Campaign](https://marketplace.gohighlevel.com/docs/ghl/emails/update-email-campaign.md): PATCH /emails/locations/{locationId}/campaigns/emails/{campaignId} - Update an email campaign draft - [Update an email template](https://marketplace.gohighlevel.com/docs/ghl/emails/update-email-template.md): PATCH /emails/locations/{locationId}/templates/{templateId} - Update email template ## files - [files: all 1 endpoints, compact](https://marketplace.gohighlevel.com/docs/llms/v3/files.md): Files API - [Get File](https://marketplace.gohighlevel.com/docs/ghl/files/get-file-by-slug.md): GET /files/d/{slug} - Get the file by slug. ## forms - [forms: all 3 endpoints, compact](https://marketplace.gohighlevel.com/docs/llms/v3/forms.md): Forms API - [Get Forms](https://marketplace.gohighlevel.com/docs/ghl/forms/get-forms.md): GET /forms/ - [Get Forms Submissions](https://marketplace.gohighlevel.com/docs/ghl/forms/get-forms-submissions.md): GET /forms/submissions - [Upload files to custom fields](https://marketplace.gohighlevel.com/docs/ghl/forms/upload-to-custom-fields.md): POST /forms/upload-custom-files - Post the necessary fields for the API to upload files. The files need to be a buffer with the key "< custom_field_id >_< file_id >".
Here custom field... ## funnels - [funnels: all 7 endpoints, compact](https://marketplace.gohighlevel.com/docs/llms/v3/funnels.md): Funnels API - [Create Redirect](https://marketplace.gohighlevel.com/docs/ghl/funnels/create-redirect.md): POST /funnels/lookup/redirect - The "Create Redirect" API Allows adding a new url redirect to the system. Use this endpoint to create a url redirect with the specified details. Ensure that... - [Delete Redirect By Id](https://marketplace.gohighlevel.com/docs/ghl/funnels/delete-redirect-by-id.md): DELETE /funnels/lookup/redirect/{id} - The "Delete Redirect By Id" API Allows deletion of a URL redirect from the system using its unique identifier. Use this endpoint to delete a URL redirect wit... - [Fetch List of Redirects](https://marketplace.gohighlevel.com/docs/ghl/funnels/fetch-redirects-list.md): GET /funnels/lookup/redirect/list - Retrieves a list of all URL redirects based on the given query parameters. - [Fetch List of Funnels](https://marketplace.gohighlevel.com/docs/ghl/funnels/get-funnels.md): GET /funnels/funnel/list - Retrieves a list of all funnels based on the given query parameters. - [Fetch list of funnel pages](https://marketplace.gohighlevel.com/docs/ghl/funnels/get-pages-by-funnel-id.md): GET /funnels/page - Retrieves a list of all funnel pages based on the given query parameters. - [Fetch count of funnel pages](https://marketplace.gohighlevel.com/docs/ghl/funnels/get-pages-count-by-funnel-id.md): GET /funnels/page/count - Retrieves count of all funnel pages based on the given query parameters. - [Update Redirect By Id](https://marketplace.gohighlevel.com/docs/ghl/funnels/update-redirect-by-id.md): PATCH /funnels/lookup/redirect/{id} - The "Update Redirect By Id" API Allows updating an existing URL redirect in the system. Use this endpoint to modify a URL redirect with the specified ID usin... ## invoices - [invoices: all 42 endpoints, compact](https://marketplace.gohighlevel.com/docs/llms/v3/invoices.md): Invoice API - [Manage Auto payment for an schedule invoice](https://marketplace.gohighlevel.com/docs/ghl/invoices/auto-payment-invoice-schedule.md): POST /invoices/schedule/{scheduleId}/auto-payment - API to manage auto payment for a schedule - [Cancel an scheduled invoice](https://marketplace.gohighlevel.com/docs/ghl/invoices/cancel-invoice-schedule.md): POST /invoices/schedule/{scheduleId}/cancel - API to cancel a scheduled invoice by schedule id - [Create Estimate Template](https://marketplace.gohighlevel.com/docs/ghl/invoices/create-estimate-template.md): POST /invoices/estimate/template - Create a new estimate template - [Create Invoice](https://marketplace.gohighlevel.com/docs/ghl/invoices/create-invoice.md): POST /invoices/ - API to create an invoice - [Create Invoice from Estimate](https://marketplace.gohighlevel.com/docs/ghl/invoices/create-invoice-from-estimate.md): POST /invoices/estimate/{estimateId}/invoice - Create a new invoice from an existing estimate - [Create Invoice Schedule](https://marketplace.gohighlevel.com/docs/ghl/invoices/create-invoice-schedule.md): POST /invoices/schedule - API to create an invoice Schedule - [Create template](https://marketplace.gohighlevel.com/docs/ghl/invoices/create-invoice-template.md): POST /invoices/template - API to create a template - [Create New Estimate](https://marketplace.gohighlevel.com/docs/ghl/invoices/create-new-estimate.md): POST /invoices/estimate - Create a new estimate with the provided details - [Delete Estimate](https://marketplace.gohighlevel.com/docs/ghl/invoices/delete-estimate.md): DELETE /invoices/estimate/{estimateId} - Delete an existing estimate - [Delete Estimate Template](https://marketplace.gohighlevel.com/docs/ghl/invoices/delete-estimate-template.md): DELETE /invoices/estimate/template/{templateId} - Delete an existing estimate template - [Delete invoice](https://marketplace.gohighlevel.com/docs/ghl/invoices/delete-invoice.md): DELETE /invoices/{invoiceId} - API to delete invoice by invoice id - [Delete schedule](https://marketplace.gohighlevel.com/docs/ghl/invoices/delete-invoice-schedule.md): DELETE /invoices/schedule/{scheduleId} - API to delete an schedule by schedule id - [Delete template](https://marketplace.gohighlevel.com/docs/ghl/invoices/delete-invoice-template.md): DELETE /invoices/template/{templateId} - API to update an template by template id - [Generate Estimate Number](https://marketplace.gohighlevel.com/docs/ghl/invoices/generate-estimate-number.md): GET /invoices/estimate/number/generate - Get the next estimate number for the given location - [Generate Invoice Number](https://marketplace.gohighlevel.com/docs/ghl/invoices/generate-invoice-number.md): GET /invoices/generate-invoice-number - Get the next invoice number for the given location - [Get invoice](https://marketplace.gohighlevel.com/docs/ghl/invoices/get-invoice.md): GET /invoices/{invoiceId} - API to get invoice by invoice id - [Get an schedule](https://marketplace.gohighlevel.com/docs/ghl/invoices/get-invoice-schedule.md): GET /invoices/schedule/{scheduleId} - API to get an schedule by schedule id - [Get Invoice Settings](https://marketplace.gohighlevel.com/docs/ghl/invoices/get-invoice-settings.md): GET /invoices/settings - Get the invoice settings for the given location - [Get an template](https://marketplace.gohighlevel.com/docs/ghl/invoices/get-invoice-template.md): GET /invoices/template/{templateId} - API to get an template by template id - [List Estimate Templates](https://marketplace.gohighlevel.com/docs/ghl/invoices/list-estimate-templates.md): GET /invoices/estimate/template - Get a list of estimate templates or a specific template by ID - [List Estimates](https://marketplace.gohighlevel.com/docs/ghl/invoices/list-estimates.md): GET /invoices/estimate/list - Get a paginated list of estimates - [List schedules](https://marketplace.gohighlevel.com/docs/ghl/invoices/list-invoice-schedules.md): GET /invoices/schedule - API to get list of schedules - [List templates](https://marketplace.gohighlevel.com/docs/ghl/invoices/list-invoice-templates.md): GET /invoices/template - API to get list of templates - [List invoices](https://marketplace.gohighlevel.com/docs/ghl/invoices/list-invoices.md): GET /invoices/ - API to get list of invoices - [Preview Estimate Template](https://marketplace.gohighlevel.com/docs/ghl/invoices/preview-estimate-template.md): GET /invoices/estimate/template/preview - Get a preview of an estimate template - [Record a manual payment for an invoice](https://marketplace.gohighlevel.com/docs/ghl/invoices/record-invoice.md): POST /invoices/{invoiceId}/record-payment - API to record manual payment for an invoice by invoice id - [Schedule an schedule invoice](https://marketplace.gohighlevel.com/docs/ghl/invoices/schedule-invoice-schedule.md): POST /invoices/schedule/{scheduleId}/schedule - API to schedule an schedule invoice to start sending to the customer - [Send Estimate](https://marketplace.gohighlevel.com/docs/ghl/invoices/send-estimate.md): POST /invoices/estimate/{estimateId}/send - API to send estimate by estimate id - [Send invoice](https://marketplace.gohighlevel.com/docs/ghl/invoices/send-invoice.md): POST /invoices/{invoiceId}/send - API to send invoice by invoice id - [Create & Send](https://marketplace.gohighlevel.com/docs/ghl/invoices/text-2-pay-invoice.md): POST /invoices/text2pay - API to create or update a text2pay invoice - [Update scheduled recurring invoice](https://marketplace.gohighlevel.com/docs/ghl/invoices/update-and-schedule-invoice-schedule.md): POST /invoices/schedule/{scheduleId}/updateAndSchedule - API to update scheduled recurring invoice - [Update Estimate](https://marketplace.gohighlevel.com/docs/ghl/invoices/update-estimate.md): PUT /invoices/estimate/{estimateId} - Update an existing estimate with new details - [Update estimate last visited at](https://marketplace.gohighlevel.com/docs/ghl/invoices/update-estimate-last-visited-at.md): PATCH /invoices/estimate/stats/last-visited-at - API to update estimate last visited at by estimate id - [Update Estimate Template](https://marketplace.gohighlevel.com/docs/ghl/invoices/update-estimate-template.md): PUT /invoices/estimate/template/{templateId} - Update an existing estimate template - [Update invoice](https://marketplace.gohighlevel.com/docs/ghl/invoices/update-invoice.md): PUT /invoices/{invoiceId} - API to update invoice by invoice id - [Update invoice last visited at](https://marketplace.gohighlevel.com/docs/ghl/invoices/update-invoice-last-visited-at.md): PATCH /invoices/stats/last-visited-at - API to update invoice last visited at by invoice id - [Update invoice late fees configuration](https://marketplace.gohighlevel.com/docs/ghl/invoices/update-invoice-late-fees-configuration.md): PATCH /invoices/{invoiceId}/late-fees-configuration - API to update invoice late fees configuration by invoice id - [Update template late fees configuration](https://marketplace.gohighlevel.com/docs/ghl/invoices/update-invoice-payment-methods-configuration.md): PATCH /invoices/template/{templateId}/payment-methods-configuration - API to update template late fees configuration by template id - [Update schedule](https://marketplace.gohighlevel.com/docs/ghl/invoices/update-invoice-schedule.md): PUT /invoices/schedule/{scheduleId} - API to update an schedule by schedule id - [Update template](https://marketplace.gohighlevel.com/docs/ghl/invoices/update-invoice-template.md): PUT /invoices/template/{templateId} - API to update an template by template id - [Update template late fees configuration](https://marketplace.gohighlevel.com/docs/ghl/invoices/update-invoice-template-late-fees-configuration.md): PATCH /invoices/template/{templateId}/late-fees-configuration - API to update template late fees configuration by template id - [Void invoice](https://marketplace.gohighlevel.com/docs/ghl/invoices/void-invoice.md): POST /invoices/{invoiceId}/void - API to delete invoice by invoice id ## knowledge-base - [knowledge-base: all 19 endpoints, compact](https://marketplace.gohighlevel.com/docs/llms/v3/knowledge-base.md): Knowledge Base API - [Create a new FAQ inside knowledge base](https://marketplace.gohighlevel.com/docs/ghl/knowledge-base/create.md): POST /knowledge-bases/faqs - Creates a new question-and-answer entry in a knowledge base. WHEN TO USE: use this when you need to add a brand-new FAQ; use update to change an existing one... - [Create a new knowledge base (max 15 knowledge bases per location)](https://marketplace.gohighlevel.com/docs/ghl/knowledge-base/create-knowledge-base.md): POST /knowledge-bases/ - Creates a new knowledge base for a location (maximum 15 per location). WHEN TO USE: use this when you need to add a brand-new knowledge source; use updateKno... - [Delete an existing knowledge base FAQ](https://marketplace.gohighlevel.com/docs/ghl/knowledge-base/delete.md): DELETE /knowledge-bases/faqs/{id} - Permanently deletes one FAQ from a knowledge base. WHEN TO USE: use this when a canned answer is outdated; use update to revise it instead; use list to find... - [Delete a file from knowledge base](https://marketplace.gohighlevel.com/docs/ghl/knowledge-base/delete-file.md): DELETE /knowledge-bases/files/{fileId} - Deletes one uploaded file from the authenticated location so the AI no longer uses it. WHEN TO USE: use this when you need to remove a document; use getFiles... - [Delete a knowledge base](https://marketplace.gohighlevel.com/docs/ghl/knowledge-base/delete-knowledge-base.md): DELETE /knowledge-bases/{knowledgeBaseId} - Permanently deletes a knowledge base and its associated trained content. WHEN TO USE: use this when the whole knowledge source is no longer needed; use delet... - [Delete trained pages](https://marketplace.gohighlevel.com/docs/ghl/knowledge-base/delete-trained-urls-for-knowledge-base.md): DELETE /knowledge-bases/crawler - Removes trained website pages from a knowledge base so the AI no longer references them. WHEN TO USE: use this when you need to drop specific or all trained... - [Start crawling and discover pages for training](https://marketplace.gohighlevel.com/docs/ghl/knowledge-base/discover-website.md): POST /knowledge-bases/crawler - Starts a website crawl that discovers pages for later AI training. WHEN TO USE: use this when you need to scan a site before training; use trainDiscoveredUrl... - [Get all trained page links by knowledge base](https://marketplace.gohighlevel.com/docs/ghl/knowledge-base/get-all-website-urls-data-by-knowledge-base.md): GET /knowledge-bases/crawler - Lists discovered and trained website pages for a knowledge base, with pagination and optional URL filter. WHEN TO USE: use this when you need to inspect craw... - [Get crawling status for the latest operation](https://marketplace.gohighlevel.com/docs/ghl/knowledge-base/get-crawling-status-for-latest-operation.md): GET /knowledge-bases/crawler/status - Fetches crawl/train progress for a specific operation, or the latest operation when operationId is omitted. WHEN TO USE: use this when you need to poll a dis... - [Get file by id](https://marketplace.gohighlevel.com/docs/ghl/knowledge-base/get-file-by-id.md): GET /knowledge-bases/files/{fileId} - Retrieves one uploaded file by id for the authenticated location. WHEN TO USE: use this when you need to inspect a single file; use getFilesByKnowledgeBasePu... - [Get all files by knowledge base](https://marketplace.gohighlevel.com/docs/ghl/knowledge-base/get-files-by-knowledge-base-public.md): GET /knowledge-bases/files - Lists files uploaded to a knowledge base, with optional pagination and name search. WHEN TO USE: use this when you need to see uploaded documents; use upload... - [Get knowledge base by ID](https://marketplace.gohighlevel.com/docs/ghl/knowledge-base/get-knowledge-base-by-id.md): GET /knowledge-bases/{knowledgeBaseId} - Retrieves one knowledge base by id, including name, metadata, and timestamps. WHEN TO USE: use this when you need to inspect a single knowledge base; use lis... - [Preview Sitemap URLs](https://marketplace.gohighlevel.com/docs/ghl/knowledge-base/get-sitemap-preview.md): POST /knowledge-bases/crawler/sitemap-preview - Returns a paginated, searchable list of sitemap URLs without starting a crawl. WHEN TO USE: use this when you need to preview sitemap URLs before a crawl; us... - [Get all FAQs by knowledge base with pagination support](https://marketplace.gohighlevel.com/docs/ghl/knowledge-base/list.md): GET /knowledge-bases/faqs - Retrieves Q&A entries for a knowledge base, with cursor or offset pagination and optional question search. WHEN TO USE: use this when you need to list existi... - [Get all knowledge bases for a location by location Id (paginated)](https://marketplace.gohighlevel.com/docs/ghl/knowledge-base/list-all-knowledge-bases-paginated.md): GET /knowledge-bases/ - Lists knowledge bases for a sub-account (location), with optional name search and cursor pagination. WHEN TO USE: use this when you need to see which knowled... - [Train discovered website pages and ingest into the knowledge base](https://marketplace.gohighlevel.com/docs/ghl/knowledge-base/train-discovered-urls.md): POST /knowledge-bases/crawler/train - Queues selected discovered pages so the AI ingests their content into the knowledge base. WHEN TO USE: use this when discoverWebsite has already found pages;... - [Update an existing knowledge base FAQ](https://marketplace.gohighlevel.com/docs/ghl/knowledge-base/update.md): PUT /knowledge-bases/faqs/{id} - Updates the question and/or answer of an existing FAQ. WHEN TO USE: use this when you need to change wording on a FAQ you already have; use create to add a n... - [Update a knowledge base](https://marketplace.gohighlevel.com/docs/ghl/knowledge-base/update-knowledge-base.md): PUT /knowledge-bases/{id} - Updates the name and/or description of an existing knowledge base. WHEN TO USE: use this when you need to rename or re-describe a knowledge base; use createK... - [Uploads a file to knowledge base (max file size: 10MB)](https://marketplace.gohighlevel.com/docs/ghl/knowledge-base/upload-file.md): POST /knowledge-bases/files - Uploads a PDF, DOC, or DOCX file (max 10MB) into a knowledge base for training. WHEN TO USE: use this when you need to add a document source; use getFilesByK... ## links - [links: all 6 endpoints, compact](https://marketplace.gohighlevel.com/docs/llms/v3/links.md): Trigger Links API - [Create Link](https://marketplace.gohighlevel.com/docs/ghl/links/create-link.md): POST /links/ - [Delete Link](https://marketplace.gohighlevel.com/docs/ghl/links/delete-link.md): DELETE /links/{linkId} - [Get Link by ID](https://marketplace.gohighlevel.com/docs/ghl/links/get-link-by-id.md): GET /links/id/{linkId} - Get a single link by its ID - [Get Links](https://marketplace.gohighlevel.com/docs/ghl/links/get-links.md): GET /links/ - [Search Trigger Links](https://marketplace.gohighlevel.com/docs/ghl/links/search-trigger-links.md): GET /links/search - Get list of links by searching - [Update Link](https://marketplace.gohighlevel.com/docs/ghl/links/update-link.md): PUT /links/{linkId} ## locations - [locations: all 32 endpoints, compact](https://marketplace.gohighlevel.com/docs/llms/v3/locations.md): Sub-Account (Formerly location) API - [Create Custom Field](https://marketplace.gohighlevel.com/docs/ghl/locations/create-custom-field.md): POST /locations/{locationId}/customFields - [Create Custom Value](https://marketplace.gohighlevel.com/docs/ghl/locations/create-custom-value.md): POST /locations/{locationId}/customValues - [Create Sub-Account (Formerly Location)](https://marketplace.gohighlevel.com/docs/ghl/locations/create-location.md): POST /locations/ -

Create a new Sub-Account (Formerly Location) based on the data provided

:::info This feature is only available on Agency Pro ($497)... - [Create Recurring Task](https://marketplace.gohighlevel.com/docs/ghl/locations/create-recurring-task.md): POST /locations/{locationId}/recurring-tasks - [Create Tag](https://marketplace.gohighlevel.com/docs/ghl/locations/create-tag.md): POST /locations/{locationId}/tags - Create tag - [DELETE an email/sms template](https://marketplace.gohighlevel.com/docs/ghl/locations/delete-an-email-sms-template.md): DELETE /locations/{locationId}/templates/{id} - [Delete Custom Field](https://marketplace.gohighlevel.com/docs/ghl/locations/delete-custom-field.md): DELETE /locations/{locationId}/customFields/{id} - [Delete Custom Value](https://marketplace.gohighlevel.com/docs/ghl/locations/delete-custom-value.md): DELETE /locations/{locationId}/customValues/{id} - [Delete Sub-Account (Formerly Location)](https://marketplace.gohighlevel.com/docs/ghl/locations/delete-location.md): DELETE /locations/{locationId} - Delete a Sub-Account (Formerly Location) from the Agency - [Delete Recurring Task](https://marketplace.gohighlevel.com/docs/ghl/locations/delete-recurring-task.md): DELETE /locations/{locationId}/recurring-tasks/{id} - [Delete tag](https://marketplace.gohighlevel.com/docs/ghl/locations/delete-tag.md): DELETE /locations/{locationId}/tags/{tagId} - [GET all or email/sms templates](https://marketplace.gohighlevel.com/docs/ghl/locations/get-all-or-email-sms-templates.md): GET /locations/{locationId}/templates - [Get Conversation Channel](https://marketplace.gohighlevel.com/docs/ghl/locations/get-conversation-channel.md): GET /locations/{locationId}/conversationChannels/{type} - Get the conversation channel providers configured for a location by type (SMS or Email) - [Get Custom Field](https://marketplace.gohighlevel.com/docs/ghl/locations/get-custom-field.md): GET /locations/{locationId}/customFields/{id} - [Get Custom Fields](https://marketplace.gohighlevel.com/docs/ghl/locations/get-custom-fields.md): GET /locations/{locationId}/customFields - [Get Custom Value](https://marketplace.gohighlevel.com/docs/ghl/locations/get-custom-value.md): GET /locations/{locationId}/customValues/{id} - [Get Custom Values](https://marketplace.gohighlevel.com/docs/ghl/locations/get-custom-values.md): GET /locations/{locationId}/customValues - [Get Sub-Account (Formerly Location)](https://marketplace.gohighlevel.com/docs/ghl/locations/get-location.md): GET /locations/{locationId} - Get details of a Sub-Account (Formerly Location) by passing the sub-account id - [Get Permissions](https://marketplace.gohighlevel.com/docs/ghl/locations/get-location-permissions.md): GET /locations/{locationId}/permissions - Get Sub-Account (Formerly Location) permissions - [Get Tags](https://marketplace.gohighlevel.com/docs/ghl/locations/get-location-tags.md): GET /locations/{locationId}/tags - Get Sub-Account (Formerly Location) Tags - [Get Recurring Task By Id](https://marketplace.gohighlevel.com/docs/ghl/locations/get-recurring-task-by-id.md): GET /locations/{locationId}/recurring-tasks/{id} - [Get tag by id](https://marketplace.gohighlevel.com/docs/ghl/locations/get-tag-by-id.md): GET /locations/{locationId}/tags/{tagId} - [Fetch Timezones](https://marketplace.gohighlevel.com/docs/ghl/locations/get-timezones.md): GET /locations/{locationId}/timezones - Fetch the available timezones - [Put Sub-Account (Formerly Location)](https://marketplace.gohighlevel.com/docs/ghl/locations/put-location.md): PUT /locations/{locationId} - Update a Sub-Account (Formerly Location) based on the data provided - [Search](https://marketplace.gohighlevel.com/docs/ghl/locations/search-locations.md): GET /locations/search - Search Sub-Account (Formerly Location) - [Task Search Filter](https://marketplace.gohighlevel.com/docs/ghl/locations/task-search.md): POST /locations/{locationId}/tasks/search - Task Search - [Update Custom Field](https://marketplace.gohighlevel.com/docs/ghl/locations/update-custom-field.md): PUT /locations/{locationId}/customFields/{id} - [Update Custom Value](https://marketplace.gohighlevel.com/docs/ghl/locations/update-custom-value.md): PUT /locations/{locationId}/customValues/{id} - [Update Permissions](https://marketplace.gohighlevel.com/docs/ghl/locations/update-location-permissions.md): PUT /locations/{locationId}/permissions - Update Sub-Account (Formerly Location) permissions - [Update Recurring Task](https://marketplace.gohighlevel.com/docs/ghl/locations/update-recurring-task.md): PUT /locations/{locationId}/recurring-tasks/{id} - [Update tag](https://marketplace.gohighlevel.com/docs/ghl/locations/update-tag.md): PUT /locations/{locationId}/tags/{tagId} - [Uploads File to customFields](https://marketplace.gohighlevel.com/docs/ghl/locations/upload-file-custom-fields.md): POST /locations/{locationId}/customFields/upload ## marketplace - [marketplace: all 9 endpoints, compact](https://marketplace.gohighlevel.com/docs/llms/v3/marketplace.md): Developer marketplace API v3 - [Create a new wallet charge](https://marketplace.gohighlevel.com/docs/ghl/marketplace/charge.md): POST /marketplace/billing/charges - [Delete a wallet charge](https://marketplace.gohighlevel.com/docs/ghl/marketplace/delete-charge.md): DELETE /marketplace/billing/charges/{chargeId} - [Get all wallet charges](https://marketplace.gohighlevel.com/docs/ghl/marketplace/get-charges.md): GET /marketplace/billing/charges - [Get Installer Details](https://marketplace.gohighlevel.com/docs/ghl/marketplace/get-installer-details.md): GET /marketplace/app/{appId}/installations - Fetches installer details for the authenticated user. This endpoint returns information about the company, location, user, and installation details associate... - [Get rebilling config for an app subscription and usage plans](https://marketplace.gohighlevel.com/docs/ghl/marketplace/get-rebilling-config-for-app.md): GET /marketplace/app/{appId}/rebilling-config/location/{locationId} - Get rebilling config for an app subscription and usage plans for the authenticated sub-account. This endpoint returns the subscription and usage plans for an... - [Get specific wallet charge details](https://marketplace.gohighlevel.com/docs/ghl/marketplace/get-specific-charge.md): GET /marketplace/billing/charges/{chargeId} - [Check if account has sufficient funds](https://marketplace.gohighlevel.com/docs/ghl/marketplace/has-funds.md): GET /marketplace/billing/charges/has-funds - [Migrate external authentication connection](https://marketplace.gohighlevel.com/docs/ghl/marketplace/migrate-connection.md): POST /marketplace/external-auth/migration - Migrates an external authentication connection credentials (basic or oauth2) for a specific app and location. This endpoint validates the app configuration,... - [Uninstall an application](https://marketplace.gohighlevel.com/docs/ghl/marketplace/uninstall-application.md): DELETE /marketplace/app/{appId}/installations - Uninstalls an application from your company or a specific location. This will remove the application`s access and stop all its functionalities ## medias - [medias: all 7 endpoints, compact](https://marketplace.gohighlevel.com/docs/llms/v3/medias.md): Media Storage API - [Bulk Delete / Trash Files/Folders](https://marketplace.gohighlevel.com/docs/ghl/medias/bulk-delete-media-objects.md): PUT /medias/delete-files - Soft-deletes or trashes multiple files and folders in a single request - [Bulk Update Files/Folders](https://marketplace.gohighlevel.com/docs/ghl/medias/bulk-update-media-objects.md): PUT /medias/update-files - Updates metadata or status of multiple files and folders - [Create Folder](https://marketplace.gohighlevel.com/docs/ghl/medias/create-media-folder.md): POST /medias/folder - Creates a new folder in the media storage - [Delete File or Folder](https://marketplace.gohighlevel.com/docs/ghl/medias/delete-media-content.md): DELETE /medias/{id} - Deletes specific file or folder from the media storage - [Get List of Files/Folders](https://marketplace.gohighlevel.com/docs/ghl/medias/fetch-media-content.md): GET /medias/files - Fetches list of files and folders from the media storage - [Update File/Folder](https://marketplace.gohighlevel.com/docs/ghl/medias/update-media-object.md): POST /medias/{id} - Updates a single file or folder by ID - [Upload File into Media Storage](https://marketplace.gohighlevel.com/docs/ghl/medias/upload-media-content.md): POST /medias/upload-file - If hosted is set to true then fileUrl is required. Else file is required. If adding a file, maximum allowed is 25 MB. For video files, the maximum allowed si... ## oauth - [oauth: all 3 endpoints, compact](https://marketplace.gohighlevel.com/docs/llms/v3/oauth.md): OAuth 2.0 v3 - [Get Access Token](https://marketplace.gohighlevel.com/docs/ghl/oauth/get-access-token.md): POST /oauth/token - Use Access Tokens to access CRM resources on behalf of an authenticated location/company. - [Get Location where app is installed](https://marketplace.gohighlevel.com/docs/ghl/oauth/get-installed-location.md): GET /oauth/installed-locations - This API allows you fetch location where app is installed upon - [Get Location Access Token from Agency Token](https://marketplace.gohighlevel.com/docs/ghl/oauth/get-location-access-token.md): POST /oauth/location-token - This API allows you to generate locationAccessToken from AgencyAccessToken ## objects - [objects: all 17 endpoints, compact](https://marketplace.gohighlevel.com/docs/llms/v3/objects.md): CUSTOM_OBJECTS API - [Create Custom Object](https://marketplace.gohighlevel.com/docs/ghl/objects/create-custom-object-schema.md): POST /objects/ - Allows you to create a custom object schema. To understand objects and records, please have a look at the documentation here : https://doc.clickup.com/863100... - [Create Note](https://marketplace.gohighlevel.com/docs/ghl/objects/create-note.md): POST /notes/ - [Create Record](https://marketplace.gohighlevel.com/docs/ghl/objects/create-object-record.md): POST /objects/{schemaKey}/records - Create a Custom Object Record. Supported Objects business and custom objects. Documentation Link - https://doc.clickup.com/8631005/d/h/87cpx-277156/93bf0c2e2... - [Delete Note](https://marketplace.gohighlevel.com/docs/ghl/objects/delete-note.md): DELETE /notes/{id} - [Delete Record](https://marketplace.gohighlevel.com/docs/ghl/objects/delete-object-record.md): DELETE /objects/{schemaKey}/records/{id} - Delete Record By Id . Supported Objects are business and custom objects. - [Get Note](https://marketplace.gohighlevel.com/docs/ghl/objects/get-note.md): GET /notes/{id} - [Get all objects for a location](https://marketplace.gohighlevel.com/docs/ghl/objects/get-object-by-location-id.md): GET /objects/ - Get all objects for a location. Supported Objects are contact, opportunity, business and custom objects.To understand objects and records, please have a look... - [Get Object Schema by key / id](https://marketplace.gohighlevel.com/docs/ghl/objects/get-object-schema-by-key.md): GET /objects/{key} - Retrieve Object Schema by key or ID. This will return the schema of the custom object, including all its fields and properties. Supported objects include con... - [Get Record By Id](https://marketplace.gohighlevel.com/docs/ghl/objects/get-record-by-id.md): GET /objects/{schemaKey}/records/{id} - Allows you to get a Standard Object like business and custom object record by Id - [Restore Note](https://marketplace.gohighlevel.com/docs/ghl/objects/restore-note.md): POST /notes/{id}/restore - [Search Notes](https://marketplace.gohighlevel.com/docs/ghl/objects/search-notes.md): POST /notes/search - [Search Object Records](https://marketplace.gohighlevel.com/docs/ghl/objects/search-object-records.md): POST /objects/{schemaKey}/records/search - Supported Objects are custom objects and standard objects like "business". Documentation Link - https://doc.clickup.com/8631005/d/h/87cpx-277156/93bf0c2e2317... - [Update Object Schema By Key / Id](https://marketplace.gohighlevel.com/docs/ghl/objects/update-custom-object.md): PUT /objects/{key} - Update Custom Object Schema or standard object's like contact, opportunity, business searchable fields. To understand objects and records, please have a look... - [Update Note](https://marketplace.gohighlevel.com/docs/ghl/objects/update-note.md): PUT /notes/{id} - [Update Note Attachments](https://marketplace.gohighlevel.com/docs/ghl/objects/update-note-attachments.md): PATCH /notes/{id}/attachments - [Update Note Relations](https://marketplace.gohighlevel.com/docs/ghl/objects/update-note-relations.md): PUT /notes/{id}/relations - [Update Record](https://marketplace.gohighlevel.com/docs/ghl/objects/update-object-record.md): PUT /objects/{schemaKey}/records/{id} - Update a Custom Object Record by Id. Supported Objects are business and custom objects. Documentation Link - https://doc.clickup.com/8631005/d/h/87cpx-277156... ## opportunities - [opportunities: all 16 endpoints, compact](https://marketplace.gohighlevel.com/docs/llms/v3/opportunities.md): Opportunities API v3 - [Add Followers](https://marketplace.gohighlevel.com/docs/ghl/opportunities/add-followers-opportunity.md): POST /opportunities/{id}/followers - [Create Opportunity](https://marketplace.gohighlevel.com/docs/ghl/opportunities/create-opportunity.md): POST /opportunities/ - [Create Pipeline](https://marketplace.gohighlevel.com/docs/ghl/opportunities/create-pipeline.md): POST /opportunities/pipelines - Creates a new pipeline with at least one stage for a given location. Pipeline names must be unique per location (case-insensitive), and stage names must be u... - [Delete Opportunity](https://marketplace.gohighlevel.com/docs/ghl/opportunities/delete-opportunity.md): DELETE /opportunities/{id} - [Delete Pipeline](https://marketplace.gohighlevel.com/docs/ghl/opportunities/delete-pipeline.md): DELETE /opportunities/pipelines/{pipelineId} - Permanently deletes a pipeline and all opportunities within it. This action is irreversible — all opportunities across every stage of this pipeline will be r... - [Get lost reason](https://marketplace.gohighlevel.com/docs/ghl/opportunities/get-lost-reason.md): GET /opportunities/lost-reason - [Get Opportunity](https://marketplace.gohighlevel.com/docs/ghl/opportunities/get-opportunity.md): GET /opportunities/{id} - [Get Pipeline](https://marketplace.gohighlevel.com/docs/ghl/opportunities/get-pipeline.md): GET /opportunities/pipelines/{pipelineId} - Retrieves a single pipeline by its ID, including all its stages and configuration. - [Get Pipelines](https://marketplace.gohighlevel.com/docs/ghl/opportunities/get-pipelines.md): GET /opportunities/pipelines - [Remove Followers](https://marketplace.gohighlevel.com/docs/ghl/opportunities/remove-followers-opportunity.md): DELETE /opportunities/{id}/followers - Allows removal of one or all followers from an opportunity. - [Search Opportunities](https://marketplace.gohighlevel.com/docs/ghl/opportunities/search-opportunities-advanced.md): POST /opportunities/search - Search Opportunities based on combinations of advanced filters. Documentation Link - https://doc.clickup.com/8631005/d/h/87cpx-424216/7bf11bc9b94f80f - [Search Opportunity](https://marketplace.gohighlevel.com/docs/ghl/opportunities/search-opportunity.md): GET /opportunities/search - [Update Opportunity](https://marketplace.gohighlevel.com/docs/ghl/opportunities/update-opportunity.md): PUT /opportunities/{id} - [Update Opportunity Status](https://marketplace.gohighlevel.com/docs/ghl/opportunities/update-opportunity-status.md): PUT /opportunities/{id}/status - [Update Pipeline](https://marketplace.gohighlevel.com/docs/ghl/opportunities/update-pipeline.md): PUT /opportunities/pipelines/{pipelineId} - Updates an existing pipeline. The `stages` array is a full replacement — include the `id` field on existing stages to retain them, or omit it to create a new... - [Upsert Opportunity](https://marketplace.gohighlevel.com/docs/ghl/opportunities/upsert-opportunity.md): POST /opportunities/upsert ## payments - [payments: all 23 endpoints, compact](https://marketplace.gohighlevel.com/docs/llms/v3/payments.md): Payments API - [Create new provider config](https://marketplace.gohighlevel.com/docs/ghl/payments/create-config.md): POST /payments/custom-provider/connect - API to create a new payment config for given location - [Create Coupon](https://marketplace.gohighlevel.com/docs/ghl/payments/create-coupon.md): POST /payments/coupon - The "Create Coupon" API allows you to create a new promotional coupon with customizable parameters such as discount amount, validity period, usage limits, an... - [Create new integration](https://marketplace.gohighlevel.com/docs/ghl/payments/create-integration.md): POST /payments/custom-provider/provider - API to create a new association for an app and location - [Create White-label Integration Provider](https://marketplace.gohighlevel.com/docs/ghl/payments/create-integration-provider.md): POST /payments/integrations/provider/whitelabel - The "Create White-label Integration Provider" API allows adding a new payment provider integration to the system which is built on top of Authorize.net or NM... - [Create order fulfillment](https://marketplace.gohighlevel.com/docs/ghl/payments/create-order-fulfillment.md): POST /payments/orders/{orderId}/fulfillments - The "Order Fulfillment" API facilitates the process of fulfilling an order. - [Custom-provider marketplace app update capabilities](https://marketplace.gohighlevel.com/docs/ghl/payments/custom-provider-marketplace-app-update-capabilities.md): PUT /payments/custom-provider/capabilities - Toggle capabilities for the marketplace app tied to the OAuth client - [Delete Coupon](https://marketplace.gohighlevel.com/docs/ghl/payments/delete-coupon.md): DELETE /payments/coupon - The "Delete Coupon" API allows you to permanently remove a coupon from your system using its unique identifier. Use this endpoint to discontinue promotional... - [Deleting an existing integration](https://marketplace.gohighlevel.com/docs/ghl/payments/delete-integration.md): DELETE /payments/custom-provider/provider - API to delete an association for an app and location - [Disconnect existing provider config](https://marketplace.gohighlevel.com/docs/ghl/payments/disconnect-config.md): POST /payments/custom-provider/disconnect - API to disconnect an existing payment config for given location - [Fetch given provider config](https://marketplace.gohighlevel.com/docs/ghl/payments/fetch-config.md): GET /payments/custom-provider/connect - API for fetching an existing payment config for given location - [Fetch Coupon](https://marketplace.gohighlevel.com/docs/ghl/payments/get-coupon.md): GET /payments/coupon - The "Get Coupon Details" API enables you to retrieve comprehensive information about a specific coupon using either its unique identifier or promotional code... - [Get Order by ID](https://marketplace.gohighlevel.com/docs/ghl/payments/get-order-by-id.md): GET /payments/orders/{orderId} - The "Get Order by ID" API allows to retrieve information for a specific order using its unique identifier. Use this endpoint to fetch details for a single or... - [Get Subscription by ID](https://marketplace.gohighlevel.com/docs/ghl/payments/get-subscription-by-id.md): GET /payments/subscriptions/{subscriptionId} - The "Get Subscription by ID" API allows to retrieve information for a specific subscription using its unique identifier. Use this endpoint to fetch details f... - [Get Transaction by ID](https://marketplace.gohighlevel.com/docs/ghl/payments/get-transaction-by-id.md): GET /payments/transactions/{transactionId} - The "Get Transaction by ID" API allows to retrieve information for a specific transaction using its unique identifier. Use this endpoint to fetch details for... - [List Coupons](https://marketplace.gohighlevel.com/docs/ghl/payments/list-coupons.md): GET /payments/coupon/list - The "List Coupons" API allows you to retrieve a list of all coupons available in your location. Use this endpoint to view all promotional offers and special... - [List White-label Integration Providers](https://marketplace.gohighlevel.com/docs/ghl/payments/list-integration-providers.md): GET /payments/integrations/provider/whitelabel - The "List White-label Integration Providers" API allows to retrieve a paginated list of integration providers. Customize your results by filtering whitelabel... - [List fulfillment](https://marketplace.gohighlevel.com/docs/ghl/payments/list-order-fulfillment.md): GET /payments/orders/{orderId}/fulfillments - List all fulfillment history of an order - [List Order Notes](https://marketplace.gohighlevel.com/docs/ghl/payments/list-order-notes.md): GET /payments/orders/{orderId}/notes - List all notes of an order - [List Orders](https://marketplace.gohighlevel.com/docs/ghl/payments/list-orders.md): GET /payments/orders - The "List Orders" API allows to retrieve a paginated list of orders. Customize your results by filtering orders based on name, alt type, order status, paymen... - [List Subscriptions](https://marketplace.gohighlevel.com/docs/ghl/payments/list-subscriptions.md): GET /payments/subscriptions - The "List Subscriptions" API allows to retrieve a paginated list of subscriptions. Customize your results by filtering subscriptions based on name, alt type,... - [List Transactions](https://marketplace.gohighlevel.com/docs/ghl/payments/list-transactions.md): GET /payments/transactions - The "List Transactions" API allows to retrieve a paginated list of transactions. Customize your results by filtering transactions based on name, alt type, tr... - [Record Order Payment](https://marketplace.gohighlevel.com/docs/ghl/payments/record-order-payment.md): POST /payments/orders/{orderId}/record-payment - The "Record Order Payment" API allows to record a payment for an order. Use this endpoint to record payment for an order and update the order status to "Paid". - [Update Coupon](https://marketplace.gohighlevel.com/docs/ghl/payments/update-coupon.md): PUT /payments/coupon - The "Update Coupon" API enables you to modify existing coupon details such as discount values, validity periods, usage limits, and other promotional paramete... ## phone-system - [phone-system: all 4 endpoints, compact](https://marketplace.gohighlevel.com/docs/llms/v3/phone-system.md): LC Phone API v3 - [List active numbers](https://marketplace.gohighlevel.com/docs/ghl/phone-system/active-numbers.md): GET /phone-system/numbers/location/{locationId} - List active numbers. With `version: v3`, the HTTP 200 body is the standard success envelope (`status`, `data`, `message`, `statusCode`). The v3 list payload... - [List number pools](https://marketplace.gohighlevel.com/docs/ghl/phone-system/get-number-pool-list.md): GET /phone-system/number-pools - Returns number pools for the location. Requires locationId as a query parameter. - [List available phone numbers](https://marketplace.gohighlevel.com/docs/ghl/phone-system/list-available-numbers-for-a-country.md): GET /phone-system/numbers/location/{locationId}/available - Search Twilio inventory for purchasable phone numbers in a country for the given location. - [Purchase number for location](https://marketplace.gohighlevel.com/docs/ghl/phone-system/purchase-number-for-location.md): POST /phone-system/numbers/location/{locationId}/purchase - Purchase number for location. With `version: v3`, the HTTP 201 body is the standard success envelope (`status`, `data`, `message`, `statusCode`). The v3 purc... ## products - [products: all 27 endpoints, compact](https://marketplace.gohighlevel.com/docs/llms/v3/products.md): Products API - [Bulk Edit Products and Prices](https://marketplace.gohighlevel.com/docs/ghl/products/bulk-edit.md): POST /products/bulk-update/edit - API to bulk edit products and their associated prices (max 30 entities) - [Bulk Update Products](https://marketplace.gohighlevel.com/docs/ghl/products/bulk-update.md): POST /products/bulk-update - API to bulk update products (price, availability, collections, delete) - [Update Product Reviews](https://marketplace.gohighlevel.com/docs/ghl/products/bulk-update-product-review.md): POST /products/reviews/bulk-update - Update one or multiple product reviews: status, reply, etc. - [Create Price for a Product](https://marketplace.gohighlevel.com/docs/ghl/products/create-price-for-product.md): POST /products/{productId}/price - The "Create Price for a Product" API allows adding a new price associated with a specific product to the system. Use this endpoint to create a price with the... - [Create Product](https://marketplace.gohighlevel.com/docs/ghl/products/create-product.md): POST /products/ - The "Create Product" API allows adding a new product to the system. Use this endpoint to create a product with the specified details. Ensure that the require... - [Create Product Collection](https://marketplace.gohighlevel.com/docs/ghl/products/create-product-collection.md): POST /products/collections - Create a new Product Collection for a specific location - [Delete Price by ID for a Product](https://marketplace.gohighlevel.com/docs/ghl/products/delete-price-by-id-for-product.md): DELETE /products/{productId}/price/{priceId} - The "Delete Price by ID for a Product" API allows deleting a specific price associated with a particular product using its unique identifier. Use this endpoi... - [Delete Product by ID](https://marketplace.gohighlevel.com/docs/ghl/products/delete-product-by-id.md): DELETE /products/{productId} - The "Delete Product by ID" API allows deleting a specific product using its unique identifier. Use this endpoint to remove a product from the system. - [Delete Product Collection](https://marketplace.gohighlevel.com/docs/ghl/products/delete-product-collection.md): DELETE /products/collections/{collectionId} - Delete specific product collection with Id :collectionId - [Delete Product Review](https://marketplace.gohighlevel.com/docs/ghl/products/delete-product-review.md): DELETE /products/reviews/{reviewId} - Delete specific product review - [List Inventory](https://marketplace.gohighlevel.com/docs/ghl/products/get-list-inventory.md): GET /products/inventory - The "List Inventory API allows the user to retrieve a paginated list of inventory items. Use this endpoint to fetch details for multiple items in the invento... - [Get Price by ID for a Product](https://marketplace.gohighlevel.com/docs/ghl/products/get-price-by-id-for-product.md): GET /products/{productId}/price/{priceId} - The "Get Price by ID for a Product" API allows retrieving information for a specific price associated with a particular product using its unique identifier.... - [Get Product by ID](https://marketplace.gohighlevel.com/docs/ghl/products/get-product-by-id.md): GET /products/{productId} - The "Get Product by ID" API allows to retrieve information for a specific product using its unique identifier. Use this endpoint to fetch details for a singl... - [Fetch Product Collections](https://marketplace.gohighlevel.com/docs/ghl/products/get-product-collection.md): GET /products/collections - Internal API to fetch the Product Collections - [Get Details about individual product collection](https://marketplace.gohighlevel.com/docs/ghl/products/get-product-collection-id.md): GET /products/collections/{collectionId} - [Fetch Product Reviews](https://marketplace.gohighlevel.com/docs/ghl/products/get-product-reviews.md): GET /products/reviews - API to fetch the Product Reviews - [Fetch Product Store Stats](https://marketplace.gohighlevel.com/docs/ghl/products/get-product-store-stats.md): GET /products/store/{storeId}/stats - API to fetch the total number of products, included in the store, and excluded from the store and other stats - [Fetch Review Count as per status](https://marketplace.gohighlevel.com/docs/ghl/products/get-reviews-count.md): GET /products/reviews/count - API to fetch the Review Count as per status - [List Products](https://marketplace.gohighlevel.com/docs/ghl/products/list-invoices.md): GET /products/ - The "List Products" API allows to retrieve a paginated list of products. Customize your results by filtering products based on name or paginate through the l... - [List Prices for a Product](https://marketplace.gohighlevel.com/docs/ghl/products/list-prices-for-product.md): GET /products/{productId}/price - The "List Prices for a Product" API allows retrieving a paginated list of prices associated with a specific product. Customize your results by filtering pric... - [Update product display priorities in store](https://marketplace.gohighlevel.com/docs/ghl/products/update-display-priority.md): POST /products/store/{storeId}/priority - API to set the display priority of products in a store - [Update Inventory](https://marketplace.gohighlevel.com/docs/ghl/products/update-inventory.md): POST /products/inventory - The Update Inventory API allows the user to bulk update the inventory for multiple items. Use this endpoint to update the available quantity and out-of-stock... - [Update Price by ID for a Product](https://marketplace.gohighlevel.com/docs/ghl/products/update-price-by-id-for-product.md): PUT /products/{productId}/price/{priceId} - The "Update Price by ID for a Product" API allows modifying information for a specific price associated with a particular product using its unique identifier... - [Update Product by ID](https://marketplace.gohighlevel.com/docs/ghl/products/update-product-by-id.md): PUT /products/{productId} - The "Update Product by ID" API allows modifying information for a specific product using its unique identifier. Use this endpoint to update details for a sin... - [Update Product Collection](https://marketplace.gohighlevel.com/docs/ghl/products/update-product-collection.md): PUT /products/collections/{collectionId} - Update a specific product collection with Id :collectionId - [Update Product Reviews](https://marketplace.gohighlevel.com/docs/ghl/products/update-product-review.md): PUT /products/reviews/{reviewId} - Update status, reply, etc of a particular review - [Action to include/exclude the product in store](https://marketplace.gohighlevel.com/docs/ghl/products/update-store-status.md): POST /products/store/{storeId} - API to update the status of products in a particular store ## projects - [projects: all 45 endpoints, compact](https://marketplace.gohighlevel.com/docs/llms/v3/projects.md): Projects API - [Add A Task To An Additional List](https://marketplace.gohighlevel.com/docs/ghl/projects/add-projects-list-task.md): POST /projects/lists/{listId}/tasks/{taskId} - Adds an existing task to this list as an additional (non-home) membership. `POST` is not idempotent — adding a task that is already on the list conflicts. Re... - [Fetch Tasks By IDs](https://marketplace.gohighlevel.com/docs/ghl/projects/batch-projects-tasks.md): POST /projects/tasks/batch - Fetches multiple tasks by id in one call. Results are RBAC-filtered — inaccessible ids are omitted rather than erroring. Does not return embedded `subtasks`. - [Create List In Folder](https://marketplace.gohighlevel.com/docs/ghl/projects/create-projects-folder-list.md): POST /projects/folders/{folderId}/lists - Creates a list inside a folder so tasks can be organized under that folder. - [Create Task](https://marketplace.gohighlevel.com/docs/ghl/projects/create-projects-list-task.md): POST /projects/lists/{listId}/tasks - Creates a task in this list as its home list. `title` and `dueDate` are required. `dueDate` accepts ISO 8601 or a Unix timestamp string; responses return ISO... - [Create Recurring Task](https://marketplace.gohighlevel.com/docs/ghl/projects/create-projects-recurring-task.md): POST /projects/recurring-tasks - Creates one recurring task definition. There is no list endpoint and no list binding. The schedule uses `rruleOptions` (`intervalType`, not a raw RRULE strin... - [Create Space](https://marketplace.gohighlevel.com/docs/ghl/projects/create-projects-space.md): POST /projects/spaces - Creates a top-level space (optional privacy + `userIds` when private). A default list is seeded server-side but is not returned on the public response. - [Create Folder](https://marketplace.gohighlevel.com/docs/ghl/projects/create-projects-space-folder.md): POST /projects/spaces/{spaceId}/folders - Creates a folder inside a space. Folders group lists; a default list is seeded server-side but omitted from the public response. - [Create List In Space](https://marketplace.gohighlevel.com/docs/ghl/projects/create-projects-space-list.md): POST /projects/spaces/{spaceId}/lists - Creates a list directly under a space. Prefer Create List In Folder when the list should live inside a folder. - [Create Comment](https://marketplace.gohighlevel.com/docs/ghl/projects/create-projects-task-comment.md): POST /projects/tasks/{taskId}/comments - Creates a top-level comment or a one-level reply (`parentCommentId`). Field is TipTap `body` — see [TipTap documentation](https://tiptap.dev/docs/editor/intr... - [Delete Folder](https://marketplace.gohighlevel.com/docs/ghl/projects/delete-projects-folder.md): DELETE /projects/folders/{folderId} - Deletes a folder and its nested lists. Response: `{ "success": true }` (no `id`). - [Revoke Folder Member](https://marketplace.gohighlevel.com/docs/ghl/projects/delete-projects-folder-user.md): DELETE /projects/folders/{folderId}/users/{userId} - Revokes a direct user grant on the folder. Idempotent if the grant is already absent. Does not change `isPrivate`. Inherited access from ancestors is unchanged. - [Delete List](https://marketplace.gohighlevel.com/docs/ghl/projects/delete-projects-list.md): DELETE /projects/lists/{listId} - Deletes a list. Response: `{ "success": true }` (no `id`). Tasks that used it as home list follow product delete rules. - [Revoke List Member](https://marketplace.gohighlevel.com/docs/ghl/projects/delete-projects-list-user.md): DELETE /projects/lists/{listId}/users/{userId} - Revokes a direct user grant on the list. Idempotent if the grant is already absent. Does not change `isPrivate`. Inherited access from ancestors is unchanged. - [Delete Recurring Task](https://marketplace.gohighlevel.com/docs/ghl/projects/delete-projects-recurring-task.md): DELETE /projects/recurring-tasks/{id} - Deletes a recurring task definition so future occurrences stop being created. - [Delete Space](https://marketplace.gohighlevel.com/docs/ghl/projects/delete-projects-space.md): DELETE /projects/spaces/{spaceId} - Deletes a space. Response: `{ "success": true }` (no `id`). Nested folders, lists, and related data follow the product delete rules for that space. - [Revoke Space Member](https://marketplace.gohighlevel.com/docs/ghl/projects/delete-projects-space-user.md): DELETE /projects/spaces/{spaceId}/users/{userId} - Revokes a direct user grant on the space. Idempotent if the grant is already absent. Does not change `isPrivate`. Inherited access from ancestors is unchanged. - [Delete A Task Or Subtask](https://marketplace.gohighlevel.com/docs/ghl/projects/delete-projects-task.md): DELETE /projects/tasks/{taskId} - Deletes a task or subtask by id. Response: `{ "success": true, "id": "" }`. A second delete on the same id returns not found. - [Delete A Comment](https://marketplace.gohighlevel.com/docs/ghl/projects/delete-projects-task-comment.md): DELETE /projects/tasks/{taskId}/comments/{commentId} - Deletes a comment. Deleted comments do not appear in Get Task Comments. Response: `{ "success": true }` (no `id`). **403** unless the caller is the comment a... - [Get Folder](https://marketplace.gohighlevel.com/docs/ghl/projects/get-projects-folder.md): GET /projects/folders/{folderId} - Fetches one folder by id. - [Get Lists In Folder](https://marketplace.gohighlevel.com/docs/ghl/projects/get-projects-folder-lists.md): GET /projects/folders/{folderId}/lists - Pages lists under a folder (`lists[]`, not `items`). Same paging as space children. Example: open a folder view, then Create List In Folder for a client proj... - [Get Users With Folder Access](https://marketplace.gohighlevel.com/docs/ghl/projects/get-projects-folder-users.md): GET /projects/folders/{folderId}/users - Lists users with access to the folder as one unified `users` page (`source`: `direct` | `inherited`). `skip` / `limit` / `total` apply to the combined list.... - [Get List](https://marketplace.gohighlevel.com/docs/ghl/projects/get-projects-list.md): GET /projects/lists/{listId} - Fetches one list by id. `parentId` is the parent folder or space. Statuses: `GET /projects/lists/{listId}/statuses`. - [Get List Statuses](https://marketplace.gohighlevel.com/docs/ghl/projects/get-projects-list-statuses.md): GET /projects/lists/{listId}/statuses - Returns the effective status groups for a list — the same set as the owning space, resolved server-side. Prefer this over walking `parentId` up to the space. - [Get Users With List Access](https://marketplace.gohighlevel.com/docs/ghl/projects/get-projects-list-users.md): GET /projects/lists/{listId}/users - Lists users with access to the list as one unified `users` page (`source`: `direct` | `inherited`). `skip` / `limit` / `total` apply to the combined list. No... - [Get Recurring Task By Id](https://marketplace.gohighlevel.com/docs/ghl/projects/get-projects-recurring-task.md): GET /projects/recurring-tasks/{id} - Fetches one recurring task definition by id. - [Get Space](https://marketplace.gohighlevel.com/docs/ghl/projects/get-projects-space.md): GET /projects/spaces/{spaceId} - Fetches one space by id, including name, privacy, and color. - [Get Folders](https://marketplace.gohighlevel.com/docs/ghl/projects/get-projects-space-folders.md): GET /projects/spaces/{spaceId}/folders - Pages folders under a space (`folders[]`, not `items`). Simple: `?limit=20` then `?limit=20&cursor={nextCursor}`. Deep-link: add `anchorId` of a known folder... - [Get Lists In Space](https://marketplace.gohighlevel.com/docs/ghl/projects/get-projects-space-lists.md): GET /projects/spaces/{spaceId}/lists - Pages lists directly under a space (`lists[]`, not `items`; excludes lists inside folders). Same `limit`/`cursor` paging as folders; optional `anchorId` for... - [Get Space Statuses](https://marketplace.gohighlevel.com/docs/ghl/projects/get-projects-space-statuses.md): GET /projects/spaces/{spaceId}/statuses - Returns effective status groups for the space (`groups[].statuses[]` with `key`, `label`, `color`, `position`). Use when rendering a board or mapping task `s... - [Get Users With Space Access](https://marketplace.gohighlevel.com/docs/ghl/projects/get-projects-space-users.md): GET /projects/spaces/{spaceId}/users - Lists users with access as one unified `users` page (`source`: `direct` | `inherited`). `skip` / `limit` / `total` apply to the combined list (direct first).... - [Get All Spaces](https://marketplace.gohighlevel.com/docs/ghl/projects/get-projects-spaces.md): GET /projects/spaces - Returns the location workspace (`id`, `name`) and every space the token can access. Marketplace example: bootstrap a Projects UI by listing spaces, then crea... - [Get A Task By ID](https://marketplace.gohighlevel.com/docs/ghl/projects/get-projects-task.md): GET /projects/tasks/{taskId} - Fetches one task or subtask by id. Fields are returned under `task`. A subtask’s parent id is `task.properties.parentTaskId`. TipTap content is `task.propert... - [Get Lists For A Task](https://marketplace.gohighlevel.com/docs/ghl/projects/get-projects-task-lists.md): GET /projects/tasks/{taskId}/lists - Returns every list the task belongs to. The home list is the one with `isHome: true` (same id as `properties.primaryListId`). Other rows are additional lists... - [Get Tasks](https://marketplace.gohighlevel.com/docs/ghl/projects/list-projects-list-tasks.md): GET /projects/lists/{listId}/tasks - Pages tasks whose primary (home) list is this list. Use `limit` and query `searchAfter` from the previous response `searchAfter` (opaque base64url string). P... - [Get Task Comments](https://marketplace.gohighlevel.com/docs/ghl/projects/list-projects-task-comments.md): GET /projects/tasks/{taskId}/comments - Pages comments on a task. Deleted comments are omitted. Replies are returned as sibling rows in `comments` with `parentCommentId` set — there is no nested `r... - [Remove A Task From Additional List](https://marketplace.gohighlevel.com/docs/ghl/projects/remove-projects-list-task.md): DELETE /projects/lists/{listId}/tasks/{taskId} - Removes an additional-list membership. Response: `{ "success": true }`. Cannot remove the task’s home list — move the home list first. This does not delete t... - [Search Tasks](https://marketplace.gohighlevel.com/docs/ghl/projects/search-projects-tasks.md): POST /projects/tasks/search - Searches tasks across the location with filters, sort, free-text `query`, and optional `subtaskViewMode`. Requires `limit`; pass body `searchAfter` from the... - [Move Task](https://marketplace.gohighlevel.com/docs/ghl/projects/set-projects-task-home-list.md): PUT /projects/tasks/{taskId}/home-list - Moves the task’s home list to another list. Response: `{ "success": true }`. **409** has two causes and one status: the task is already on the destination li... - [Update Folder](https://marketplace.gohighlevel.com/docs/ghl/projects/update-projects-folder.md): PATCH /projects/folders/{folderId} - Updates folder fields such as name, color, or privacy. `color` must be a palette swatch. `userIds` when making the folder private adds grants and does not re... - [Update List](https://marketplace.gohighlevel.com/docs/ghl/projects/update-projects-list.md): PATCH /projects/lists/{listId} - Updates list fields such as name, color, or privacy. `color` must be a palette swatch. `userIds` when making the list private adds grants and does not revoke... - [Update Recurring Task](https://marketplace.gohighlevel.com/docs/ghl/projects/update-projects-recurring-task.md): PUT /projects/recurring-tasks/{id} - Updates schedule or template fields on an existing recurring task definition. - [Update Space](https://marketplace.gohighlevel.com/docs/ghl/projects/update-projects-space.md): PATCH /projects/spaces/{spaceId} - Updates space fields such as name, color, or privacy. `color` must be one of the 16 palette swatches. When setting `isPrivate: true`, `userIds` is required a... - [Update A Task Or Subtask](https://marketplace.gohighlevel.com/docs/ghl/projects/update-projects-task.md): PATCH /projects/tasks/{taskId} - Updates a task or subtask by id (title, TipTap `body`, status, dates, assignees, priority, `parentTaskId`, custom fields, etc.). Response is `{ "task": { … }... - [Update A Comment](https://marketplace.gohighlevel.com/docs/ghl/projects/update-projects-task-comment.md): PATCH /projects/tasks/{taskId}/comments/{commentId} - Updates TipTap `body` and, when sent, `mentionedUserIds` — see [TipTap documentation](https://tiptap.dev/docs/editor/introduction). **403** unless the caller... - [Update Statuses](https://marketplace.gohighlevel.com/docs/ghl/projects/upsert-projects-space-statuses.md): PUT /projects/spaces/{spaceId}/statuses - Replaces the whole space status set. Send every group you want to keep — omitted groups and statuses are removed. There is no `If-Match` and no per-status ro... ## proposals - [proposals: all 4 endpoints, compact](https://marketplace.gohighlevel.com/docs/llms/v3/proposals.md): Documents and Contracts API - [List documents](https://marketplace.gohighlevel.com/docs/ghl/proposals/list-documents-contracts.md): GET /proposals/document - List documents for a location - [List templates](https://marketplace.gohighlevel.com/docs/ghl/proposals/list-documents-contracts-templates.md): GET /proposals/templates - List document contract templates for a location - [Send document](https://marketplace.gohighlevel.com/docs/ghl/proposals/send-documents-contracts.md): POST /proposals/document/send - Send document to a client - [Send template](https://marketplace.gohighlevel.com/docs/ghl/proposals/send-documents-contracts-template.md): POST /proposals/templates/send - Send template to a client ## saas-api - [saas-api: all 17 endpoints, compact](https://marketplace.gohighlevel.com/docs/llms/v3/saas-api.md): SaaS API - [Allow Attach Rebilling](https://marketplace.gohighlevel.com/docs/ghl/saas-api/allow-attach-rebilling.md): POST /saas/allow-attach-rebilling/{locationId} - Marks a SaaS sub-account as awaiting rebilling attach and optionally stores the rebilling configuration that should be applied when the rebilling config is c... - [Disable SaaS for locations](https://marketplace.gohighlevel.com/docs/ghl/saas-api/bulk-disable-saas.md): POST /saas/bulk-disable-saas/{companyId} - Disable SaaS for locations for given locationIds - [Bulk Enable SaaS](https://marketplace.gohighlevel.com/docs/ghl/saas-api/bulk-enable-saas.md): POST /saas/bulk-enable-saas/{companyId} - Enable SaaS mode for multiple locations with support for both SaaS v1 and v2 - [Enable SaaS for Sub-Account (Formerly Location)](https://marketplace.gohighlevel.com/docs/ghl/saas-api/enable-saas-location.md): POST /saas/enable-saas/{locationId} - Enable SaaS for Sub-Account (Formerly Location) based on the data provided - [Update SaaS subscription](https://marketplace.gohighlevel.com/docs/ghl/saas-api/generate-payment-link.md): PUT /saas/update-saas-subscription/{locationId} - Update SaaS subscription for given locationId and customerId - [Get Agency Plans](https://marketplace.gohighlevel.com/docs/ghl/saas-api/get-agency-plans.md): GET /saas/agency-plans/{companyId} - Fetch all agency subscription plans for a given company ID - [Get Location Subscription Details](https://marketplace.gohighlevel.com/docs/ghl/saas-api/get-location-subscription.md): GET /saas/get-saas-subscription/{locationId} - Fetch subscription details for a specific location from location metadata - [Get Location Wallet Balance](https://marketplace.gohighlevel.com/docs/ghl/saas-api/get-location-wallet-balance.md): GET /saas/companies/{companyId}/locations/{locationId}/wallet-balance - Fetch the wallet balance for a specific location. Returns a resource object with balance details. - [Get SaaS Locations](https://marketplace.gohighlevel.com/docs/ghl/saas-api/get-saas-locations.md): GET /saas/saas-locations/{companyId} - Fetch all SaaS-activated locations for a company with pagination - [Get SaaS Plan](https://marketplace.gohighlevel.com/docs/ghl/saas-api/get-saas-plan.md): GET /saas/saas-plan/{planId} - Fetch a specific SaaS plan by plan ID - [List agency wallet transactions](https://marketplace.gohighlevel.com/docs/ghl/saas-api/list-agency-wallet-transactions.md): POST /saas/companies/{companyId}/wallet-transactions - Fetch paginated wallet transactions for an agency (company). Supports skip/limit pagination, date-range and charge-type filters, timezone normalization, and... - [List location wallet transactions](https://marketplace.gohighlevel.com/docs/ghl/saas-api/list-location-wallet-transactions.md): POST /saas/locations/{locationId}/wallet-transactions - Fetch paginated wallet transactions for a sub-account (location). Supports skip/limit pagination, date-range and charge-type filters, timezone normalization,... - [Get locations by stripeId with companyId](https://marketplace.gohighlevel.com/docs/ghl/saas-api/locations.md): GET /saas/locations - Get locations by stripeCustomerId or stripeSubscriptionId with companyId - [Pause location](https://marketplace.gohighlevel.com/docs/ghl/saas-api/pause-location.md): POST /saas/pause/{locationId} - Pause Sub account for given locationId - [Remove attached config](https://marketplace.gohighlevel.com/docs/ghl/saas-api/remove-attached-config.md): POST /saas/remove-attached-config/{locationId} - Clears attached SaaS plan (attachPlanId/attachPriceId) and/or attached rebilling config from a sub-account in setup_pending, and sets suspendedInfo.payment_p... - [Update Location Wallet Balance](https://marketplace.gohighlevel.com/docs/ghl/saas-api/update-location-wallet-balance.md): POST /saas/companies/{companyId}/locations/{locationId}/wallet-balance/complimentary-credits - Update the wallet balance or complimentary credit settings for a specific location. Supports partial updates via updateMask field (AIP-134 compliant). - [Update Rebilling](https://marketplace.gohighlevel.com/docs/ghl/saas-api/update-rebilling.md): POST /saas/update-rebilling/{companyId} - Bulk update rebilling for given locationIds ## snapshots - [snapshots: all 4 endpoints, compact](https://marketplace.gohighlevel.com/docs/llms/v3/snapshots.md): Snapshots API - [Create Snapshot Share Link](https://marketplace.gohighlevel.com/docs/ghl/snapshots/create-snapshot-share-link.md): POST /snapshots/share/link - Create a share link for snapshot - [Get Snapshots](https://marketplace.gohighlevel.com/docs/ghl/snapshots/get-custom-snapshots.md): GET /snapshots/ - Get a list of all own and imported Snapshots - [Get Last Snapshot Push](https://marketplace.gohighlevel.com/docs/ghl/snapshots/get-latest-snapshot-push.md): GET /snapshots/snapshot-status/{snapshotId}/location/{locationId} - Get Latest Snapshot Push Status for a location id - [Get Snapshot Push between Dates](https://marketplace.gohighlevel.com/docs/ghl/snapshots/get-snapshot-push.md): GET /snapshots/snapshot-status/{snapshotId} - Get list of sub-accounts snapshot pushed in time period ## social-planner - [social-planner: all 53 endpoints, compact](https://marketplace.gohighlevel.com/docs/llms/v3/social-planner.md): Social Planner API v3 - [Apply watermark to an image](https://marketplace.gohighlevel.com/docs/ghl/social-planner/add-watermark-on-image.md): POST /social-media-posting/{locationId}/watermarks/add-image-watermark - Apply a watermark to an image using either a specific template ID or by resolving the template bound to a specific connected account. - [Connect Account (Step 3 of 3)](https://marketplace.gohighlevel.com/docs/ghl/social-planner/attach-oauth-accounts.md): POST /social-media-posting/oauth/{locationId}/{platform}/accounts/{accountId} - ## OAuth Connection Flow - Step 3: Connect the Account - [Bulk Delete Social Planner Posts](https://marketplace.gohighlevel.com/docs/ghl/social-planner/bulk-delete-social-planner-posts.md): POST /social-media-posting/{locationId}/posts/bulk-delete - Deletes multiple posts based on the provided list of post IDs. This operation is useful for clearing up large numbers of posts efficiently. - [Clone a queue item](https://marketplace.gohighlevel.com/docs/ghl/social-planner/clone-queue-item.md): POST /social-media-posting/category/queues/{queueId}/items/{itemId}/clone - Duplicates an existing queue item at a specified order position. Requires an active edit session. - [Create a comment or reply](https://marketplace.gohighlevel.com/docs/ghl/social-planner/create-comment.md): POST /social-media-posting/comments/{platform} - Create a top-level comment on a post (`isParentThread: true`, `parentId` = postId) or a reply to an existing comment (`isParentThread: false`, `parentId` = c... - [Like a comment](https://marketplace.gohighlevel.com/docs/ghl/social-planner/create-like.md): POST /social-media-posting/comments/{platform}/{id}/like - Like a comment by its internal comment ID (the `_id` returned by the list-comments endpoint — not the native platform ID). - [Create post](https://marketplace.gohighlevel.com/docs/ghl/social-planner/create-post.md): POST /social-media-posting/{locationId}/posts - Create posts for all supported platforms. It is possible to create customized posts per channel by using the same platform account IDs in a request and hitti... - [Create a new category queue](https://marketplace.gohighlevel.com/docs/ghl/social-planner/create-queue.md): POST /social-media-posting/category/queues - Creates a queue in draft status for a category. Published posts are auto-added. Use update endpoint to activate. - [Create a new item in the queue](https://marketplace.gohighlevel.com/docs/ghl/social-planner/create-queue-item.md): POST /social-media-posting/category/queues/{queueId}/create/item - Adds a new post item to a queue. Use sessionId for edit session or directToQueue for immediate addition. - [Create a watermark template](https://marketplace.gohighlevel.com/docs/ghl/social-planner/create-watermark.md): POST /social-media-posting/{locationId}/watermarks - Create a new reusable watermark template for a location. The template stores the watermark image URL, position, scale, opacity, padding, and the connected ac... - [Delete Account](https://marketplace.gohighlevel.com/docs/ghl/social-planner/delete-account.md): DELETE /social-media-posting/{locationId}/accounts/{id} - Delete account and account from group - [Delete CSV](https://marketplace.gohighlevel.com/docs/ghl/social-planner/delete-csv.md): DELETE /social-media-posting/{locationId}/csv/{id} - Delete a CSV import and all its associated posts - [Delete CSV Post](https://marketplace.gohighlevel.com/docs/ghl/social-planner/delete-csv-post.md): DELETE /social-media-posting/{locationId}/csv/{csvId}/post/{postId} - Delete a specific post from a CSV import - [Delete an active post and schedule the next one](https://marketplace.gohighlevel.com/docs/ghl/social-planner/delete-current-active-post-and-schedule-next.md): DELETE /social-media-posting/category/queues/{postId}/active-post - Deletes a post that is currently scheduled and automatically triggers the scheduling of the next available post in the queue. - [Unlike a comment](https://marketplace.gohighlevel.com/docs/ghl/social-planner/delete-like.md): DELETE /social-media-posting/comments/{platform}/{id}/like - Remove a like from a comment by its internal comment ID (the `_id` returned by the list-comments endpoint — not the native platform ID). - [Delete Post](https://marketplace.gohighlevel.com/docs/ghl/social-planner/delete-post.md): DELETE /social-media-posting/{locationId}/posts/{id} - [Delete an item from a queue](https://marketplace.gohighlevel.com/docs/ghl/social-planner/delete-queue-item.md): DELETE /social-media-posting/category/queues/{queueId}/items/{itemId} - Deletes an item from a specific category queue. - [Delete a watermark template by ID](https://marketplace.gohighlevel.com/docs/ghl/social-planner/delete-watermark.md): DELETE /social-media-posting/{locationId}/watermarks/{templateId} - Soft-delete a watermark template. The template is marked as deleted and no longer applies at post-publish time, but the record is preserved in the database.... - [Discard edit session changes](https://marketplace.gohighlevel.com/docs/ghl/social-planner/discard-edit-session.md): POST /social-media-posting/category/queues/{queueId}/edit/discard - Cancels the edit session and deletes all staged changes without affecting the live queue. - [Edit post](https://marketplace.gohighlevel.com/docs/ghl/social-planner/edit-post.md): PUT /social-media-posting/{locationId}/posts/{id} - Create posts for all supported platforms. It is possible to create customized posts per channel by using the same platform account IDs in a request and hitti... - [Get all categories with their queue status](https://marketplace.gohighlevel.com/docs/ghl/social-planner/fetch-available-categories.md): GET /social-media-posting/category/queues/available-categories - Returns categories with status: "available" (no queue), "in_queue" (active/paused queue), or "draft" (queue in draft). - [Get scheduled posts calendar view](https://marketplace.gohighlevel.com/docs/ghl/social-planner/fetch-calendar-list.md): POST /social-media-posting/category/queues/list/calendar - Returns scheduled posts from active queues within a date range. Supports filtering by categories and accounts. - [Fetch calendar view for an edit session](https://marketplace.gohighlevel.com/docs/ghl/social-planner/fetch-edit-session-calendar.md): POST /social-media-posting/category/queues/{queueId}/edit/calendar - Retrieves a calendar preview of scheduled posts based on draft items within an edit session. This shows how posts would be scheduled if changes were saved. - [Fetch a category queue by ID](https://marketplace.gohighlevel.com/docs/ghl/social-planner/fetch-queue-by-id.md): GET /social-media-posting/category/queues/{queueId} - Retrieves the details of a single category queue by its unique ID. The response includes a count of posts within the queue that have errors. - [Fetch items from a queue](https://marketplace.gohighlevel.com/docs/ghl/social-planner/fetch-queue-items.md): POST /social-media-posting/category/queues/{queueId}/items - Returns paginated queue items. Pass sessionId to get draft items from an edit session instead of live items. - [Fetch category queues for a location](https://marketplace.gohighlevel.com/docs/ghl/social-planner/fetch-queues.md): POST /social-media-posting/category/queues/list - Retrieves a paginated list of all category queues for a given location, excluding any that have been marked as deleted. - [Fetch slot information for queue items](https://marketplace.gohighlevel.com/docs/ghl/social-planner/fetch-slots.md): POST /social-media-posting/category/queues/{queueId}/slots - Returns paginated slot information (scheduledDateTime, isSkipped) for queue items. Pass sessionId to get slots for draft items, or omit for live items. Call... - [Get Accounts](https://marketplace.gohighlevel.com/docs/ghl/social-planner/get-account.md): GET /social-media-posting/{locationId}/accounts - Get list of accounts and groups - [List watermark templates](https://marketplace.gohighlevel.com/docs/ghl/social-planner/get-all-watermarks.md): GET /social-media-posting/{locationId}/watermarks - Retrieve a paginated list of watermark templates for a specific location. Each template exposes the connected accounts it applies to via `accountIds`. Use th... - [Get category by ID](https://marketplace.gohighlevel.com/docs/ghl/social-planner/get-categories-id.md): GET /social-media-posting/{locationId}/categories/{id} - Retrieve a specific category by its ID - [Get categories by location ID](https://marketplace.gohighlevel.com/docs/ghl/social-planner/get-categories-location-id.md): GET /social-media-posting/{locationId}/categories - Retrieve all categories for a specific location with optional search and pagination - [List comments for a post or thread](https://marketplace.gohighlevel.com/docs/ghl/social-planner/get-comment-list.md): POST /social-media-posting/comments/{platform}/list - Paginated list of comments scoped to a post (`parentId` = postId) or a comment thread (`parentId` = commentId). Use `skip`/`limit` for pagination, `sortBy` f... - [Get Community Members](https://marketplace.gohighlevel.com/docs/ghl/social-planner/get-community-users.md): GET /social-media-posting/{locationId}/community/accounts/{accountId}/users - List the members you can publish a post as, for one connected Community channel. - [Get CSV Post](https://marketplace.gohighlevel.com/docs/ghl/social-planner/get-csv-post.md): GET /social-media-posting/{locationId}/csv/{id} - Get details of a specific CSV import including its posts - [Get Available Accounts (Step 2 of 3)](https://marketplace.gohighlevel.com/docs/ghl/social-planner/get-oauth-accounts.md): GET /social-media-posting/oauth/{locationId}/{platform}/accounts/{accountId} - ## OAuth Connection Flow - Step 2: Get Available Accounts - [Get post](https://marketplace.gohighlevel.com/docs/ghl/social-planner/get-post.md): GET /social-media-posting/{locationId}/posts/{id} - [Get posts](https://marketplace.gohighlevel.com/docs/ghl/social-planner/get-posts.md): POST /social-media-posting/{locationId}/posts/list - Get Posts - [Get Social Media Statistics](https://marketplace.gohighlevel.com/docs/ghl/social-planner/get-statistics.md): POST /social-media-posting/statistics - Retrieve analytics data for multiple social media accounts. Supports custom date ranges for both the current period and a comparison period. If no date range... - [Get tags by IDs](https://marketplace.gohighlevel.com/docs/ghl/social-planner/get-tags-by-ids.md): POST /social-media-posting/{locationId}/tags/details - Retrieve specific tags by their IDs - [Get tags by location ID](https://marketplace.gohighlevel.com/docs/ghl/social-planner/get-tags-location-id.md): GET /social-media-posting/{locationId}/tags - Retrieve all tags for a specific location with optional search and pagination - [Get Upload Status](https://marketplace.gohighlevel.com/docs/ghl/social-planner/get-upload-status.md): GET /social-media-posting/{locationId}/csv - Get the status of all CSV imports for a location - [Get a watermark template by ID](https://marketplace.gohighlevel.com/docs/ghl/social-planner/get-watermark.md): GET /social-media-posting/{locationId}/watermarks/{templateId} - Retrieve the full details of a specific watermark template, including its image URL, position, scale, opacity, padding, template name, and the connected acco... - [Reset an item in a queue](https://marketplace.gohighlevel.com/docs/ghl/social-planner/reset-queue-item.md): PUT /social-media-posting/category/queues/{queueId}/items/{itemId}/reset - Resets a specific queue item to its original state, discarding any modifications made. - [Save edit session changes](https://marketplace.gohighlevel.com/docs/ghl/social-planner/save-edit-session.md): POST /social-media-posting/category/queues/{queueId}/edit/save - Applies all staged changes to the live queue and closes the edit session. - [Set Accounts](https://marketplace.gohighlevel.com/docs/ghl/social-planner/set-accounts.md): POST /social-media-posting/{locationId}/set-accounts - Set social media accounts for a CSV import to publish posts to - [Start CSV Finalize](https://marketplace.gohighlevel.com/docs/ghl/social-planner/start-csv-finalize.md): PATCH /social-media-posting/{locationId}/csv/{id} - Finalize a CSV import and schedule all posts for publishing - [Start or resume an edit session](https://marketplace.gohighlevel.com/docs/ghl/social-planner/start-edit-session.md): POST /social-media-posting/category/queues/{queueId}/edit/start - Creates a draft copy of queue items for editing. Changes are staged until saved or discarded. - [Start OAuth Flow (Step 1 of 3)](https://marketplace.gohighlevel.com/docs/ghl/social-planner/start-oauth.md): GET /social-media-posting/oauth/{platform}/start - ## OAuth Connection Flow - Step 1: Initiate OAuth - [Update queue settings or status](https://marketplace.gohighlevel.com/docs/ghl/social-planner/update-queue.md): PUT /social-media-posting/category/queues/{queueId} - Updates queue status (active/paused/deleted), time slots, or skip dates. - [Update an item in a queue](https://marketplace.gohighlevel.com/docs/ghl/social-planner/update-queue-item.md): PUT /social-media-posting/category/queues/{queueId}/items/{itemId} - Updates the content or variations of a specific item within a category queue. - [Update a watermark template by ID](https://marketplace.gohighlevel.com/docs/ghl/social-planner/update-watermark.md): PUT /social-media-posting/{locationId}/watermarks/{templateId} - Update the config on an existing watermark template — image URL, position, scale, opacity, padding, template name, or the connected accounts it applies to. U... - [Upload CSV](https://marketplace.gohighlevel.com/docs/ghl/social-planner/upload-csv.md): POST /social-media-posting/{locationId}/csv - Upload a CSV file containing social media posts for bulk scheduling - [Validate Community Member](https://marketplace.gohighlevel.com/docs/ghl/social-planner/validate-community-user-membership.md): GET /social-media-posting/{locationId}/community/groups/{groupId}/users/{contactId}/validate - Check whether a contact can publish in a Community group. `isActive` is `true` only when the contact is an active member holding a role — the same condition... ## store - [store: all 18 endpoints, compact](https://marketplace.gohighlevel.com/docs/llms/v3/store.md): Store API - [Create Shipping Carrier](https://marketplace.gohighlevel.com/docs/ghl/store/create-shipping-carrier.md): POST /store/shipping-carrier - The "Create Shipping Carrier" API allows adding a new shipping carrier. - [Create Shipping Rate](https://marketplace.gohighlevel.com/docs/ghl/store/create-shipping-rate.md): POST /store/shipping-zone/{shippingZoneId}/shipping-rate - The "Create Shipping Rate" API allows adding a new shipping rate. - [Create Shipping Zone](https://marketplace.gohighlevel.com/docs/ghl/store/create-shipping-zone.md): POST /store/shipping-zone - The "Create Shipping Zone" API allows adding a new shipping zone. - [Create/Update Store Settings](https://marketplace.gohighlevel.com/docs/ghl/store/create-store-setting.md): POST /store/store-setting - Create or update store settings by altId and altType. - [Delete shipping carrier](https://marketplace.gohighlevel.com/docs/ghl/store/delete-shipping-carrier.md): DELETE /store/shipping-carrier/{shippingCarrierId} - Delete specific shipping carrier with Id :shippingCarrierId - [Delete shipping rate](https://marketplace.gohighlevel.com/docs/ghl/store/delete-shipping-rate.md): DELETE /store/shipping-zone/{shippingZoneId}/shipping-rate/{shippingRateId} - Delete specific shipping rate with Id :shippingRateId - [Delete shipping zone](https://marketplace.gohighlevel.com/docs/ghl/store/delete-shipping-zone.md): DELETE /store/shipping-zone/{shippingZoneId} - Delete specific shipping zone with Id :shippingZoneId - [Get available shipping rates](https://marketplace.gohighlevel.com/docs/ghl/store/get-available-shipping-zones.md): POST /store/shipping-zone/shipping-rates - This return available shipping rates for country based on order amount - [Get Shipping Carrier](https://marketplace.gohighlevel.com/docs/ghl/store/get-shipping-carriers.md): GET /store/shipping-carrier/{shippingCarrierId} - The "List Shipping Carrier" API allows to retrieve a paginated list of shipping carrier. - [Get Shipping Rate](https://marketplace.gohighlevel.com/docs/ghl/store/get-shipping-rates.md): GET /store/shipping-zone/{shippingZoneId}/shipping-rate/{shippingRateId} - The "List Shipping Rate" API allows to retrieve a paginated list of shipping rate. - [Get Shipping Zone](https://marketplace.gohighlevel.com/docs/ghl/store/get-shipping-zones.md): GET /store/shipping-zone/{shippingZoneId} - The "List Shipping Zone" API allows to retrieve a paginated list of shipping zone. - [Get Store Settings](https://marketplace.gohighlevel.com/docs/ghl/store/get-store-settings.md): GET /store/store-setting - Get store settings by altId and altType. - [List Shipping Carriers](https://marketplace.gohighlevel.com/docs/ghl/store/list-shipping-carriers.md): GET /store/shipping-carrier - The "List Shipping Carrier" API allows to retrieve a list of shipping carrier. - [List Shipping Rates](https://marketplace.gohighlevel.com/docs/ghl/store/list-shipping-rates.md): GET /store/shipping-zone/{shippingZoneId}/shipping-rate - The "List Shipping Rate" API allows to retrieve a list of shipping rate. - [List Shipping Zones](https://marketplace.gohighlevel.com/docs/ghl/store/list-shipping-zones.md): GET /store/shipping-zone - The "List Shipping Zone" API allows to retrieve a list of shipping zone. - [Update Shipping Carrier](https://marketplace.gohighlevel.com/docs/ghl/store/update-shipping-carrier.md): PUT /store/shipping-carrier/{shippingCarrierId} - The "update Shipping Carrier" API allows update a shipping carrier to the system. - [Update Shipping Rate](https://marketplace.gohighlevel.com/docs/ghl/store/update-shipping-rate.md): PUT /store/shipping-zone/{shippingZoneId}/shipping-rate/{shippingRateId} - The "update Shipping Rate" API allows update a shipping rate to the system. - [Update Shipping Zone](https://marketplace.gohighlevel.com/docs/ghl/store/update-shipping-zone.md): PUT /store/shipping-zone/{shippingZoneId} - The "update Shipping Zone" API allows update a shipping zone to the system. ## surveys - [surveys: all 2 endpoints, compact](https://marketplace.gohighlevel.com/docs/llms/v3/surveys.md): Surveys API - [Get Surveys](https://marketplace.gohighlevel.com/docs/ghl/surveys/get-surveys.md): GET /surveys/ - [Get Surveys Submissions](https://marketplace.gohighlevel.com/docs/ghl/surveys/get-surveys-submissions.md): GET /surveys/submissions ## users - [users: all 6 endpoints, compact](https://marketplace.gohighlevel.com/docs/llms/v3/users.md): Users API v3 - [Create User](https://marketplace.gohighlevel.com/docs/ghl/users/create-user.md): POST /users/ - [Delete User](https://marketplace.gohighlevel.com/docs/ghl/users/delete-user.md): DELETE /users/{userId} - [Filter Users by Email](https://marketplace.gohighlevel.com/docs/ghl/users/filter-users-by-email.md): POST /users/search/filter-by-email - Filter users by company ID, deleted status, and email array - [Get User](https://marketplace.gohighlevel.com/docs/ghl/users/get-user.md): GET /users/{userId} - [Search Users](https://marketplace.gohighlevel.com/docs/ghl/users/search-users.md): GET /users/search - [Update User](https://marketplace.gohighlevel.com/docs/ghl/users/update-user.md): PUT /users/{userId} ## voice-ai - [voice-ai: all 11 endpoints, compact](https://marketplace.gohighlevel.com/docs/llms/v3/voice-ai.md): Voice AI API - [Create Agent Action](https://marketplace.gohighlevel.com/docs/ghl/voice-ai/create-action.md): POST /voice-ai/actions - Create a new action for a voice AI agent. Actions define specific behaviors and capabilities for the agent during calls. - [Create Agent](https://marketplace.gohighlevel.com/docs/ghl/voice-ai/create-agent.md): POST /voice-ai/agents - Create a new voice AI agent configuration and settings - [Delete Agent Action](https://marketplace.gohighlevel.com/docs/ghl/voice-ai/delete-action.md): DELETE /voice-ai/actions/{actionId} - Delete an existing action from a voice AI agent. This permanently removes the action and its configuration. - [Delete Agent](https://marketplace.gohighlevel.com/docs/ghl/voice-ai/delete-agent.md): DELETE /voice-ai/agents/{agentId} - Delete a voice AI agent and all its configurations - [Get Agent Action](https://marketplace.gohighlevel.com/docs/ghl/voice-ai/get-action.md): GET /voice-ai/actions/{actionId} - Retrieve details of a specific action by its ID. Returns the action configuration including actionParameters. - [Get Agent](https://marketplace.gohighlevel.com/docs/ghl/voice-ai/get-agent.md): GET /voice-ai/agents/{agentId} - Retrieve detailed configuration and settings for a specific voice AI agent - [List Agents](https://marketplace.gohighlevel.com/docs/ghl/voice-ai/get-agents.md): GET /voice-ai/agents - Retrieve a paginated list of agents for given location. - [Get Call Log](https://marketplace.gohighlevel.com/docs/ghl/voice-ai/get-call-log.md): GET /voice-ai/dashboard/call-logs/{callId} - Returns a call log by callId. - [List Call Logs](https://marketplace.gohighlevel.com/docs/ghl/voice-ai/get-call-logs.md): GET /voice-ai/dashboard/call-logs - Returns call logs for Voice AI agents scoped to a location. Supports filtering by agent, contact, call type, action types, and date range (interpreted in the... - [Patch Agent](https://marketplace.gohighlevel.com/docs/ghl/voice-ai/patch-agent.md): PATCH /voice-ai/agents/{agentId} - Partially update an existing voice AI agent - [Update Agent Action](https://marketplace.gohighlevel.com/docs/ghl/voice-ai/update-action.md): PUT /voice-ai/actions/{actionId} - Update an existing action for a voice AI agent. Modifies the behavior and configuration of an agent action. ## workflows - [workflows: all 11 endpoints, compact](https://marketplace.gohighlevel.com/docs/llms/v3/workflows.md): Workflows API v3 - [Create Workflow](https://marketplace.gohighlevel.com/docs/ghl/workflows/create-workflow.md): POST /workflows/ - **Limited availability.** The workflow API is currently enabled for selected sub-accounts only; any other sub-account receives 403 `WORKFLOW_API_NOT_ENABLED_... - [Delete Workflow](https://marketplace.gohighlevel.com/docs/ghl/workflows/delete-workflow.md): DELETE /workflows/{workflowId} - **Limited availability.** The workflow API is currently enabled for selected sub-accounts only; any other sub-account receives 403 `WORKFLOW_API_NOT_ENABLED_... - [Get Workflow](https://marketplace.gohighlevel.com/docs/ghl/workflows/get-workflow.md): GET /workflows/ - [Get Workflow Definition](https://marketplace.gohighlevel.com/docs/ghl/workflows/get-workflow-definition.md): GET /workflows/{workflowId}/definition - **Limited availability.** The workflow API is currently enabled for selected sub-accounts only; any other sub-account receives 403 `WORKFLOW_API_NOT_ENABLED_... - [Get Workflow Log Statistics](https://marketplace.gohighlevel.com/docs/ghl/workflows/get-workflow-log-statistics.md): GET /workflows/{workflowId}/logs/aggregate - **Limited availability.** The workflow API is currently enabled for selected sub-accounts only; any other sub-account receives 403 `WORKFLOW_API_NOT_ENABLED_... - [Get Workflow Logs](https://marketplace.gohighlevel.com/docs/ghl/workflows/get-workflow-logs.md): GET /workflows/{workflowId}/logs - **Limited availability.** The workflow API is currently enabled for selected sub-accounts only; any other sub-account receives 403 `WORKFLOW_API_NOT_ENABLED_... - [Get Step Types](https://marketplace.gohighlevel.com/docs/ghl/workflows/get-workflow-step-types.md): GET /workflows/step-types - **Limited availability.** The workflow API is currently enabled for selected sub-accounts only; any other sub-account receives 403 `WORKFLOW_API_NOT_ENABLED_... - [Search Workflows](https://marketplace.gohighlevel.com/docs/ghl/workflows/search-workflows.md): POST /workflows/search - **Limited availability.** The workflow API is currently enabled for selected sub-accounts only; any other sub-account receives 403 `WORKFLOW_API_NOT_ENABLED_... - [Update Workflow Definition](https://marketplace.gohighlevel.com/docs/ghl/workflows/update-workflow-definition.md): PUT /workflows/{workflowId}/definition - **Limited availability.** The workflow API is currently enabled for selected sub-accounts only; any other sub-account receives 403 `WORKFLOW_API_NOT_ENABLED_... - [Update Workflow Status](https://marketplace.gohighlevel.com/docs/ghl/workflows/update-workflow-status.md): PUT /workflows/{workflowId}/status - **Limited availability.** The workflow API is currently enabled for selected sub-accounts only; any other sub-account receives 403 `WORKFLOW_API_NOT_ENABLED_... - [Validate Workflow Definition](https://marketplace.gohighlevel.com/docs/ghl/workflows/validate-workflow-definition.md): POST /workflows/definition/validate - **Limited availability.** The workflow API is currently enabled for selected sub-accounts only; any other sub-account receives 403 `WORKFLOW_API_NOT_ENABLED_...