@apteva/integrations 0.2.3 → 0.3.1

package/src/apps/gohighlevel.json

@@ -0,0 +1,596 @@
+{
+  "slug": "gohighlevel",
+  "name": "GoHighLevel",
+  "description": "GoHighLevel CRM and marketing platform. Manage contacts, opportunities, invoices, and tags.",
+  "logo": "https://www.google.com/s2/favicons?domain=gohighlevel.com&sz=128",
+  "categories": [
+    "crm",
+    "marketing",
+    "sales",
+    "contacts",
+    "invoices",
+    "opportunities"
+  ],
+  "base_url": "https://services.leadconnectorhq.com",
+  "auth": {
+    "types": [
+      "bearer"
+    ],
+    "headers": {
+      "Authorization": "Bearer {{token}}"
+    },
+    "credential_fields": [
+      {
+        "name": "accessToken",
+        "label": "Access Token",
+        "description": "GoHighLevel API access token (v2 API, generate from Settings > Business Profile > API Keys)"
+      }
+    ]
+  },
+  "tools": [
+    {
+      "name": "find_contacts",
+      "description": "Search contacts in GoHighLevel using advanced filters. Supports searching by name, email, phone, tags, and other attributes. Returns paginated results with contact details.",
+      "method": "POST",
+      "path": "/contacts/search",
+      "input_schema": {
+        "type": "object",
+        "properties": {
+          "locationId": {
+            "type": "string",
+            "description": "The location/sub-account ID to search contacts in."
+          },
+          "query": {
+            "type": "string",
+            "description": "Search query string to match against contact name, email, phone, etc."
+          },
+          "filters": {
+            "type": "array",
+            "description": "Array of filter objects for advanced search. Each filter has field, operator, and value.",
+            "items": {
+              "type": "object",
+              "properties": {
+                "field": {
+                  "type": "string",
+                  "description": "Field to filter on (e.g. 'email', 'phone', 'tags', 'name')."
+                },
+                "operator": {
+                  "type": "string",
+                  "description": "Comparison operator (e.g. 'eq', 'contains', 'starts_with')."
+                },
+                "value": {
+                  "type": "string",
+                  "description": "Value to filter by."
+                }
+              }
+            }
+          },
+          "page": {
+            "type": "integer",
+            "description": "Page number for pagination. Defaults to 1.",
+            "default": 1
+          },
+          "pageLimit": {
+            "type": "integer",
+            "description": "Number of results per page. Defaults to 20, maximum 100.",
+            "default": 20
+          }
+        },
+        "required": [
+          "locationId"
+        ]
+      }
+    },
+    {
+      "name": "create_contact",
+      "description": "Create a new contact in GoHighLevel. Requires a locationId and at least one identifier (email or phone). Supports setting name, tags, custom fields, and other attributes.",
+      "method": "POST",
+      "path": "/contacts/",
+      "input_schema": {
+        "type": "object",
+        "properties": {
+          "locationId": {
+            "type": "string",
+            "description": "The location/sub-account ID to create the contact in."
+          },
+          "firstName": {
+            "type": "string",
+            "description": "Contact's first name."
+          },
+          "lastName": {
+            "type": "string",
+            "description": "Contact's last name."
+          },
+          "email": {
+            "type": "string",
+            "description": "Contact's email address."
+          },
+          "phone": {
+            "type": "string",
+            "description": "Contact's phone number (include country code, e.g. +1234567890)."
+          },
+          "companyName": {
+            "type": "string",
+            "description": "Contact's company name."
+          },
+          "address1": {
+            "type": "string",
+            "description": "Street address."
+          },
+          "city": {
+            "type": "string",
+            "description": "City."
+          },
+          "state": {
+            "type": "string",
+            "description": "State or province."
+          },
+          "postalCode": {
+            "type": "string",
+            "description": "Postal/zip code."
+          },
+          "country": {
+            "type": "string",
+            "description": "Country."
+          },
+          "website": {
+            "type": "string",
+            "description": "Contact's website URL."
+          },
+          "tags": {
+            "type": "array",
+            "items": {
+              "type": "string"
+            },
+            "description": "Array of tag names to assign to the contact."
+          },
+          "source": {
+            "type": "string",
+            "description": "Lead source for the contact."
+          },
+          "customFields": {
+            "type": "array",
+            "description": "Array of custom field objects with id and field_value.",
+            "items": {
+              "type": "object",
+              "properties": {
+                "id": {
+                  "type": "string",
+                  "description": "Custom field ID."
+                },
+                "field_value": {
+                  "type": "string",
+                  "description": "Value for the custom field."
+                }
+              }
+            }
+          }
+        },
+        "required": [
+          "locationId"
+        ]
+      }
+    },
+    {
+      "name": "update_contact",
+      "description": "Update an existing contact in GoHighLevel. Pass the contactId in the URL and any fields to update in the body. Supports updating name, email, phone, tags, custom fields, and other attributes.",
+      "method": "PUT",
+      "path": "/contacts/%7B%7Bparam.contactId%7D%7D",
+      "input_schema": {
+        "type": "object",
+        "properties": {
+          "contactId": {
+            "type": "string",
+            "description": "The unique ID of the contact to update."
+          },
+          "firstName": {
+            "type": "string",
+            "description": "Contact's first name."
+          },
+          "lastName": {
+            "type": "string",
+            "description": "Contact's last name."
+          },
+          "email": {
+            "type": "string",
+            "description": "Contact's email address."
+          },
+          "phone": {
+            "type": "string",
+            "description": "Contact's phone number."
+          },
+          "companyName": {
+            "type": "string",
+            "description": "Contact's company name."
+          },
+          "address1": {
+            "type": "string",
+            "description": "Street address."
+          },
+          "city": {
+            "type": "string",
+            "description": "City."
+          },
+          "state": {
+            "type": "string",
+            "description": "State or province."
+          },
+          "postalCode": {
+            "type": "string",
+            "description": "Postal/zip code."
+          },
+          "country": {
+            "type": "string",
+            "description": "Country."
+          },
+          "website": {
+            "type": "string",
+            "description": "Contact's website URL."
+          },
+          "tags": {
+            "type": "array",
+            "items": {
+              "type": "string"
+            },
+            "description": "Array of tag names to assign to the contact."
+          },
+          "customFields": {
+            "type": "array",
+            "description": "Array of custom field objects with id and field_value.",
+            "items": {
+              "type": "object",
+              "properties": {
+                "id": {
+                  "type": "string",
+                  "description": "Custom field ID."
+                },
+                "field_value": {
+                  "type": "string",
+                  "description": "Value for the custom field."
+                }
+              }
+            }
+          }
+        },
+        "required": [
+          "contactId"
+        ]
+      }
+    },
+    {
+      "name": "add_contact_tags",
+      "description": "Add one or more tags to an existing contact in GoHighLevel. Provide the contactId and an array of tag names to add.",
+      "method": "POST",
+      "path": "/contacts/%7B%7Bparam.contactId%7D%7D/tags",
+      "input_schema": {
+        "type": "object",
+        "properties": {
+          "contactId": {
+            "type": "string",
+            "description": "The unique ID of the contact to add tags to."
+          },
+          "tags": {
+            "type": "array",
+            "items": {
+              "type": "string"
+            },
+            "description": "Array of tag names to add to the contact."
+          }
+        },
+        "required": [
+          "contactId",
+          "tags"
+        ]
+      }
+    },
+    {
+      "name": "remove_contact_tags",
+      "description": "Remove one or more tags from an existing contact in GoHighLevel. Provide the contactId and an array of tag names to remove.",
+      "method": "DELETE",
+      "path": "/contacts/%7B%7Bparam.contactId%7D%7D/tags",
+      "input_schema": {
+        "type": "object",
+        "properties": {
+          "contactId": {
+            "type": "string",
+            "description": "The unique ID of the contact to remove tags from."
+          },
+          "tags": {
+            "type": "array",
+            "items": {
+              "type": "string"
+            },
+            "description": "Array of tag names to remove from the contact."
+          }
+        },
+        "required": [
+          "contactId",
+          "tags"
+        ]
+      }
+    },
+    {
+      "name": "find_opportunities",
+      "description": "Search opportunities in GoHighLevel using advanced filters. Supports filtering by pipeline, stage, contact, status, and monetary value. Returns paginated results.",
+      "method": "POST",
+      "path": "/opportunities/search",
+      "input_schema": {
+        "type": "object",
+        "properties": {
+          "locationId": {
+            "type": "string",
+            "description": "The location/sub-account ID to search opportunities in."
+          },
+          "pipelineId": {
+            "type": "string",
+            "description": "Filter by pipeline ID."
+          },
+          "stageId": {
+            "type": "string",
+            "description": "Filter by stage ID within the pipeline."
+          },
+          "contactId": {
+            "type": "string",
+            "description": "Filter by associated contact ID."
+          },
+          "status": {
+            "type": "string",
+            "enum": [
+              "open",
+              "won",
+              "lost",
+              "abandoned"
+            ],
+            "description": "Filter by opportunity status."
+          },
+          "query": {
+            "type": "string",
+            "description": "Search query string to match against opportunity name."
+          },
+          "page": {
+            "type": "integer",
+            "description": "Page number for pagination. Defaults to 1.",
+            "default": 1
+          },
+          "limit": {
+            "type": "integer",
+            "description": "Number of results per page. Defaults to 20.",
+            "default": 20
+          }
+        },
+        "required": [
+          "locationId"
+        ]
+      }
+    },
+    {
+      "name": "create_opportunity",
+      "description": "Create a new opportunity (deal) in GoHighLevel. Requires a pipelineId and stageId to place the opportunity in the correct pipeline stage. Optionally associate with a contact and set monetary value.",
+      "method": "POST",
+      "path": "/opportunities/",
+      "input_schema": {
+        "type": "object",
+        "properties": {
+          "locationId": {
+            "type": "string",
+            "description": "The location/sub-account ID."
+          },
+          "pipelineId": {
+            "type": "string",
+            "description": "The pipeline ID to create the opportunity in."
+          },
+          "pipelineStageId": {
+            "type": "string",
+            "description": "The stage ID within the pipeline."
+          },
+          "name": {
+            "type": "string",
+            "description": "Name/title of the opportunity."
+          },
+          "contactId": {
+            "type": "string",
+            "description": "Associated contact ID."
+          },
+          "status": {
+            "type": "string",
+            "enum": [
+              "open",
+              "won",
+              "lost",
+              "abandoned"
+            ],
+            "description": "Opportunity status. Defaults to 'open'."
+          },
+          "monetaryValue": {
+            "type": "number",
+            "description": "Monetary value of the opportunity."
+          },
+          "assignedTo": {
+            "type": "string",
+            "description": "User ID to assign the opportunity to."
+          },
+          "source": {
+            "type": "string",
+            "description": "Lead source for the opportunity."
+          },
+          "customFields": {
+            "type": "array",
+            "description": "Array of custom field objects with id and field_value.",
+            "items": {
+              "type": "object",
+              "properties": {
+                "id": {
+                  "type": "string",
+                  "description": "Custom field ID."
+                },
+                "field_value": {
+                  "type": "string",
+                  "description": "Value for the custom field."
+                }
+              }
+            }
+          }
+        },
+        "required": [
+          "locationId",
+          "pipelineId",
+          "pipelineStageId",
+          "name"
+        ]
+      }
+    },
+    {
+      "name": "find_invoices",
+      "description": "List and search invoices in GoHighLevel. Supports filtering by status, contact, date range, and pagination. Returns invoice details including amounts, line items, and payment status.",
+      "method": "GET",
+      "path": "/invoices/",
+      "input_schema": {
+        "type": "object",
+        "properties": {
+          "locationId": {
+            "type": "string",
+            "description": "The location/sub-account ID to list invoices for."
+          },
+          "status": {
+            "type": "string",
+            "enum": [
+              "draft",
+              "sent",
+              "paid",
+              "void",
+              "partially_paid"
+            ],
+            "description": "Filter invoices by status."
+          },
+          "contactId": {
+            "type": "string",
+            "description": "Filter invoices by associated contact ID."
+          },
+          "startAt": {
+            "type": "string",
+            "description": "Start date filter in ISO 8601 format (e.g. 2025-01-01)."
+          },
+          "endAt": {
+            "type": "string",
+            "description": "End date filter in ISO 8601 format (e.g. 2025-12-31)."
+          },
+          "search": {
+            "type": "string",
+            "description": "Search query to match against invoice number or name."
+          },
+          "limit": {
+            "type": "integer",
+            "description": "Number of results per page. Defaults to 20.",
+            "default": 20
+          },
+          "offset": {
+            "type": "integer",
+            "description": "Offset for pagination. Defaults to 0.",
+            "default": 0
+          }
+        },
+        "required": [
+          "locationId"
+        ]
+      }
+    },
+    {
+      "name": "create_invoice",
+      "description": "Create a new invoice in GoHighLevel. Specify the contact, line items, due date, and other billing details. The invoice can be sent immediately or saved as a draft.",
+      "method": "POST",
+      "path": "/invoices/",
+      "input_schema": {
+        "type": "object",
+        "properties": {
+          "locationId": {
+            "type": "string",
+            "description": "The location/sub-account ID."
+          },
+          "contactId": {
+            "type": "string",
+            "description": "The contact ID to create the invoice for."
+          },
+          "name": {
+            "type": "string",
+            "description": "Invoice name or title."
+          },
+          "title": {
+            "type": "string",
+            "description": "Display title for the invoice."
+          },
+          "dueDate": {
+            "type": "string",
+            "description": "Invoice due date in ISO 8601 format (e.g. 2025-12-31)."
+          },
+          "issueDate": {
+            "type": "string",
+            "description": "Invoice issue date in ISO 8601 format."
+          },
+          "currency": {
+            "type": "string",
+            "description": "Currency code (e.g. 'USD', 'EUR'). Defaults to account currency.",
+            "default": "USD"
+          },
+          "items": {
+            "type": "array",
+            "description": "Array of line items for the invoice.",
+            "items": {
+              "type": "object",
+              "properties": {
+                "name": {
+                  "type": "string",
+                  "description": "Item name or description."
+                },
+                "description": {
+                  "type": "string",
+                  "description": "Detailed item description."
+                },
+                "quantity": {
+                  "type": "number",
+                  "description": "Quantity of the item."
+                },
+                "price": {
+                  "type": "number",
+                  "description": "Unit price of the item in cents."
+                }
+              }
+            }
+          },
+          "discount": {
+            "type": "object",
+            "description": "Discount to apply to the invoice.",
+            "properties": {
+              "type": {
+                "type": "string",
+                "enum": [
+                  "percentage",
+                  "fixed"
+                ],
+                "description": "Discount type."
+              },
+              "value": {
+                "type": "number",
+                "description": "Discount value (percentage or fixed amount)."
+              }
+            }
+          },
+          "termsNotes": {
+            "type": "string",
+            "description": "Terms and notes to display on the invoice."
+          },
+          "sendToContact": {
+            "type": "boolean",
+            "description": "Whether to send the invoice to the contact immediately. Defaults to false.",
+            "default": false
+          }
+        },
+        "required": [
+          "locationId",
+          "contactId",
+          "name",
+          "items"
+        ]
+      }
+    }
+  ]
+}