Pipelines

Contacts

Example: e93ba61a-53b3-45e7-985a-c7732dbcdb69

Opportunities

GoHighLevel

Get Campaigns

Get Workflow

Search Users

Get User

Update User

Delete User

Get User by Location

Create User

Get Surveys Submissions

Get Surveys

Get a list of all own and imported Snapshots

Get Snapshots

Get locations by stripeCustomerId or stripeSubscriptionId with companyId

Get locations by stripeId with companyId

Update SaaS subscription for given locationId and customerId

Update SaaS subscription

Disable SaaS for locations for given locationIds

Disable SaaS for locations

Enable SaaS for location

Search Opportunity

Get Pipelines

Get Opportunity

Delete Opportunity

Update Opportunity

Update Opportunity Status

Upsert Opportunity

Add Followers

Remove Followers

Create Opportunity

Fetches list of files and folders from the media library

Get List of Files

If hosted is set to true then fileUrl is required. Else file is required. If adding a file, maximum allowed is 25 MB

Upload File into Media Library

Deletes specific file or folder from the media library

Delete File or Folder

Search Locations

Get details of a location by passing the location id

Get Location

Update a location/sub-account based on the data provided

Put Location

Delete a location/sub-account from the company

Delete Location

Get Location Tags

Create Tag

Get tag by id

Update tag

Delete tag

Task Search Filter

Get Custom Fields

Create Custom Field

Get Custom Field

Update Custom Field

Delete Custom Field

Uploads File to customFields

Get Custom Values

Create Custom Value

Get Custom Value

Update Custom Value

Delete Custom Value

Fetch Timezones

GET all or email/sms templates

Create a new location/sub-account based on the data provided

Create Location

Update Link

Delete Link

Get Links

Create Link

Create template

List templates

Get an template

Update template

Delete template

Create Invoice Schedule

List schedules

Get an schedule

Update schedule

Delete schedule

API to schedule an schedule invoice to start sending to the customer

Schedule an schedule invoice

API to manage auto payment for a schedule

Manage Auto payment for an schedule invoice

API to cancel a scheduled invoice by schedule id

Cancel an scheduled invoice

Get the next invoice number for the given location

Generate Invoice Number

Get invoice

Update invoice

Delete invoice

Void invoice

Send invoice

API to record manual payment for an invoice by invoice id

Record a manual payment for an invoice

Create Invoice

List invoices

Get Forms Submissions

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 id is the ID of your custom field and file id is a randomly generated id (or uuid) There is support for multiple file uploads as well. Have multiple fields in the format mentioned. File size is limited to 50 MB. The allowed file types are: <ul><li>PDF</li><li>DOCX</li><li>DOC</li><li>JPG</li><li>JPEG</li><li>PNG</li><li>GIF</li><li>CSV</li><li>XLSX</li><li>XLS</li><li>MP4</li><li>MPEG</li><li>ZIP</li><li>RAR</li><li>TXT</li><li>SVG</li></ul> The API will return the updated contact object.

Upload files to custom fields

Get Forms

Returns a list of all conversations matching the search criteria along with the sort and filter options selected.

Search Conversations

Get the conversation details based on the conversation ID

Get Conversation

Update the conversation details based on the conversation ID

Update Conversation

Delete the conversation details based on the conversation ID

Delete Conversation

Post the messageId for the API to delete a scheduled email message.

Cancel a scheduled email message.

Post the necessary fields for the API to send a new message.

Send a new message

Post the necessary fields for the API to add a new inbound message.

Add an inbound message

Post the messageId for the API to delete a scheduled message.

Cancel a scheduled message.

Post the necessary fields for the API to upload files. The files need to be a buffer with the key "fileAttachment". The allowed file types are: <ul><li>JPG</li><li>JPEG</li><li>PNG</li><li>MP4</li><li>MPEG</li><li>ZIP</li><li>RAR</li><li>PDF</li><li>DOC</li><li>DOCX</li><li>TXT</li></ul> The API will return an object with the URLs

Upload file attachments

Post the necessary fields for the API to update message status.

Update message status

Get the recording for a message by passing the message id

Get Recording by Message ID

Creates a new conversation with the data provided

Create Conversation

Get Duplicate Contact

Get all Tasks

Create Task

Get Task

Update Task

Delete Task

Update Task Completed

Salesforce

HubSpot

Microsoft Dynamics 365

Zoho CRM

Pipedrive

Freshsales

Keap

Mailchimp

SugarCRM

Outreach

Xero

ActiveCampaign

Capsule CRM

Salesloft

Agile CRM

SalesForce Pardot

SharpSpring

Teamleader

Insightly

Sage Accounting

Attio

Copper

Intercom

Zoho Books

Front

Close

NetSuite

Freshdesk

AWeber

Affinity

Apollo.io

Exact Online

Mautic

Ontraport

Jobnimbus

# Continuous Import of Contacts to Your App

This scenario enables your application to continuously sync Contacts from any external application to your app's API. It handles the initial import of Contacts and keeps them synchronized when a Contact is created, updated, or deleted in the external application.

When receiving Contacts data from the external application, the data is transformed into a format supported by your app's API. Additionally, if needed, your customers can customize the data mapping based on their specific external application setup.

## How It Works

1. **Initial Import**:
   - Perform the initial import by calling the Integration.app REST API or SDK in a loop from your code to retrieve data page by page.
   - Integration.app transforms the output into a consistent format compatible with your API, allowing you to save the data efficiently.

2. **Continuous Sync**:
   - Enable subscription via a single API or SDK call to continuously receive created, updated, or deleted events.
   - Integration.app manages all integration-specific logic, including subscribing to/unsubscribing from webhooks, custom polling of events, or performing periodic full syncs.
   - You will only receive the necessary events as real-time as supported by the external application's API.

Continuously Import Contacts to my App

Import Contacts and receive created/updated or deleted events

# Get all Contacts

This scenario enables your application to get a complete list of Contacts from any external application to your app's API in the same way. 

When receiving Contacts data from the external application, the data is transformed into a format supported by your app's API. Additionally, if needed, your customers can customize the data mapping based on their specific external application setup.

## How It Works

You will call a Integration.app REST API endpoint or SDK methods to retrieve a single page of Contacts along with the `cursor` if next page is available.
Repeate this request in a loop from your code to retrieve all Contacts page by page.


Get all Contacts

Imports all Contacts from any external application to your App.

Woosender

# Enrich newly created Contacts

This scenario enables your application to enrich with the new data any newly createad Contacts in external application. 

It handles subscription to the created events and Contact fields mapping from your application's schema to the application-specific schema.

## How It Works
1. **Configuration**:
   - You will setup the schema of fields that you wish to enrich Contact with and configure mapping to our default model.
   - If needed - your customer can customize this mapping based on their specific setup or even custom fields

2. **Enable receiving of Contact created events**:
   - Enable subscription via a single API or SDK call to continuously receive created events from external applications.
   - Integration.app manages all integration-specific logic, including subscribing to/unsubscribing from webhooks, custom polling of events, or performing periodic full syncs.
   - You will only receive the necessary events as real-time as supported by the external application's API.

2. **React to created Contacts**:
   - Integration.app flow will be launched when new Contact is created
   - It will send existing data to your app API, so you can decide how to enrich. Your API will return enriched data.
   - Integration.app will send enriched data to the external application mapped to the supported format based on the configuration above


Continuously Enrich Contacts

Receive all newly created contacts, send it to your app API to enrich with the new data and update contact back

# Delete Contact

This scenario allows your application to delete a Contact from any external application. 
You will pass ID of the Contact you want to delete and Integration.app will handle the rest.

## How It Works

1. **Delete Contact API call**:
   - Call Integration.app REST API or SDK with ID of the Contact you want to delete and Integration.app will send the correct request to the external app.


Delete Contact

Deletes Contact in any external application

# Create Contact

This scenario allows your application to create a Contact in any external application in the same way. 
You will pass Contact fields in any format your application support and Integration.app will handle mapping of them to the schema of any selected application.
Additionally, if needed, your customers can customize the data mapping based on their specific setup.


## How It Works

1. **Configuration**:
   - You will setup the schema of fields that you wish to create Contact with and configure mapping to our default model

2. **Create Contact API call**:
   - Call Integration.app REST API or SDK with payload matching the field mapping you configured. You can run it for any external application via the same request.
   - When called, Integration.app transforms your Contact data into a format compatible with the selected external application.
   - It then makes an API call to create the Contact in that specific application.


Create Contact

Creates Contact in any external application

# Update Contact

This scenario allows your application to update a Contact in any external application in the same way. 
You will pass  ID of the Contact you want to update and Contact fields in any format your application support and Integration.app will handle mapping of them to the schema of any selected application.
Additionally, if needed, your customers can customize the data mapping based on their specific setup.

## How It Works

1. **Configuration**:
   - You will setup the schema of fields that you wish to update Contact with and configure mapping to our default model

2. **Create Contact API call**:
   - Call Integration.app REST API or SDK with payload matching the field mapping you configured and ID. You can run it for any external application via the same request.
   - When called, Integration.app transforms your Contact data into a format compatible with the selected external application.
   - It then makes an API call to update the Contact in that specific application.


Update Contact

Updates Contact in any external application

# Realtime Full two-way Sync of Contacts

This scenario enables your application to fully sync Contacts between your app and any external application in both directions. It handles the initial import/export of Contacts and then sends events when a Contact is created, updated, or deleted on any side, as close to real-time as possible.

Contact fields will be mapped from your application's schema to the application-specific schema.

## How It Works

1. **Initial Sync**:
   - Perform the initial import by calling the Integration.app REST API or SDK in a loop from your code to retrieve data page by page. Integration.app transforms the output into a consistent format compatible with your API, allowing you to save and match data efficiently.
   - Make another set of requests to create Contacts in external app, if needed.

2. **Continuous Sync from External App**:
   - Enable subscription via a single API or SDK call to continuously receive created, updated, or deleted events from external applications.
   - Integration.app manages all integration-specific logic, including subscribing to/unsubscribing from webhooks, custom polling of events, or performing periodic full syncs.
   - You will only receive the necessary events as real-time as supported by the external application's API.


2. **Continuous Sync from Your App**:
   - You will get a single webhook URI that you will use to send events about created, updated, or deleted Contacts to Integration.app.
   - Once send, Integration.app will map the webhook payload to the format supported by external application and send the correct request


Two-way realtime sync of Contacts

Bi-directional realtime sync of Contacts with records deduplication

# Contact Unified API

This scenario contains the complete Contacts Unified API into your workspace. You will be able to seamlessly create, update, delete, and search Contacts while also receiving notifications on creation, updates, and deletions of Contacts in external applications. 

Integration.app will automatically manage the mapping of data to the unified schema, eliminating any concerns about differences across external applications. Additionally, you’ll have the flexibility to customize mappings for specific applications or customers, ensuring compatibility with their unique configurations when needed.


Field Name	API Key	Type
Id	id	string
Name	name	string
Stages	stages	array of strings
Show In Funnel	showInFunnel	boolean
Show In Pie Chart	showInPieChart	boolean

GoHighLevel API Integration Profile

How to work with Pipelines in GoHighLevel API

Operations on Pipelines Collection

Build every single integration your customers need with AI