# nodes

node_type: nodes-base.helpScoutTool
package_name: n8n-nodes-base
display_name: Help Scout Tool
description: Consume Help Scout API (AI Tool variant for use with AI Agents)
category: input
development_style: programmatic
version: 1
credentials_required:
  [
  {
  "name": "helpScoutOAuth2Api",
  "required": true
  }
  ]

outputs:
  [
  {
  "type": "ai_tool",
  "displayName": "Tool"
  }
  ]

output_names:
  [
  "Tool"
  ]

updated_at: 2026-03-25 21:12:27
tool_variant_of: nodes-base.helpScout
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: Help Scout node documentation
  description: Learn how to use the Help Scout node in n8n. Follow technical documentation to integrate Help Scout node into your workflows.
  contentType: [integration, reference]
  ---

  # Help Scout node

  Use the Help Scout node to automate work in Help Scout, and integrate Help Scout with other applications. n8n has built-in support for a wide range of Help Scout features, including creating, updating, deleting, and getting conversations, and customers.

  On this page, you'll find a list of operations the Help Scout node supports and links to more resources.

  /// note | Credentials
  Refer to [Help Scout credentials](/integrations/builtin/credentials/helpscout.md) for guidance on setting up authentication. 
  ///

  ## Operations

  * Conversation
      * Create a new conversation
      * Delete a conversation
      * Get a conversation
      * Get all conversations
  * Customer
      * Create a new customer
      * Get a customer
      * Get all customers
      * Get customer property definitions
      * Update a customer
  * Mailbox
      * Get data of a mailbox
      * Get all mailboxes
  * Thread
      * Create a new chat thread
      * Get all chat threads

  ## Templates and examples

  <!-- see https://www.notion.so/n8n/Pull-in-templates-for-the-integrations-pages-37c716837b804d30a33b47475f6e3780 -->
  [[ templatesWidget(page.title, 'helpscout') ]]

  --8<-- "_snippets/integrations/builtin/app-nodes/operation-not-supported.md"

properties_schema:
  [
    {
      "displayName": "Tool Description",
      "name": "toolDescription",
      "type": "string",
      "default": "",
      "required": false,
      "description": "Description for the AI to understand what this tool does and when to use it",
      "typeOptions": {
        "rows": 3
      },
      "placeholder": "e.g., Use this tool to interact with Help Scout"
    },
    {
      "displayName": "Resource",
      "name": "resource",
      "type": "options",
      "default": "conversation",
      "options": [
        {
          "name": "Conversation",
          "value": "conversation"
        },
        {
          "name": "Customer",
          "value": "customer"
        },
        {
          "name": "Mailbox",
          "value": "mailbox"
        },
        {
          "name": "Thread",
          "value": "thread"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create a new conversation",
          "action": "Create a conversation"
        },
        {
          "name": "Delete",
          "value": "delete",
          "description": "Delete a conversation",
          "action": "Delete a conversation"
        },
        {
          "name": "Get",
          "value": "get",
          "description": "Get a conversation",
          "action": "Get a conversation"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get many conversations",
          "action": "Get many conversations"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "conversation"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Mailbox Name or ID",
      "name": "mailboxId",
      "type": "options",
      "default": "",
      "description": "ID of a mailbox where the conversation is being created. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "create"
          ],
          "resource": [
            "conversation"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getMailboxes"
      }
    },
    {
      "displayName": "Status",
      "name": "status",
      "type": "options",
      "default": "",
      "description": "Conversation status",
      "options": [
        {
          "name": "Active",
          "value": "active"
        },
        {
          "name": "Closed",
          "value": "closed"
        },
        {
          "name": "Pending",
          "value": "pending"
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "create"
          ],
          "resource": [
            "conversation"
          ]
        }
      }
    },
    {
      "displayName": "Subject",
      "name": "subject",
      "type": "string",
      "default": "",
      "description": "Conversation’s subject",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "create"
          ],
          "resource": [
            "conversation"
          ]
        }
      }
    },
    {
      "displayName": "Type",
      "name": "type",
      "type": "options",
      "default": "",
      "description": "Conversation type",
      "options": [
        {
          "name": "Chat",
          "value": "chat"
        },
        {
          "name": "Email",
          "value": "email"
        },
        {
          "name": "Phone",
          "value": "phone"
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "create"
          ],
          "resource": [
            "conversation"
          ]
        }
      }
    },
    {
      "displayName": "Resolve Data",
      "name": "resolveData",
      "type": "boolean",
      "default": true,
      "description": "By default the response only contain the ID to resource. If this option gets activated, it will resolve the data automatically.",
      "displayOptions": {
        "show": {
          "operation": [
            "create"
          ],
          "resource": [
            "conversation"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Assign To",
          "name": "assignTo",
          "type": "number",
          "default": 0,
          "description": "The Help Scout user assigned to the conversation"
        },
        {
          "displayName": "Auto Reply",
          "name": "autoReply",
          "type": "boolean",
          "default": false,
          "description": "Whether set to true, an auto reply will be sent as long as there is at least one customer thread in the conversation"
        },
        {
          "displayName": "Closed At",
          "name": "closedAt",
          "type": "dateTime",
          "default": "",
          "description": "When the conversation was closed, only applicable for imported conversations"
        },
        {
          "displayName": "Created At",
          "name": "createdAt",
          "type": "dateTime",
          "default": "",
          "description": "When this conversation was created - ISO 8601 date time"
        },
        {
          "displayName": "Customer Email",
          "name": "customerEmail",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Customer ID",
          "name": "customerId",
          "type": "number",
          "default": 0
        },
        {
          "displayName": "Imported",
          "name": "imported",
          "type": "boolean",
          "default": false,
          "description": "Whether set to true, no outgoing emails or notifications will be generated"
        },
        {
          "displayName": "Tag Names or IDs",
          "name": "tags",
          "type": "multiOptions",
          "typeOptions": {
            "loadOptionsMethod": "getTags"
          },
          "default": [],
          "description": "List of tags to be added to the conversation. Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        },
        {
          "displayName": "User ID",
          "name": "user",
          "type": "number",
          "default": 0,
          "description": "ID of the user who is adding the conversation and threads"
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "create"
          ],
          "resource": [
            "conversation"
          ]
        }
      }
    },
    {
      "displayName": "Threads",
      "name": "threadsUi",
      "type": "fixedCollection",
      "default": {},
      "options": [
        {
          "displayName": "Thread",
          "name": "threadsValues",
          "values": [
            {
              "displayName": "Type",
              "name": "type",
              "type": "options",
              "options": [
                {
                  "name": "Chat",
                  "value": "chat"
                },
                {
                  "name": "Customer",
                  "value": "customer"
                },
                {
                  "name": "Note",
                  "value": "note"
                },
                {
                  "name": "Phone",
                  "value": "phone"
                },
                {
                  "name": "Reply",
                  "value": "reply"
                }
              ],
              "default": ""
            },
            {
              "displayName": "Text",
              "name": "text",
              "type": "string",
              "default": "",
              "description": "The message text"
            },
            {
              "displayName": "Bcc",
              "name": "bcc",
              "displayOptions": {
                "show": {
                  "type": [
                    "customer"
                  ]
                }
              },
              "type": "string",
              "typeOptions": {
                "multipleValues": true,
                "multipleValueButtonText": "Add Email"
              },
              "default": [],
              "description": "Email addresses"
            },
            {
              "displayName": "Cc",
              "name": "cc",
              "displayOptions": {
                "show": {
                  "type": [
                    "customer"
                  ]
                }
              },
              "type": "string",
              "typeOptions": {
                "multipleValues": true,
                "multipleValueButtonText": "Add Email"
              },
              "default": [],
              "description": "Email addresses"
            },
            {
              "displayName": "Draft",
              "name": "draft",
              "displayOptions": {
                "show": {
                  "type": [
                    "reply"
                  ]
                }
              },
              "type": "boolean",
              "default": false,
              "description": "Whether true, a draft reply is created"
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "create"
          ],
          "resource": [
            "conversation"
          ]
        }
      },
      "typeOptions": {
        "multipleValues": true
      }
    },
    {
      "displayName": "Conversation ID",
      "name": "conversationId",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "conversation"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Conversation ID",
      "name": "conversationId",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "conversation"
          ],
          "operation": [
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "Return All",
      "name": "returnAll",
      "type": "boolean",
      "default": false,
      "description": "Whether to return all results or only up to a given limit",
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "conversation"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 50,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "conversation"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Assign To",
          "name": "assignTo",
          "type": "number",
          "default": 0,
          "description": "Filters conversations by assignee ID"
        },
        {
          "displayName": "Embed",
          "name": "embed",
          "type": "options",
          "options": [
            {
              "name": "Threads",
              "value": "threads"
            }
          ],
          "default": "",
          "description": "Allows embedding/loading of sub-entities"
        },
        {
          "displayName": "Folder ID",
          "name": "folder",
          "type": "string",
          "default": "",
          "description": "Filters conversations from a specific folder ID"
        },
        {
          "displayName": "Mailbox ID",
          "name": "mailbox",
          "type": "string",
          "default": "",
          "description": "Filters conversations from a specific mailbox"
        },
        {
          "displayName": "Modified Since",
          "name": "modifiedSince",
          "type": "dateTime",
          "default": "",
          "description": "Returns only conversations that were modified after this date"
        },
        {
          "displayName": "Number",
          "name": "number",
          "type": "number",
          "default": 0,
          "typeOptions": {
            "minValue": 0
          },
          "description": "Looks up conversation by conversation number"
        },
        {
          "displayName": "Query",
          "name": "query",
          "type": "string",
          "default": "",
          "description": "Advanced search <a href=\"https://developer.helpscout.com/mailbox-api/endpoints/conversations/list/#query\">Examples</a>"
        },
        {
          "displayName": "Sort Field",
          "name": "sortField",
          "type": "options",
          "options": [
            {
              "name": "Created At",
              "value": "createdAt"
            },
            {
              "name": "Customer Email",
              "value": "customerEmail"
            },
            {
              "name": "Customer Name",
              "value": "customerName"
            },
            {
              "name": "Mailbox ID",
              "value": "mailboxid"
            },
            {
              "name": "Modified At",
              "value": "modifiedAt"
            },
            {
              "name": "Number",
              "value": "number"
            },
            {
              "name": "Score",
              "value": "score"
            },
            {
              "name": "Status",
              "value": "status"
            },
            {
              "name": "Subject",
              "value": "subject"
            }
          ],
          "default": "",
          "description": "Sorts the result by specified field"
        },
        {
          "displayName": "Sort Order",
          "name": "sortOrder",
          "type": "options",
          "options": [
            {
              "name": "ASC",
              "value": "asc"
            },
            {
              "name": "DESC",
              "value": "desc"
            }
          ],
          "default": "desc"
        },
        {
          "displayName": "Status",
          "name": "status",
          "type": "options",
          "options": [
            {
              "name": "Active",
              "value": "active"
            },
            {
              "name": "All",
              "value": "all"
            },
            {
              "name": "Closed",
              "value": "closed"
            },
            {
              "name": "Open",
              "value": "open"
            },
            {
              "name": "Pending",
              "value": "pending"
            },
            {
              "name": "Spam",
              "value": "spam"
            }
          ],
          "default": "active",
          "description": "Filter conversation by status"
        },
        {
          "displayName": "Tag Names or IDs",
          "name": "tags",
          "type": "multiOptions",
          "typeOptions": {
            "loadOptionsMethod": "getTags"
          },
          "default": [],
          "description": "Filter conversation by tags. Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "conversation"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create a new customer",
          "action": "Create a customer"
        },
        {
          "name": "Get",
          "value": "get",
          "description": "Get a customer",
          "action": "Get a customer"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get many customers",
          "action": "Get many customers"
        },
        {
          "name": "Properties",
          "value": "properties",
          "description": "Get customer property definitions",
          "action": "Get customer properties"
        },
        {
          "name": "Update",
          "value": "update",
          "description": "Update a customer",
          "action": "Update a customer"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "customer"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Resolve Data",
      "name": "resolveData",
      "type": "boolean",
      "default": true,
      "description": "By default the response only contain the ID to resource. If this option gets activated, it will resolve the data automatically.",
      "displayOptions": {
        "show": {
          "operation": [
            "create"
          ],
          "resource": [
            "customer"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Age",
          "name": "age",
          "type": "number",
          "typeOptions": {
            "minValue": 1
          },
          "default": 1,
          "description": "Customer’s age"
        },
        {
          "displayName": "First Name",
          "name": "firstName",
          "type": "string",
          "default": "",
          "description": "First name of the customer. When defined it must be between 1 and 40 characters."
        },
        {
          "displayName": "Gender",
          "name": "gender",
          "type": "options",
          "options": [
            {
              "name": "Female",
              "value": "female"
            },
            {
              "name": "Male",
              "value": "male"
            },
            {
              "name": "Unknown",
              "value": "unknown"
            }
          ],
          "default": "",
          "description": "Gender of this customer"
        },
        {
          "displayName": "Job Title",
          "name": "jobTitle",
          "type": "string",
          "default": "",
          "description": "Job title. Max length 60 characters."
        },
        {
          "displayName": "Last Name",
          "name": "lastName",
          "type": "string",
          "default": "",
          "description": "Last name of the customer"
        },
        {
          "displayName": "Location",
          "name": "location",
          "type": "string",
          "default": "",
          "description": "Location of the customer"
        },
        {
          "displayName": "Notes",
          "name": "background",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Organization",
          "name": "organization",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Photo Url",
          "name": "photoUrl",
          "type": "string",
          "default": "",
          "description": "URL of the customer’s photo"
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "create"
          ],
          "resource": [
            "customer"
          ]
        }
      }
    },
    {
      "displayName": "Address",
      "name": "addressUi",
      "type": "fixedCollection",
      "default": {},
      "options": [
        {
          "displayName": "Address",
          "name": "addressValue",
          "values": [
            {
              "displayName": "Line 1",
              "name": "line1",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "Line 2",
              "name": "line2",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "City",
              "name": "city",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "State",
              "name": "state",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "Country Name or ID",
              "name": "country",
              "type": "options",
              "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
              "typeOptions": {
                "loadOptionsMethod": "getCountriesCodes"
              },
              "default": ""
            },
            {
              "displayName": "Postal Code",
              "name": "postalCode",
              "type": "string",
              "default": ""
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "create"
          ],
          "resource": [
            "customer"
          ]
        }
      }
    },
    {
      "displayName": "Chat Handles",
      "name": "chatsUi",
      "type": "fixedCollection",
      "default": {},
      "options": [
        {
          "displayName": "Chat Handle",
          "name": "chatsValues",
          "values": [
            {
              "displayName": "Type",
              "name": "type",
              "type": "options",
              "options": [
                {
                  "name": "AIM",
                  "value": "aim"
                },
                {
                  "name": "Google Talk",
                  "value": "gtalk"
                },
                {
                  "name": "ICQ",
                  "value": "icq"
                },
                {
                  "name": "MSN",
                  "value": "msn"
                },
                {
                  "name": "Other",
                  "value": "other"
                },
                {
                  "name": "QQ",
                  "value": "qq"
                },
                {
                  "name": "Skype",
                  "value": "skype"
                },
                {
                  "name": "XMPP",
                  "value": "xmpp"
                },
                {
                  "name": "Yahoo",
                  "value": "yahoo"
                }
              ],
              "description": "Chat type",
              "default": ""
            },
            {
              "displayName": "Value",
              "name": "value",
              "type": "string",
              "default": "",
              "description": "Chat handle"
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "create"
          ],
          "resource": [
            "customer"
          ]
        }
      },
      "typeOptions": {
        "multipleValues": true
      }
    },
    {
      "displayName": "Emails",
      "name": "emailsUi",
      "type": "fixedCollection",
      "default": {},
      "options": [
        {
          "displayName": "Email",
          "name": "emailsValues",
          "values": [
            {
              "displayName": "Type",
              "name": "type",
              "type": "options",
              "options": [
                {
                  "name": "Home",
                  "value": "home"
                },
                {
                  "name": "Other",
                  "value": "other"
                },
                {
                  "name": "Work",
                  "value": "work"
                }
              ],
              "description": "Location for this email address",
              "default": ""
            },
            {
              "displayName": "Value",
              "name": "value",
              "type": "string",
              "default": "",
              "description": "Email"
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "create"
          ],
          "resource": [
            "customer"
          ]
        }
      },
      "typeOptions": {
        "multipleValues": true
      }
    },
    {
      "displayName": "Phones",
      "name": "phonesUi",
      "type": "fixedCollection",
      "default": {},
      "options": [
        {
          "displayName": "Email",
          "name": "phonesValues",
          "values": [
            {
              "displayName": "Type",
              "name": "type",
              "type": "options",
              "options": [
                {
                  "name": "Fax",
                  "value": "fax"
                },
                {
                  "name": "Home",
                  "value": "home"
                },
                {
                  "name": "Other",
                  "value": "other"
                },
                {
                  "name": "Pager",
                  "value": "pager"
                },
                {
                  "name": "Work",
                  "value": "work"
                }
              ],
              "description": "Location for this phone",
              "default": ""
            },
            {
              "displayName": "Value",
              "name": "value",
              "type": "string",
              "default": "",
              "description": "Phone"
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "create"
          ],
          "resource": [
            "customer"
          ]
        }
      },
      "typeOptions": {
        "multipleValues": true
      }
    },
    {
      "displayName": "Social Profiles",
      "name": "socialProfilesUi",
      "type": "fixedCollection",
      "default": {},
      "options": [
        {
          "displayName": "Social Profile",
          "name": "socialProfilesValues",
          "values": [
            {
              "displayName": "Type",
              "name": "type",
              "type": "options",
              "options": [
                {
                  "name": "About Me",
                  "value": "aboutMe"
                },
                {
                  "name": "Facebook",
                  "value": "facebook"
                },
                {
                  "name": "Flickr",
                  "value": "flickr"
                },
                {
                  "name": "Forsquare",
                  "value": "forsquare"
                },
                {
                  "name": "Google",
                  "value": "google"
                },
                {
                  "name": "Google Plus",
                  "value": "googleplus"
                },
                {
                  "name": "Linkedin",
                  "value": "linkedin"
                },
                {
                  "name": "Other",
                  "value": "other"
                },
                {
                  "name": "Quora",
                  "value": "quora"
                },
                {
                  "name": "Tungleme",
                  "value": "tungleme"
                },
                {
                  "name": "Twitter",
                  "value": "twitter"
                },
                {
                  "name": "Youtube",
                  "value": "youtube"
                }
              ],
              "description": "Type of social profile",
              "default": ""
            },
            {
              "displayName": "Value",
              "name": "value",
              "type": "string",
              "default": "",
              "description": "Social Profile handle (URL for example)"
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "create"
          ],
          "resource": [
            "customer"
          ]
        }
      },
      "typeOptions": {
        "multipleValues": true
      }
    },
    {
      "displayName": "Websites",
      "name": "websitesUi",
      "type": "fixedCollection",
      "default": {},
      "options": [
        {
          "displayName": "Website",
          "name": "websitesValues",
          "values": [
            {
              "displayName": "Value",
              "name": "value",
              "type": "string",
              "default": "",
              "description": "Website URL"
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "create"
          ],
          "resource": [
            "customer"
          ]
        }
      },
      "typeOptions": {
        "multipleValues": true
      }
    },
    {
      "displayName": "Return All",
      "name": "returnAll",
      "type": "boolean",
      "default": false,
      "description": "Whether to return all results or only up to a given limit",
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "customer"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 50,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "customer"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "First Name",
          "name": "firstName",
          "type": "string",
          "default": "",
          "description": "Filters customers by first name"
        },
        {
          "displayName": "Last Name",
          "name": "lastName",
          "type": "string",
          "default": "",
          "description": "Filters customers by last name"
        },
        {
          "displayName": "Mailbox ID",
          "name": "mailbox",
          "type": "string",
          "default": "",
          "description": "Filters customers from a specific mailbox"
        },
        {
          "displayName": "Modified Since",
          "name": "modifiedSince",
          "type": "dateTime",
          "default": "",
          "description": "Returns only customers that were modified after this date"
        },
        {
          "displayName": "Sort Field",
          "name": "sortField",
          "type": "options",
          "options": [
            {
              "name": "Score",
              "value": "score"
            },
            {
              "name": "First Name",
              "value": "firstName"
            },
            {
              "name": "Last Name",
              "value": "lastName"
            },
            {
              "name": "Modified At",
              "value": "modifiedAt"
            }
          ],
          "default": "score",
          "description": "Sorts the result by specified field"
        },
        {
          "displayName": "Sort Order",
          "name": "sortOrder",
          "type": "options",
          "options": [
            {
              "name": "ASC",
              "value": "asc"
            },
            {
              "name": "DESC",
              "value": "desc"
            }
          ],
          "default": "desc"
        },
        {
          "displayName": "Query",
          "name": "query",
          "type": "string",
          "default": "",
          "description": "Advanced search <a href=\"https://developer.helpscout.com/mailbox-api/endpoints/customers/list/#query\">Examples</a>"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "customer"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Customer ID",
      "name": "customerId",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "customer"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Customer ID",
      "name": "customerId",
      "type": "string",
      "default": "",
      "displayOptions": {
        "show": {
          "operation": [
            "update"
          ],
          "resource": [
            "customer"
          ]
        }
      }
    },
    {
      "displayName": "Update Fields",
      "name": "updateFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Age",
          "name": "age",
          "type": "number",
          "typeOptions": {
            "minValue": 1
          },
          "default": 1,
          "description": "Customer’s age"
        },
        {
          "displayName": "First Name",
          "name": "firstName",
          "type": "string",
          "default": "",
          "description": "First name of the customer. When defined it must be between 1 and 40 characters."
        },
        {
          "displayName": "Gender",
          "name": "gender",
          "type": "options",
          "options": [
            {
              "name": "Female",
              "value": "female"
            },
            {
              "name": "Male",
              "value": "male"
            },
            {
              "name": "Unknown",
              "value": "unknown"
            }
          ],
          "default": "",
          "description": "Gender of this customer"
        },
        {
          "displayName": "Job Title",
          "name": "jobTitle",
          "type": "string",
          "default": "",
          "description": "Job title. Max length 60 characters."
        },
        {
          "displayName": "Last Name",
          "name": "lastName",
          "type": "string",
          "default": "",
          "description": "Last name of the customer"
        },
        {
          "displayName": "Location",
          "name": "location",
          "type": "string",
          "default": "",
          "description": "Location of the customer"
        },
        {
          "displayName": "Notes",
          "name": "background",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Organization",
          "name": "organization",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Photo Url",
          "name": "photoUrl",
          "type": "string",
          "default": "",
          "description": "URL of the customer’s photo"
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "update"
          ],
          "resource": [
            "customer"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "get",
      "options": [
        {
          "name": "Get",
          "value": "get",
          "description": "Get data of a mailbox",
          "action": "Get a mailbox"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get many mailboxes",
          "action": "Get many mailboxes"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "mailbox"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Mailbox ID",
      "name": "mailboxId",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "mailbox"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Return All",
      "name": "returnAll",
      "type": "boolean",
      "default": false,
      "description": "Whether to return all results or only up to a given limit",
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "mailbox"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 50,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "mailbox"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create a new chat thread",
          "action": "Create a thread"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get many chat threads",
          "action": "Get many threads"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "thread"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Conversation ID",
      "name": "conversationId",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "thread"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Type",
      "name": "type",
      "type": "options",
      "default": "",
      "options": [
        {
          "name": "Chat",
          "value": "chat"
        },
        {
          "name": "Customer",
          "value": "customer"
        },
        {
          "name": "Note",
          "value": "note"
        },
        {
          "name": "Phone",
          "value": "phone"
        },
        {
          "name": "Reply",
          "value": "reply"
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "thread"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Text",
      "name": "text",
      "type": "string",
      "default": "",
      "description": "The chat text",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "thread"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Created At",
          "name": "createdAt",
          "type": "dateTime",
          "default": ""
        },
        {
          "displayName": "Customer Email",
          "name": "customerEmail",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Customer ID",
          "name": "customerId",
          "type": "number",
          "default": 0
        },
        {
          "displayName": "Draft",
          "name": "draft",
          "type": "boolean",
          "default": false,
          "displayOptions": {
            "show": {
              "/type": [
                "note"
              ]
            }
          },
          "description": "Whether a draft reply is created"
        },
        {
          "displayName": "Imported",
          "name": "imported",
          "type": "boolean",
          "default": false,
          "description": "Whether no outgoing emails or notifications will be generated"
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "create"
          ],
          "resource": [
            "thread"
          ]
        }
      }
    },
    {
      "displayName": "Attachments",
      "name": "attachmentsUi",
      "type": "fixedCollection",
      "default": {},
      "description": "Array of supported attachments to add to the message",
      "options": [
        {
          "name": "attachmentsValues",
          "displayName": "Attachments Values",
          "values": [
            {
              "displayName": "FileName",
              "name": "fileName",
              "type": "string",
              "default": "",
              "description": "Attachment’s file name"
            },
            {
              "displayName": "Mime Type",
              "name": "mimeType",
              "type": "string",
              "default": "",
              "description": "Attachment’s mime type"
            },
            {
              "displayName": "Data",
              "name": "data",
              "type": "string",
              "default": "",
              "placeholder": "ZXhhbXBsZSBmaWxl",
              "description": "Base64-encoded stream of data"
            }
          ]
        },
        {
          "name": "attachmentsBinary",
          "displayName": "Attachments Binary",
          "values": [
            {
              "displayName": "Property",
              "name": "property",
              "type": "string",
              "default": "data",
              "description": "Name of the binary properties which contain data which should be added to email as attachment"
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "create"
          ],
          "resource": [
            "thread"
          ]
        }
      },
      "typeOptions": {
        "multipleValues": true
      }
    },
    {
      "displayName": "Conversation ID",
      "name": "conversationId",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "thread"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Return All",
      "name": "returnAll",
      "type": "boolean",
      "default": false,
      "description": "Whether to return all results or only up to a given limit",
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "thread"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 50,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "thread"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1
      }
    }
  ]

operations:
  [
    {
      "operation": "create",
      "name": "Create",
      "description": "Create a new conversation"
    },
    {
      "operation": "delete",
      "name": "Delete",
      "description": "Delete a conversation"
    },
    {
      "operation": "get",
      "name": "Get",
      "description": "Get a conversation"
    },
    {
      "operation": "getAll",
      "name": "Get Many",
      "description": "Get many conversations"
    }
  ]


node_type: nodes-base.helpScout
package_name: n8n-nodes-base
display_name: Help Scout
description: Consume Help Scout API
category: input
development_style: programmatic
version: 1
credentials_required:
  [
  {
  "name": "helpScoutOAuth2Api",
  "required": true
  }
  ]

outputs:
  [
  "main"
  ]

updated_at: 2026-03-25 21:12:27
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: Help Scout node documentation
  description: Learn how to use the Help Scout node in n8n. Follow technical documentation to integrate Help Scout node into your workflows.
  contentType: [integration, reference]
  ---

  # Help Scout node

  Use the Help Scout node to automate work in Help Scout, and integrate Help Scout with other applications. n8n has built-in support for a wide range of Help Scout features, including creating, updating, deleting, and getting conversations, and customers.

  On this page, you'll find a list of operations the Help Scout node supports and links to more resources.

  /// note | Credentials
  Refer to [Help Scout credentials](/integrations/builtin/credentials/helpscout.md) for guidance on setting up authentication. 
  ///

  ## Operations

  * Conversation
      * Create a new conversation
      * Delete a conversation
      * Get a conversation
      * Get all conversations
  * Customer
      * Create a new customer
      * Get a customer
      * Get all customers
      * Get customer property definitions
      * Update a customer
  * Mailbox
      * Get data of a mailbox
      * Get all mailboxes
  * Thread
      * Create a new chat thread
      * Get all chat threads

  ## Templates and examples

  <!-- see https://www.notion.so/n8n/Pull-in-templates-for-the-integrations-pages-37c716837b804d30a33b47475f6e3780 -->
  [[ templatesWidget(page.title, 'helpscout') ]]

  --8<-- "_snippets/integrations/builtin/app-nodes/operation-not-supported.md"

properties_schema:
  [
    {
      "displayName": "Resource",
      "name": "resource",
      "type": "options",
      "default": "conversation",
      "options": [
        {
          "name": "Conversation",
          "value": "conversation"
        },
        {
          "name": "Customer",
          "value": "customer"
        },
        {
          "name": "Mailbox",
          "value": "mailbox"
        },
        {
          "name": "Thread",
          "value": "thread"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create a new conversation",
          "action": "Create a conversation"
        },
        {
          "name": "Delete",
          "value": "delete",
          "description": "Delete a conversation",
          "action": "Delete a conversation"
        },
        {
          "name": "Get",
          "value": "get",
          "description": "Get a conversation",
          "action": "Get a conversation"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get many conversations",
          "action": "Get many conversations"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "conversation"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Mailbox Name or ID",
      "name": "mailboxId",
      "type": "options",
      "default": "",
      "description": "ID of a mailbox where the conversation is being created. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "create"
          ],
          "resource": [
            "conversation"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getMailboxes"
      }
    },
    {
      "displayName": "Status",
      "name": "status",
      "type": "options",
      "default": "",
      "description": "Conversation status",
      "options": [
        {
          "name": "Active",
          "value": "active"
        },
        {
          "name": "Closed",
          "value": "closed"
        },
        {
          "name": "Pending",
          "value": "pending"
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "create"
          ],
          "resource": [
            "conversation"
          ]
        }
      }
    },
    {
      "displayName": "Subject",
      "name": "subject",
      "type": "string",
      "default": "",
      "description": "Conversation’s subject",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "create"
          ],
          "resource": [
            "conversation"
          ]
        }
      }
    },
    {
      "displayName": "Type",
      "name": "type",
      "type": "options",
      "default": "",
      "description": "Conversation type",
      "options": [
        {
          "name": "Chat",
          "value": "chat"
        },
        {
          "name": "Email",
          "value": "email"
        },
        {
          "name": "Phone",
          "value": "phone"
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "create"
          ],
          "resource": [
            "conversation"
          ]
        }
      }
    },
    {
      "displayName": "Resolve Data",
      "name": "resolveData",
      "type": "boolean",
      "default": true,
      "description": "By default the response only contain the ID to resource. If this option gets activated, it will resolve the data automatically.",
      "displayOptions": {
        "show": {
          "operation": [
            "create"
          ],
          "resource": [
            "conversation"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Assign To",
          "name": "assignTo",
          "type": "number",
          "default": 0,
          "description": "The Help Scout user assigned to the conversation"
        },
        {
          "displayName": "Auto Reply",
          "name": "autoReply",
          "type": "boolean",
          "default": false,
          "description": "Whether set to true, an auto reply will be sent as long as there is at least one customer thread in the conversation"
        },
        {
          "displayName": "Closed At",
          "name": "closedAt",
          "type": "dateTime",
          "default": "",
          "description": "When the conversation was closed, only applicable for imported conversations"
        },
        {
          "displayName": "Created At",
          "name": "createdAt",
          "type": "dateTime",
          "default": "",
          "description": "When this conversation was created - ISO 8601 date time"
        },
        {
          "displayName": "Customer Email",
          "name": "customerEmail",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Customer ID",
          "name": "customerId",
          "type": "number",
          "default": 0
        },
        {
          "displayName": "Imported",
          "name": "imported",
          "type": "boolean",
          "default": false,
          "description": "Whether set to true, no outgoing emails or notifications will be generated"
        },
        {
          "displayName": "Tag Names or IDs",
          "name": "tags",
          "type": "multiOptions",
          "typeOptions": {
            "loadOptionsMethod": "getTags"
          },
          "default": [],
          "description": "List of tags to be added to the conversation. Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        },
        {
          "displayName": "User ID",
          "name": "user",
          "type": "number",
          "default": 0,
          "description": "ID of the user who is adding the conversation and threads"
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "create"
          ],
          "resource": [
            "conversation"
          ]
        }
      }
    },
    {
      "displayName": "Threads",
      "name": "threadsUi",
      "type": "fixedCollection",
      "default": {},
      "options": [
        {
          "displayName": "Thread",
          "name": "threadsValues",
          "values": [
            {
              "displayName": "Type",
              "name": "type",
              "type": "options",
              "options": [
                {
                  "name": "Chat",
                  "value": "chat"
                },
                {
                  "name": "Customer",
                  "value": "customer"
                },
                {
                  "name": "Note",
                  "value": "note"
                },
                {
                  "name": "Phone",
                  "value": "phone"
                },
                {
                  "name": "Reply",
                  "value": "reply"
                }
              ],
              "default": ""
            },
            {
              "displayName": "Text",
              "name": "text",
              "type": "string",
              "default": "",
              "description": "The message text"
            },
            {
              "displayName": "Bcc",
              "name": "bcc",
              "displayOptions": {
                "show": {
                  "type": [
                    "customer"
                  ]
                }
              },
              "type": "string",
              "typeOptions": {
                "multipleValues": true,
                "multipleValueButtonText": "Add Email"
              },
              "default": [],
              "description": "Email addresses"
            },
            {
              "displayName": "Cc",
              "name": "cc",
              "displayOptions": {
                "show": {
                  "type": [
                    "customer"
                  ]
                }
              },
              "type": "string",
              "typeOptions": {
                "multipleValues": true,
                "multipleValueButtonText": "Add Email"
              },
              "default": [],
              "description": "Email addresses"
            },
            {
              "displayName": "Draft",
              "name": "draft",
              "displayOptions": {
                "show": {
                  "type": [
                    "reply"
                  ]
                }
              },
              "type": "boolean",
              "default": false,
              "description": "Whether true, a draft reply is created"
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "create"
          ],
          "resource": [
            "conversation"
          ]
        }
      },
      "typeOptions": {
        "multipleValues": true
      }
    },
    {
      "displayName": "Conversation ID",
      "name": "conversationId",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "conversation"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Conversation ID",
      "name": "conversationId",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "conversation"
          ],
          "operation": [
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "Return All",
      "name": "returnAll",
      "type": "boolean",
      "default": false,
      "description": "Whether to return all results or only up to a given limit",
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "conversation"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 50,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "conversation"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Assign To",
          "name": "assignTo",
          "type": "number",
          "default": 0,
          "description": "Filters conversations by assignee ID"
        },
        {
          "displayName": "Embed",
          "name": "embed",
          "type": "options",
          "options": [
            {
              "name": "Threads",
              "value": "threads"
            }
          ],
          "default": "",
          "description": "Allows embedding/loading of sub-entities"
        },
        {
          "displayName": "Folder ID",
          "name": "folder",
          "type": "string",
          "default": "",
          "description": "Filters conversations from a specific folder ID"
        },
        {
          "displayName": "Mailbox ID",
          "name": "mailbox",
          "type": "string",
          "default": "",
          "description": "Filters conversations from a specific mailbox"
        },
        {
          "displayName": "Modified Since",
          "name": "modifiedSince",
          "type": "dateTime",
          "default": "",
          "description": "Returns only conversations that were modified after this date"
        },
        {
          "displayName": "Number",
          "name": "number",
          "type": "number",
          "default": 0,
          "typeOptions": {
            "minValue": 0
          },
          "description": "Looks up conversation by conversation number"
        },
        {
          "displayName": "Query",
          "name": "query",
          "type": "string",
          "default": "",
          "description": "Advanced search <a href=\"https://developer.helpscout.com/mailbox-api/endpoints/conversations/list/#query\">Examples</a>"
        },
        {
          "displayName": "Sort Field",
          "name": "sortField",
          "type": "options",
          "options": [
            {
              "name": "Created At",
              "value": "createdAt"
            },
            {
              "name": "Customer Email",
              "value": "customerEmail"
            },
            {
              "name": "Customer Name",
              "value": "customerName"
            },
            {
              "name": "Mailbox ID",
              "value": "mailboxid"
            },
            {
              "name": "Modified At",
              "value": "modifiedAt"
            },
            {
              "name": "Number",
              "value": "number"
            },
            {
              "name": "Score",
              "value": "score"
            },
            {
              "name": "Status",
              "value": "status"
            },
            {
              "name": "Subject",
              "value": "subject"
            }
          ],
          "default": "",
          "description": "Sorts the result by specified field"
        },
        {
          "displayName": "Sort Order",
          "name": "sortOrder",
          "type": "options",
          "options": [
            {
              "name": "ASC",
              "value": "asc"
            },
            {
              "name": "DESC",
              "value": "desc"
            }
          ],
          "default": "desc"
        },
        {
          "displayName": "Status",
          "name": "status",
          "type": "options",
          "options": [
            {
              "name": "Active",
              "value": "active"
            },
            {
              "name": "All",
              "value": "all"
            },
            {
              "name": "Closed",
              "value": "closed"
            },
            {
              "name": "Open",
              "value": "open"
            },
            {
              "name": "Pending",
              "value": "pending"
            },
            {
              "name": "Spam",
              "value": "spam"
            }
          ],
          "default": "active",
          "description": "Filter conversation by status"
        },
        {
          "displayName": "Tag Names or IDs",
          "name": "tags",
          "type": "multiOptions",
          "typeOptions": {
            "loadOptionsMethod": "getTags"
          },
          "default": [],
          "description": "Filter conversation by tags. Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "conversation"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create a new customer",
          "action": "Create a customer"
        },
        {
          "name": "Get",
          "value": "get",
          "description": "Get a customer",
          "action": "Get a customer"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get many customers",
          "action": "Get many customers"
        },
        {
          "name": "Properties",
          "value": "properties",
          "description": "Get customer property definitions",
          "action": "Get customer properties"
        },
        {
          "name": "Update",
          "value": "update",
          "description": "Update a customer",
          "action": "Update a customer"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "customer"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Resolve Data",
      "name": "resolveData",
      "type": "boolean",
      "default": true,
      "description": "By default the response only contain the ID to resource. If this option gets activated, it will resolve the data automatically.",
      "displayOptions": {
        "show": {
          "operation": [
            "create"
          ],
          "resource": [
            "customer"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Age",
          "name": "age",
          "type": "number",
          "typeOptions": {
            "minValue": 1
          },
          "default": 1,
          "description": "Customer’s age"
        },
        {
          "displayName": "First Name",
          "name": "firstName",
          "type": "string",
          "default": "",
          "description": "First name of the customer. When defined it must be between 1 and 40 characters."
        },
        {
          "displayName": "Gender",
          "name": "gender",
          "type": "options",
          "options": [
            {
              "name": "Female",
              "value": "female"
            },
            {
              "name": "Male",
              "value": "male"
            },
            {
              "name": "Unknown",
              "value": "unknown"
            }
          ],
          "default": "",
          "description": "Gender of this customer"
        },
        {
          "displayName": "Job Title",
          "name": "jobTitle",
          "type": "string",
          "default": "",
          "description": "Job title. Max length 60 characters."
        },
        {
          "displayName": "Last Name",
          "name": "lastName",
          "type": "string",
          "default": "",
          "description": "Last name of the customer"
        },
        {
          "displayName": "Location",
          "name": "location",
          "type": "string",
          "default": "",
          "description": "Location of the customer"
        },
        {
          "displayName": "Notes",
          "name": "background",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Organization",
          "name": "organization",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Photo Url",
          "name": "photoUrl",
          "type": "string",
          "default": "",
          "description": "URL of the customer’s photo"
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "create"
          ],
          "resource": [
            "customer"
          ]
        }
      }
    },
    {
      "displayName": "Address",
      "name": "addressUi",
      "type": "fixedCollection",
      "default": {},
      "options": [
        {
          "displayName": "Address",
          "name": "addressValue",
          "values": [
            {
              "displayName": "Line 1",
              "name": "line1",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "Line 2",
              "name": "line2",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "City",
              "name": "city",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "State",
              "name": "state",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "Country Name or ID",
              "name": "country",
              "type": "options",
              "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
              "typeOptions": {
                "loadOptionsMethod": "getCountriesCodes"
              },
              "default": ""
            },
            {
              "displayName": "Postal Code",
              "name": "postalCode",
              "type": "string",
              "default": ""
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "create"
          ],
          "resource": [
            "customer"
          ]
        }
      }
    },
    {
      "displayName": "Chat Handles",
      "name": "chatsUi",
      "type": "fixedCollection",
      "default": {},
      "options": [
        {
          "displayName": "Chat Handle",
          "name": "chatsValues",
          "values": [
            {
              "displayName": "Type",
              "name": "type",
              "type": "options",
              "options": [
                {
                  "name": "AIM",
                  "value": "aim"
                },
                {
                  "name": "Google Talk",
                  "value": "gtalk"
                },
                {
                  "name": "ICQ",
                  "value": "icq"
                },
                {
                  "name": "MSN",
                  "value": "msn"
                },
                {
                  "name": "Other",
                  "value": "other"
                },
                {
                  "name": "QQ",
                  "value": "qq"
                },
                {
                  "name": "Skype",
                  "value": "skype"
                },
                {
                  "name": "XMPP",
                  "value": "xmpp"
                },
                {
                  "name": "Yahoo",
                  "value": "yahoo"
                }
              ],
              "description": "Chat type",
              "default": ""
            },
            {
              "displayName": "Value",
              "name": "value",
              "type": "string",
              "default": "",
              "description": "Chat handle"
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "create"
          ],
          "resource": [
            "customer"
          ]
        }
      },
      "typeOptions": {
        "multipleValues": true
      }
    },
    {
      "displayName": "Emails",
      "name": "emailsUi",
      "type": "fixedCollection",
      "default": {},
      "options": [
        {
          "displayName": "Email",
          "name": "emailsValues",
          "values": [
            {
              "displayName": "Type",
              "name": "type",
              "type": "options",
              "options": [
                {
                  "name": "Home",
                  "value": "home"
                },
                {
                  "name": "Other",
                  "value": "other"
                },
                {
                  "name": "Work",
                  "value": "work"
                }
              ],
              "description": "Location for this email address",
              "default": ""
            },
            {
              "displayName": "Value",
              "name": "value",
              "type": "string",
              "default": "",
              "description": "Email"
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "create"
          ],
          "resource": [
            "customer"
          ]
        }
      },
      "typeOptions": {
        "multipleValues": true
      }
    },
    {
      "displayName": "Phones",
      "name": "phonesUi",
      "type": "fixedCollection",
      "default": {},
      "options": [
        {
          "displayName": "Email",
          "name": "phonesValues",
          "values": [
            {
              "displayName": "Type",
              "name": "type",
              "type": "options",
              "options": [
                {
                  "name": "Fax",
                  "value": "fax"
                },
                {
                  "name": "Home",
                  "value": "home"
                },
                {
                  "name": "Other",
                  "value": "other"
                },
                {
                  "name": "Pager",
                  "value": "pager"
                },
                {
                  "name": "Work",
                  "value": "work"
                }
              ],
              "description": "Location for this phone",
              "default": ""
            },
            {
              "displayName": "Value",
              "name": "value",
              "type": "string",
              "default": "",
              "description": "Phone"
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "create"
          ],
          "resource": [
            "customer"
          ]
        }
      },
      "typeOptions": {
        "multipleValues": true
      }
    },
    {
      "displayName": "Social Profiles",
      "name": "socialProfilesUi",
      "type": "fixedCollection",
      "default": {},
      "options": [
        {
          "displayName": "Social Profile",
          "name": "socialProfilesValues",
          "values": [
            {
              "displayName": "Type",
              "name": "type",
              "type": "options",
              "options": [
                {
                  "name": "About Me",
                  "value": "aboutMe"
                },
                {
                  "name": "Facebook",
                  "value": "facebook"
                },
                {
                  "name": "Flickr",
                  "value": "flickr"
                },
                {
                  "name": "Forsquare",
                  "value": "forsquare"
                },
                {
                  "name": "Google",
                  "value": "google"
                },
                {
                  "name": "Google Plus",
                  "value": "googleplus"
                },
                {
                  "name": "Linkedin",
                  "value": "linkedin"
                },
                {
                  "name": "Other",
                  "value": "other"
                },
                {
                  "name": "Quora",
                  "value": "quora"
                },
                {
                  "name": "Tungleme",
                  "value": "tungleme"
                },
                {
                  "name": "Twitter",
                  "value": "twitter"
                },
                {
                  "name": "Youtube",
                  "value": "youtube"
                }
              ],
              "description": "Type of social profile",
              "default": ""
            },
            {
              "displayName": "Value",
              "name": "value",
              "type": "string",
              "default": "",
              "description": "Social Profile handle (URL for example)"
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "create"
          ],
          "resource": [
            "customer"
          ]
        }
      },
      "typeOptions": {
        "multipleValues": true
      }
    },
    {
      "displayName": "Websites",
      "name": "websitesUi",
      "type": "fixedCollection",
      "default": {},
      "options": [
        {
          "displayName": "Website",
          "name": "websitesValues",
          "values": [
            {
              "displayName": "Value",
              "name": "value",
              "type": "string",
              "default": "",
              "description": "Website URL"
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "create"
          ],
          "resource": [
            "customer"
          ]
        }
      },
      "typeOptions": {
        "multipleValues": true
      }
    },
    {
      "displayName": "Return All",
      "name": "returnAll",
      "type": "boolean",
      "default": false,
      "description": "Whether to return all results or only up to a given limit",
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "customer"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 50,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "customer"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "First Name",
          "name": "firstName",
          "type": "string",
          "default": "",
          "description": "Filters customers by first name"
        },
        {
          "displayName": "Last Name",
          "name": "lastName",
          "type": "string",
          "default": "",
          "description": "Filters customers by last name"
        },
        {
          "displayName": "Mailbox ID",
          "name": "mailbox",
          "type": "string",
          "default": "",
          "description": "Filters customers from a specific mailbox"
        },
        {
          "displayName": "Modified Since",
          "name": "modifiedSince",
          "type": "dateTime",
          "default": "",
          "description": "Returns only customers that were modified after this date"
        },
        {
          "displayName": "Sort Field",
          "name": "sortField",
          "type": "options",
          "options": [
            {
              "name": "Score",
              "value": "score"
            },
            {
              "name": "First Name",
              "value": "firstName"
            },
            {
              "name": "Last Name",
              "value": "lastName"
            },
            {
              "name": "Modified At",
              "value": "modifiedAt"
            }
          ],
          "default": "score",
          "description": "Sorts the result by specified field"
        },
        {
          "displayName": "Sort Order",
          "name": "sortOrder",
          "type": "options",
          "options": [
            {
              "name": "ASC",
              "value": "asc"
            },
            {
              "name": "DESC",
              "value": "desc"
            }
          ],
          "default": "desc"
        },
        {
          "displayName": "Query",
          "name": "query",
          "type": "string",
          "default": "",
          "description": "Advanced search <a href=\"https://developer.helpscout.com/mailbox-api/endpoints/customers/list/#query\">Examples</a>"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "customer"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Customer ID",
      "name": "customerId",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "customer"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Customer ID",
      "name": "customerId",
      "type": "string",
      "default": "",
      "displayOptions": {
        "show": {
          "operation": [
            "update"
          ],
          "resource": [
            "customer"
          ]
        }
      }
    },
    {
      "displayName": "Update Fields",
      "name": "updateFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Age",
          "name": "age",
          "type": "number",
          "typeOptions": {
            "minValue": 1
          },
          "default": 1,
          "description": "Customer’s age"
        },
        {
          "displayName": "First Name",
          "name": "firstName",
          "type": "string",
          "default": "",
          "description": "First name of the customer. When defined it must be between 1 and 40 characters."
        },
        {
          "displayName": "Gender",
          "name": "gender",
          "type": "options",
          "options": [
            {
              "name": "Female",
              "value": "female"
            },
            {
              "name": "Male",
              "value": "male"
            },
            {
              "name": "Unknown",
              "value": "unknown"
            }
          ],
          "default": "",
          "description": "Gender of this customer"
        },
        {
          "displayName": "Job Title",
          "name": "jobTitle",
          "type": "string",
          "default": "",
          "description": "Job title. Max length 60 characters."
        },
        {
          "displayName": "Last Name",
          "name": "lastName",
          "type": "string",
          "default": "",
          "description": "Last name of the customer"
        },
        {
          "displayName": "Location",
          "name": "location",
          "type": "string",
          "default": "",
          "description": "Location of the customer"
        },
        {
          "displayName": "Notes",
          "name": "background",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Organization",
          "name": "organization",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Photo Url",
          "name": "photoUrl",
          "type": "string",
          "default": "",
          "description": "URL of the customer’s photo"
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "update"
          ],
          "resource": [
            "customer"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "get",
      "options": [
        {
          "name": "Get",
          "value": "get",
          "description": "Get data of a mailbox",
          "action": "Get a mailbox"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get many mailboxes",
          "action": "Get many mailboxes"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "mailbox"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Mailbox ID",
      "name": "mailboxId",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "mailbox"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Return All",
      "name": "returnAll",
      "type": "boolean",
      "default": false,
      "description": "Whether to return all results or only up to a given limit",
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "mailbox"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 50,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "mailbox"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create a new chat thread",
          "action": "Create a thread"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get many chat threads",
          "action": "Get many threads"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "thread"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Conversation ID",
      "name": "conversationId",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "thread"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Type",
      "name": "type",
      "type": "options",
      "default": "",
      "options": [
        {
          "name": "Chat",
          "value": "chat"
        },
        {
          "name": "Customer",
          "value": "customer"
        },
        {
          "name": "Note",
          "value": "note"
        },
        {
          "name": "Phone",
          "value": "phone"
        },
        {
          "name": "Reply",
          "value": "reply"
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "thread"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Text",
      "name": "text",
      "type": "string",
      "default": "",
      "description": "The chat text",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "thread"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Created At",
          "name": "createdAt",
          "type": "dateTime",
          "default": ""
        },
        {
          "displayName": "Customer Email",
          "name": "customerEmail",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Customer ID",
          "name": "customerId",
          "type": "number",
          "default": 0
        },
        {
          "displayName": "Draft",
          "name": "draft",
          "type": "boolean",
          "default": false,
          "displayOptions": {
            "show": {
              "/type": [
                "note"
              ]
            }
          },
          "description": "Whether a draft reply is created"
        },
        {
          "displayName": "Imported",
          "name": "imported",
          "type": "boolean",
          "default": false,
          "description": "Whether no outgoing emails or notifications will be generated"
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "create"
          ],
          "resource": [
            "thread"
          ]
        }
      }
    },
    {
      "displayName": "Attachments",
      "name": "attachmentsUi",
      "type": "fixedCollection",
      "default": {},
      "description": "Array of supported attachments to add to the message",
      "options": [
        {
          "name": "attachmentsValues",
          "displayName": "Attachments Values",
          "values": [
            {
              "displayName": "FileName",
              "name": "fileName",
              "type": "string",
              "default": "",
              "description": "Attachment’s file name"
            },
            {
              "displayName": "Mime Type",
              "name": "mimeType",
              "type": "string",
              "default": "",
              "description": "Attachment’s mime type"
            },
            {
              "displayName": "Data",
              "name": "data",
              "type": "string",
              "default": "",
              "placeholder": "ZXhhbXBsZSBmaWxl",
              "description": "Base64-encoded stream of data"
            }
          ]
        },
        {
          "name": "attachmentsBinary",
          "displayName": "Attachments Binary",
          "values": [
            {
              "displayName": "Property",
              "name": "property",
              "type": "string",
              "default": "data",
              "description": "Name of the binary properties which contain data which should be added to email as attachment"
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "create"
          ],
          "resource": [
            "thread"
          ]
        }
      },
      "typeOptions": {
        "multipleValues": true
      }
    },
    {
      "displayName": "Conversation ID",
      "name": "conversationId",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "thread"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Return All",
      "name": "returnAll",
      "type": "boolean",
      "default": false,
      "description": "Whether to return all results or only up to a given limit",
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "thread"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 50,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "thread"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1
      }
    }
  ]

operations:
  [
    {
      "operation": "create",
      "name": "Create",
      "description": "Create a new conversation"
    },
    {
      "operation": "delete",
      "name": "Delete",
      "description": "Delete a conversation"
    },
    {
      "operation": "get",
      "name": "Get",
      "description": "Get a conversation"
    },
    {
      "operation": "getAll",
      "name": "Get Many",
      "description": "Get many conversations"
    }
  ]


node_type: nodes-base.helpScoutTrigger
package_name: n8n-nodes-base
display_name: Help Scout Trigger
description: Starts the workflow when Help Scout events occur
category: trigger
development_style: programmatic
version: 1
operations: []
credentials_required:
  [
  {
  "name": "helpScoutOAuth2Api",
  "required": true
  }
  ]

outputs:
  [
  "main"
  ]

updated_at: 2026-03-25 21:12:27
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: Help Scout Trigger node documentation
  description: Learn how to use the Help Scout Trigger node in n8n. Follow technical documentation to integrate Help Scout Trigger node into your workflows.
  contentType: [integration, reference]
  ---

  # Help Scout Trigger node

  [Help Scout](https://www.helpscout.com/){:target=_blank .external-link} is a help desk software that provides an email-based customer support platform, knowledge base tool, and an embeddable search/contact widget for customer service professionals.

  /// note | Credentials
  You can find authentication information for this node [here](/integrations/builtin/credentials/helpscout.md).
  ///

  ///  note  | Examples and templates
  For usage examples and templates to help you get started, refer to n8n's [Help Scout Trigger integrations](https://n8n.io/integrations/helpscout-trigger/){:target=_blank .external-link} page.
  ///

properties_schema:
  [
    {
      "displayName": "Events",
      "name": "events",
      "type": "multiOptions",
      "default": [],
      "options": [
        {
          "name": "Conversation - Assigned",
          "value": "convo.assigned"
        },
        {
          "name": "Conversation - Created",
          "value": "convo.created"
        },
        {
          "name": "Conversation - Deleted",
          "value": "convo.deleted"
        },
        {
          "name": "Conversation - Merged",
          "value": "convo.merged"
        },
        {
          "name": "Conversation - Moved",
          "value": "convo.moved"
        },
        {
          "name": "Conversation - Status",
          "value": "convo.status"
        },
        {
          "name": "Conversation - Tags",
          "value": "convo.tags"
        },
        {
          "name": "Conversation Agent Reply - Created",
          "value": "convo.agent.reply.created"
        },
        {
          "name": "Conversation Customer Reply - Created",
          "value": "convo.customer.reply.created"
        },
        {
          "name": "Conversation Note - Created",
          "value": "convo.note.created"
        },
        {
          "name": "Customer - Created",
          "value": "customer.created"
        },
        {
          "name": "Rating - Received",
          "value": "satisfaction.ratings"
        }
      ],
      "required": true
    }
  ]


node_type: nodes-base.highLevel
package_name: n8n-nodes-base
display_name: HighLevel
description: Consume HighLevel API
category: transform
development_style: programmatic
version: 2
credentials_required:
  [
  {
  "name": "highLevelOAuth2Api",
  "required": true
  }
  ]

outputs:
  [
  "main"
  ]

updated_at: 2026-03-25 21:12:27
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: HighLevel node documentation
  description: Learn how to use the HighLevel node in n8n. Follow technical documentation to integrate HighLevel node into your workflows.
  contentType: [integration, reference]
  ---

  # HighLevel node

  Use the HighLevel node to automate work in HighLevel, and integrate HighLevel with other applications. n8n has built-in support for a wide range of HighLevel features, including creating, updating, deleting, and getting contacts, opportunities, and tasks, as well as booking appointments and getting free time slots in calendars. 

  On this page, you'll find a list of operations the HighLevel node supports and links to more resources.

  /// note | Credentials
  Refer to [HighLevel credentials](/integrations/builtin/credentials/highlevel.md) for guidance on setting up authentication. 
  ///

  ## Operations

  * Contact
  	* Create or update
  	* Delete
  	* Get
  	* Get many
  	* Update
  * Opportunity
  	* Create
  	* Delete
  	* Get
  	* Get many
  	* Update
  * Task
  	* Create
  	* Delete
  	* Get
  	* Get many
  	* Update
  * Calendar
  	* Book an appointment
  	* Get free slots

  ## Templates and examples

  <!-- see https://www.notion.so/n8n/Pull-in-templates-for-the-integrations-pages-37c716837b804d30a33b47475f6e3780 -->
  [[ templatesWidget(page.title, 'highlevel') ]]

  ## Related resources

  Refer to [HighLevel's API documentation and support forums](https://help.gohighlevel.com/support/solutions/articles/48001060529-highlevel-api){:target=_blank .external-link} for more information about the service.

  --8<-- "_snippets/integrations/builtin/app-nodes/operation-not-supported.md"

properties_schema:
  [
    {
      "displayName": "Resource",
      "name": "resource",
      "type": "options",
      "default": "contact",
      "options": [
        {
          "name": "Contact",
          "value": "contact"
        },
        {
          "name": "Opportunity",
          "value": "opportunity"
        },
        {
          "name": "Task",
          "value": "task"
        },
        {
          "name": "Calendar",
          "value": "calendar"
        }
      ],
      "required": true,
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create or Update",
          "value": "create",
          "routing": {
            "request": {
              "method": "POST",
              "url": "/contacts/upsert/"
            },
            "send": {
              "preSend": [
                null,
                null,
                null,
                null
              ]
            },
            "output": {
              "postReceive": [
                {
                  "type": "rootProperty",
                  "properties": {
                    "property": "contact"
                  }
                },
                null
              ]
            }
          },
          "action": "Create or update a contact"
        },
        {
          "name": "Delete",
          "value": "delete",
          "routing": {
            "request": {
              "method": "DELETE",
              "url": "=/contacts/{{$parameter.contactId}}/"
            },
            "output": {
              "postReceive": [
                {
                  "type": "set",
                  "properties": {
                    "value": "={{ { \"success\": true } }}"
                  }
                }
              ]
            }
          },
          "action": "Delete a contact"
        },
        {
          "name": "Get",
          "value": "get",
          "routing": {
            "request": {
              "method": "GET",
              "url": "=/contacts/{{$parameter.contactId}}/"
            },
            "output": {
              "postReceive": [
                {
                  "type": "rootProperty",
                  "properties": {
                    "property": "contact"
                  }
                }
              ]
            }
          },
          "action": "Get a contact"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "routing": {
            "request": {
              "method": "GET",
              "url": "=/contacts/"
            },
            "send": {
              "preSend": [
                null
              ],
              "paginate": true
            }
          },
          "action": "Get many contacts"
        },
        {
          "name": "Update",
          "value": "update",
          "routing": {
            "request": {
              "method": "PUT",
              "url": "=/contacts/{{$parameter.contactId}}/"
            },
            "send": {
              "preSend": [
                null,
                null
              ]
            },
            "output": {
              "postReceive": [
                {
                  "type": "rootProperty",
                  "properties": {
                    "property": "contact"
                  }
                }
              ]
            }
          },
          "action": "Update a contact"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "contact"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Create a new contact or update an existing one if email or phone matches (upsert)",
      "name": "contactCreateNotice",
      "type": "notice",
      "default": "",
      "displayOptions": {
        "show": {
          "resource": [
            "contact"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Email",
      "name": "email",
      "type": "string",
      "default": "",
      "description": "Email or Phone are required to create contact",
      "displayOptions": {
        "show": {
          "resource": [
            "contact"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Phone",
      "name": "phone",
      "type": "string",
      "default": "",
      "description": "Phone or Email are required to create contact. Phone number has to start with a valid <a href=\"https://en.wikipedia.org/wiki/List_of_country_calling_codes\">country code</a> leading with + sign.",
      "displayOptions": {
        "show": {
          "resource": [
            "contact"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Address",
          "name": "address1",
          "type": "string",
          "default": "",
          "routing": {
            "send": {
              "type": "body",
              "property": "address1"
            }
          }
        },
        {
          "displayName": "City",
          "name": "city",
          "type": "string",
          "default": "",
          "routing": {
            "send": {
              "type": "body",
              "property": "city"
            }
          }
        },
        {
          "displayName": "Custom Fields",
          "name": "customFields",
          "placeholder": "Add Field",
          "type": "fixedCollection",
          "default": {},
          "typeOptions": {
            "multipleValues": true
          },
          "options": [
            {
              "name": "values",
              "displayName": "Value",
              "values": [
                {
                  "displayName": "Field Name or ID",
                  "name": "fieldId",
                  "required": true,
                  "type": "resourceLocator",
                  "default": "",
                  "description": "Choose from the list, or specify an ID using an expression",
                  "modes": [
                    {
                      "displayName": "List",
                      "name": "list",
                      "type": "list",
                      "typeOptions": {
                        "searchListMethod": "searchCustomFields",
                        "searchable": true
                      }
                    },
                    {
                      "displayName": "ID",
                      "name": "id",
                      "type": "string",
                      "placeholder": "Enter Custom Field ID"
                    }
                  ]
                },
                {
                  "displayName": "Field Value",
                  "name": "fieldValue",
                  "type": "string",
                  "default": "",
                  "routing": {
                    "send": {
                      "type": "body",
                      "property": "customFields",
                      "value": "={{ $parent.values.map(field => ({ fieldId: { id: field.fieldId.id }, field_value: field.fieldValue })) }}"
                    }
                  }
                }
              ]
            }
          ],
          "routing": {
            "send": {
              "type": "body",
              "property": "customFields"
            }
          }
        },
        {
          "displayName": "Do Not Disturb",
          "name": "dnd",
          "description": "Whether automated/manual outbound messages are permitted to go out or not. True means NO outbound messages are permitted.",
          "type": "boolean",
          "default": false,
          "routing": {
            "send": {
              "type": "body",
              "property": "dnd"
            }
          }
        },
        {
          "displayName": "First Name",
          "name": "firstName",
          "type": "string",
          "default": "",
          "routing": {
            "send": {
              "type": "body",
              "property": "firstName"
            }
          }
        },
        {
          "displayName": "Last Name",
          "name": "lastName",
          "type": "string",
          "default": "",
          "routing": {
            "send": {
              "type": "body",
              "property": "lastName"
            }
          }
        },
        {
          "displayName": "Name",
          "name": "name",
          "type": "string",
          "default": "e.g. John Deo",
          "description": "The full name of the contact, will be overwritten by 'First Name' and 'Last Name' if set",
          "routing": {
            "send": {
              "type": "body",
              "property": "name"
            }
          }
        },
        {
          "displayName": "Postal Code",
          "name": "postalCode",
          "type": "string",
          "default": "",
          "routing": {
            "send": {
              "type": "body",
              "property": "postalCode"
            }
          }
        },
        {
          "displayName": "Source",
          "name": "source",
          "type": "string",
          "default": "",
          "placeholder": "e.g. Public API",
          "routing": {
            "send": {
              "type": "body",
              "property": "source"
            }
          }
        },
        {
          "displayName": "State",
          "name": "state",
          "type": "string",
          "default": "",
          "routing": {
            "send": {
              "type": "body",
              "property": "state"
            }
          }
        },
        {
          "displayName": "Note",
          "name": "notes",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Tags",
          "name": "tags",
          "type": "string",
          "hint": "Comma separated list of tags, array of strings can be set in expression",
          "default": "",
          "routing": {
            "send": {
              "type": "body",
              "property": "tags"
            }
          }
        },
        {
          "displayName": "Timezone",
          "name": "timezone",
          "placeholder": "Select Timezone",
          "type": "resourceLocator",
          "default": "",
          "description": "Choose from the list, or specify a timezone using an expression",
          "modes": [
            {
              "displayName": "List",
              "name": "list",
              "type": "list",
              "typeOptions": {
                "searchListMethod": "searchTimezones",
                "searchable": true
              }
            },
            {
              "displayName": "ID",
              "name": "id",
              "type": "string",
              "placeholder": "Enter Timezone ID"
            }
          ],
          "routing": {
            "send": {
              "type": "body",
              "property": "timezone"
            }
          }
        },
        {
          "displayName": "Website",
          "name": "website",
          "type": "string",
          "default": "",
          "routing": {
            "send": {
              "type": "body",
              "property": "website"
            }
          }
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "contact"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Contact ID",
      "name": "contactId",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "contact"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Update Fields",
      "name": "updateFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Address",
          "name": "address1",
          "type": "string",
          "default": "",
          "routing": {
            "send": {
              "type": "body",
              "property": "address1"
            }
          }
        },
        {
          "displayName": "City",
          "name": "city",
          "type": "string",
          "default": "",
          "routing": {
            "send": {
              "type": "body",
              "property": "city"
            }
          }
        },
        {
          "displayName": "Custom Fields",
          "name": "customFields",
          "placeholder": "Add Field",
          "type": "fixedCollection",
          "default": {},
          "typeOptions": {
            "multipleValues": true
          },
          "options": [
            {
              "name": "values",
              "displayName": "Value",
              "values": [
                {
                  "displayName": "Field Name or ID",
                  "name": "fieldId",
                  "required": true,
                  "type": "resourceLocator",
                  "default": "",
                  "description": "Choose from the list, or specify an ID using an expression",
                  "modes": [
                    {
                      "displayName": "List",
                      "name": "list",
                      "type": "list",
                      "typeOptions": {
                        "searchListMethod": "searchCustomFields",
                        "searchable": true
                      }
                    },
                    {
                      "displayName": "ID",
                      "name": "id",
                      "type": "string",
                      "placeholder": "Enter Custom Field ID"
                    }
                  ]
                },
                {
                  "displayName": "Field Value",
                  "name": "fieldValue",
                  "type": "string",
                  "default": "",
                  "routing": {
                    "send": {
                      "type": "body",
                      "property": "customFields",
                      "value": "={{ $parent.values.map(field => ({ fieldId: { id: field.fieldId.id }, field_value: field.fieldValue })) }}"
                    }
                  }
                }
              ]
            }
          ],
          "routing": {
            "send": {
              "type": "body",
              "property": "customFields"
            }
          }
        },
        {
          "displayName": "Do Not Disturb",
          "name": "dnd",
          "description": "Whether automated/manual outbound messages are permitted to go out or not. True means NO outbound messages are permitted.",
          "type": "boolean",
          "default": false,
          "routing": {
            "send": {
              "type": "body",
              "property": "dnd"
            }
          }
        },
        {
          "displayName": "Email",
          "name": "email",
          "type": "string",
          "placeholder": "name@email.com",
          "default": "",
          "routing": {
            "send": {
              "type": "body",
              "property": "email"
            }
          }
        },
        {
          "displayName": "First Name",
          "name": "firstName",
          "type": "string",
          "default": "",
          "routing": {
            "send": {
              "type": "body",
              "property": "firstName"
            }
          }
        },
        {
          "displayName": "Last Name",
          "name": "lastName",
          "type": "string",
          "default": "",
          "routing": {
            "send": {
              "type": "body",
              "property": "lastName"
            }
          }
        },
        {
          "displayName": "Name",
          "name": "name",
          "type": "string",
          "description": "The full name of the contact, will be overwritten by 'First Name' and 'Last Name' if set",
          "default": "e.g. John Deo",
          "routing": {
            "send": {
              "type": "body",
              "property": "name"
            }
          }
        },
        {
          "displayName": "Phone",
          "name": "phone",
          "type": "string",
          "default": "",
          "description": "Phone number has to start with a valid <a href=\"https://en.wikipedia.org/wiki/List_of_country_calling_codes\">country code</a> leading with + sign",
          "placeholder": "+491234567890",
          "routing": {
            "send": {
              "type": "body",
              "property": "phone"
            }
          }
        },
        {
          "displayName": "Postal Code",
          "name": "postalCode",
          "type": "string",
          "default": "",
          "routing": {
            "send": {
              "type": "body",
              "property": "postalCode"
            }
          }
        },
        {
          "displayName": "State",
          "name": "state",
          "type": "string",
          "default": "",
          "routing": {
            "send": {
              "type": "body",
              "property": "state"
            }
          }
        },
        {
          "displayName": "Tags",
          "name": "tags",
          "type": "string",
          "hint": "Comma separated list of tags, array of strings can be set in expression",
          "default": "",
          "routing": {
            "send": {
              "type": "body",
              "property": "tags"
            }
          }
        },
        {
          "displayName": "Timezone",
          "name": "timezone",
          "placeholder": "Select Timezone",
          "type": "resourceLocator",
          "default": "",
          "description": "Choose from the list, or specify a timezone using an expression",
          "modes": [
            {
              "displayName": "List",
              "name": "list",
              "type": "list",
              "typeOptions": {
                "searchListMethod": "searchTimezones",
                "searchable": true
              }
            },
            {
              "displayName": "ID",
              "name": "id",
              "type": "string",
              "placeholder": "Enter Timezone ID"
            }
          ],
          "routing": {
            "send": {
              "type": "body",
              "property": "timezone"
            }
          }
        },
        {
          "displayName": "Website",
          "name": "website",
          "type": "string",
          "default": "",
          "routing": {
            "send": {
              "type": "body",
              "property": "website"
            }
          }
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "contact"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Contact ID",
      "name": "contactId",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "contact"
          ],
          "operation": [
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "Contact ID",
      "name": "contactId",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "contact"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Return All",
      "name": "returnAll",
      "type": "boolean",
      "default": false,
      "description": "Whether to return all results or only up to a given limit",
      "displayOptions": {
        "show": {
          "resource": [
            "contact"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 50,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "contact"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1
      }
    },
    {
      "displayName": "Filters",
      "name": "filters",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Query",
          "name": "query",
          "type": "string",
          "default": "",
          "description": "Query will search on these fields: Name, Phone, Email, Tags, and Company Name",
          "routing": {
            "send": {
              "type": "query",
              "property": "query"
            }
          }
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "contact"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Order",
          "name": "order",
          "type": "options",
          "options": [
            {
              "name": "Descending",
              "value": "desc"
            },
            {
              "name": "Ascending",
              "value": "asc"
            }
          ],
          "default": "desc",
          "routing": {
            "send": {
              "type": "query",
              "property": "order"
            }
          }
        },
        {
          "displayName": "Sort By",
          "name": "sortBy",
          "type": "options",
          "options": [
            {
              "name": "Date Added",
              "value": "date_added"
            },
            {
              "name": "Date Updated",
              "value": "date_updated"
            }
          ],
          "default": "date_added",
          "routing": {
            "send": {
              "type": "query",
              "property": "sortBy"
            }
          }
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "contact"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Email",
      "name": "email",
      "type": "string",
      "default": "",
      "description": "Lookup Contact by Email. If Email is not found it will try to find a contact by phone.",
      "displayOptions": {
        "show": {
          "resource": [
            "contact"
          ],
          "operation": [
            "lookup"
          ]
        }
      }
    },
    {
      "displayName": "Phone",
      "name": "phone",
      "type": "string",
      "default": "",
      "description": "Lookup Contact by Phone. It will first try to find a contact by Email and than by Phone.",
      "displayOptions": {
        "show": {
          "resource": [
            "contact"
          ],
          "operation": [
            "lookup"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "routing": {
            "send": {
              "preSend": [
                null,
                null
              ]
            },
            "request": {
              "method": "POST",
              "url": "/opportunities/"
            }
          },
          "action": "Create an opportunity"
        },
        {
          "name": "Delete",
          "value": "delete",
          "routing": {
            "request": {
              "method": "DELETE",
              "url": "=/opportunities/{{$parameter.opportunityId}}"
            },
            "output": {
              "postReceive": [
                {
                  "type": "set",
                  "properties": {
                    "value": "={{ { \"success\": true } }}"
                  }
                }
              ]
            }
          },
          "action": "Delete an opportunity"
        },
        {
          "name": "Get",
          "value": "get",
          "routing": {
            "request": {
              "method": "GET",
              "url": "=/opportunities/{{$parameter.opportunityId}}"
            }
          },
          "action": "Get an opportunity"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "routing": {
            "request": {
              "method": "GET",
              "url": "/opportunities/search"
            },
            "send": {
              "preSend": [
                null
              ],
              "paginate": true
            }
          },
          "action": "Get many opportunities"
        },
        {
          "name": "Update",
          "value": "update",
          "routing": {
            "request": {
              "method": "PUT",
              "url": "=/opportunities/{{$parameter.opportunityId}}"
            }
          },
          "action": "Update an opportunity"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "opportunity"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Pipeline Name or ID",
      "name": "pipelineId",
      "type": "options",
      "default": "",
      "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
      "displayOptions": {
        "show": {
          "resource": [
            "opportunity"
          ],
          "operation": [
            "create"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getPipelines"
      }
    },
    {
      "displayName": "Contact Email or ID",
      "name": "contactId",
      "type": "options",
      "default": "",
      "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "opportunity"
          ],
          "operation": [
            "create"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getContacts"
      }
    },
    {
      "displayName": "Name",
      "name": "name",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "opportunity"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Status",
      "name": "status",
      "type": "options",
      "default": "open",
      "options": [
        {
          "name": "Open",
          "value": "open"
        },
        {
          "name": "Won",
          "value": "won"
        },
        {
          "name": "Lost",
          "value": "lost"
        },
        {
          "name": "Abandoned",
          "value": "abandoned"
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "opportunity"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Assigned To",
          "name": "assignedTo",
          "type": "options",
          "default": "",
          "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
          "typeOptions": {
            "loadOptionsMethod": "getUsers"
          },
          "routing": {
            "send": {
              "type": "body",
              "property": "assignedTo"
            }
          }
        },
        {
          "displayName": "Company Name",
          "name": "companyName",
          "type": "string",
          "default": "",
          "routing": {
            "send": {
              "type": "body",
              "property": "companyName"
            }
          }
        },
        {
          "displayName": "Monetary Value",
          "name": "monetaryValue",
          "type": "number",
          "default": "",
          "description": "Monetary value of lead opportunity",
          "routing": {
            "send": {
              "type": "body",
              "property": "monetaryValue"
            }
          }
        },
        {
          "displayName": "Tags",
          "name": "tags",
          "type": "string",
          "hint": "Comma separated list of tags, array of strings can be set in expression",
          "default": "",
          "routing": {
            "send": {
              "type": "body",
              "property": "tags"
            }
          }
        },
        {
          "displayName": "Stage Name or ID",
          "name": "stageId",
          "type": "options",
          "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
          "default": "",
          "typeOptions": {
            "loadOptionsDependsOn": [
              "/pipelineId"
            ],
            "loadOptionsMethod": "getPipelineStages"
          },
          "routing": {
            "send": {
              "type": "body",
              "property": "pipelineStageId"
            }
          }
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "opportunity"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Opportunity ID",
      "name": "opportunityId",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "opportunity"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Update Fields",
      "name": "updateFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Assigned To",
          "name": "assignedTo",
          "type": "options",
          "default": "",
          "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
          "typeOptions": {
            "loadOptionsMethod": "getUsers"
          },
          "routing": {
            "send": {
              "type": "body",
              "property": "assignedTo"
            }
          }
        },
        {
          "displayName": "Monetary Value",
          "name": "monetaryValue",
          "type": "number",
          "default": "",
          "description": "Monetary value of lead opportunity",
          "routing": {
            "send": {
              "type": "body",
              "property": "monetaryValue"
            }
          }
        },
        {
          "displayName": "Name",
          "name": "name",
          "type": "string",
          "default": "",
          "placeholder": "e.g. John Deo",
          "routing": {
            "send": {
              "type": "body",
              "property": "name"
            }
          }
        },
        {
          "displayName": "Pipeline Name or ID",
          "name": "pipelineId",
          "type": "options",
          "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
          "typeOptions": {
            "loadOptionsMethod": "getPipelines"
          },
          "routing": {
            "send": {
              "type": "body",
              "property": "pipelineId"
            }
          },
          "default": ""
        },
        {
          "displayName": "Stage Name or ID",
          "name": "stageId",
          "type": "options",
          "default": "",
          "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
          "hint": "Select 'Pipeline Name or ID' first to see stages",
          "typeOptions": {
            "loadOptionsDependsOn": [
              "pipelineId"
            ],
            "loadOptionsMethod": "getPipelineStages"
          },
          "routing": {
            "send": {
              "type": "body",
              "property": "pipelineStageId"
            }
          }
        },
        {
          "displayName": "Status",
          "name": "status",
          "type": "options",
          "options": [
            {
              "name": "Open",
              "value": "open"
            },
            {
              "name": "Won",
              "value": "won"
            },
            {
              "name": "Lost",
              "value": "lost"
            },
            {
              "name": "Abandoned",
              "value": "abandoned"
            }
          ],
          "default": "open",
          "routing": {
            "send": {
              "type": "body",
              "property": "status"
            }
          }
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "opportunity"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Opportunity ID",
      "name": "opportunityId",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "opportunity"
          ],
          "operation": [
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "Opportunity ID",
      "name": "opportunityId",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "opportunity"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Return All",
      "name": "returnAll",
      "type": "boolean",
      "default": false,
      "description": "Whether to return all results or only up to a given limit",
      "displayOptions": {
        "show": {
          "resource": [
            "opportunity"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 20,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "opportunity"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 100
      }
    },
    {
      "displayName": "Filters",
      "name": "filters",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Assigned To",
          "name": "assignedTo",
          "type": "options",
          "default": "",
          "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
          "typeOptions": {
            "loadOptionsMethod": "getUsers"
          },
          "routing": {
            "send": {
              "type": "query",
              "property": "assigned_to"
            }
          }
        },
        {
          "displayName": "Campaign ID",
          "name": "campaignId",
          "type": "string",
          "default": "",
          "routing": {
            "send": {
              "type": "query",
              "property": "campaignId"
            }
          }
        },
        {
          "displayName": "End Date",
          "name": "endDate",
          "type": "dateTime",
          "default": "",
          "routing": {
            "send": {
              "type": "query",
              "property": "endDate",
              "preSend": [
                null
              ]
            }
          }
        },
        {
          "displayName": "Pipeline Name or ID",
          "name": "pipelineId",
          "type": "options",
          "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
          "typeOptions": {
            "loadOptionsMethod": "getPipelines"
          },
          "routing": {
            "send": {
              "type": "query",
              "property": "pipeline_id"
            }
          },
          "default": ""
        },
        {
          "displayName": "Stage Name or ID",
          "name": "stageId",
          "type": "options",
          "default": "",
          "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
          "hint": "Select 'Pipeline Name or ID' first to see stages",
          "typeOptions": {
            "loadOptionsDependsOn": [
              "pipelineId"
            ],
            "loadOptionsMethod": "getPipelineStages"
          },
          "routing": {
            "send": {
              "type": "query",
              "property": "pipeline_stage_id"
            }
          }
        },
        {
          "displayName": "Start Date",
          "name": "startDate",
          "type": "dateTime",
          "default": "",
          "routing": {
            "send": {
              "type": "query",
              "property": "date",
              "preSend": [
                null
              ]
            }
          }
        },
        {
          "displayName": "Status",
          "name": "status",
          "type": "options",
          "options": [
            {
              "name": "Open",
              "value": "open"
            },
            {
              "name": "Won",
              "value": "won"
            },
            {
              "name": "Lost",
              "value": "lost"
            },
            {
              "name": "Abandoned",
              "value": "abandoned"
            }
          ],
          "default": "open",
          "routing": {
            "send": {
              "type": "query",
              "property": "status"
            }
          }
        },
        {
          "displayName": "Query",
          "name": "query",
          "type": "string",
          "default": "",
          "description": "Query will search on these fields: Name, Phone, Email, Tags, and Company Name",
          "routing": {
            "send": {
              "type": "query",
              "property": "q"
            }
          }
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "opportunity"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "routing": {
            "request": {
              "method": "POST",
              "url": "=/contacts/{{$parameter.contactId}}/tasks/"
            },
            "output": {
              "postReceive": [
                null
              ]
            }
          },
          "action": "Create a task"
        },
        {
          "name": "Delete",
          "value": "delete",
          "routing": {
            "request": {
              "method": "DELETE",
              "url": "=/contacts/{{$parameter.contactId}}/tasks/{{$parameter.taskId}}/"
            },
            "output": {
              "postReceive": [
                {
                  "type": "set",
                  "properties": {
                    "value": "={{ { \"success\": true } }}"
                  }
                }
              ]
            }
          },
          "action": "Delete a task"
        },
        {
          "name": "Get",
          "value": "get",
          "routing": {
            "request": {
              "method": "GET",
              "url": "=/contacts/{{$parameter.contactId}}/tasks/{{$parameter.taskId}}/"
            },
            "output": {
              "postReceive": [
                null
              ]
            }
          },
          "action": "Get a task"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "routing": {
            "request": {
              "method": "GET",
              "url": "=/contacts/{{$parameter.contactId}}/tasks/"
            },
            "output": {
              "postReceive": [
                {
                  "type": "rootProperty",
                  "properties": {
                    "property": "tasks"
                  }
                },
                null
              ]
            }
          },
          "action": "Get many tasks"
        },
        {
          "name": "Update",
          "value": "update",
          "routing": {
            "request": {
              "method": "PUT",
              "url": "=/contacts/{{$parameter.contactId}}/tasks/{{$parameter.taskId}}/"
            },
            "send": {
              "preSend": [
                null
              ]
            },
            "output": {
              "postReceive": [
                null
              ]
            }
          },
          "action": "Update a task"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "task"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Contact Email or ID",
      "name": "contactId",
      "type": "options",
      "default": "",
      "description": "Contact the task belongs to. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "task"
          ],
          "operation": [
            "create"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getContacts"
      }
    },
    {
      "displayName": "Title",
      "name": "title",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "task"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Due Date",
      "name": "dueDate",
      "type": "dateTime",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "task"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Completed",
      "name": "completed",
      "type": "boolean",
      "default": false,
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "task"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Assigned To",
          "name": "assignedTo",
          "type": "options",
          "default": "",
          "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
          "typeOptions": {
            "loadOptionsMethod": "getUsers"
          },
          "routing": {
            "send": {
              "type": "body",
              "property": "assignedTo"
            }
          }
        },
        {
          "displayName": "Body",
          "name": "body",
          "type": "string",
          "default": "",
          "routing": {
            "send": {
              "type": "body",
              "property": "body"
            }
          }
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "task"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Contact Email or ID",
      "name": "contactId",
      "type": "options",
      "default": "",
      "description": "Contact the task belongs to. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "task"
          ],
          "operation": [
            "update"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getContacts"
      }
    },
    {
      "displayName": "Task ID",
      "name": "taskId",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "task"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Update Fields",
      "name": "updateFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Assigned To",
          "name": "assignedTo",
          "type": "options",
          "default": "",
          "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
          "typeOptions": {
            "loadOptionsMethod": "getUsers"
          },
          "routing": {
            "send": {
              "type": "body",
              "property": "assignedTo"
            }
          }
        },
        {
          "displayName": "Completed",
          "name": "completed",
          "type": "boolean",
          "default": false,
          "routing": {
            "send": {
              "type": "body",
              "property": "completed"
            }
          }
        },
        {
          "displayName": "Body",
          "name": "body",
          "type": "string",
          "default": "",
          "routing": {
            "send": {
              "type": "body",
              "property": "body"
            }
          }
        },
        {
          "displayName": "Due Date",
          "name": "dueDate",
          "type": "dateTime",
          "default": "",
          "routing": {
            "send": {
              "type": "body",
              "property": "dueDate",
              "preSend": [
                null
              ]
            }
          }
        },
        {
          "displayName": "Title",
          "name": "title",
          "type": "string",
          "default": "",
          "routing": {
            "send": {
              "type": "body",
              "property": "title"
            }
          }
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "task"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Contact Email or ID",
      "name": "contactId",
      "type": "options",
      "default": "",
      "description": "Contact the task belongs to. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "task"
          ],
          "operation": [
            "delete"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getContacts"
      }
    },
    {
      "displayName": "Task ID",
      "name": "taskId",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "task"
          ],
          "operation": [
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "Contact Email or ID",
      "name": "contactId",
      "type": "options",
      "default": "",
      "description": "Contact the task belongs to. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "task"
          ],
          "operation": [
            "get"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getContacts"
      }
    },
    {
      "displayName": "Task ID",
      "name": "taskId",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "task"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Contact Email or ID",
      "name": "contactId",
      "type": "options",
      "default": "",
      "description": "Contact the task belongs to. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "task"
          ],
          "operation": [
            "getAll"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getContacts"
      }
    },
    {
      "displayName": "Return All",
      "name": "returnAll",
      "type": "boolean",
      "default": false,
      "description": "Whether to return all results or only up to a given limit",
      "displayOptions": {
        "show": {
          "resource": [
            "task"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 20,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "task"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 100
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "bookAppointment",
      "options": [
        {
          "name": "Book Appointment",
          "value": "bookAppointment",
          "action": "Book appointment in a calendar",
          "routing": {
            "request": {
              "method": "POST",
              "url": "=/calendars/events/appointments"
            }
          }
        },
        {
          "name": "Get Free Slots",
          "value": "getFreeSlots",
          "action": "Get free slots of a calendar",
          "routing": {
            "request": {
              "method": "GET",
              "url": "=/calendars/{{$parameter.calendarId}}/free-slots"
            }
          }
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "calendar"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Calendar ID",
      "name": "calendarId",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "calendar"
          ],
          "operation": [
            "bookAppointment"
          ]
        }
      }
    },
    {
      "displayName": "Location ID",
      "name": "locationId",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "calendar"
          ],
          "operation": [
            "bookAppointment"
          ]
        }
      }
    },
    {
      "displayName": "Contact ID",
      "name": "contactId",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "calendar"
          ],
          "operation": [
            "bookAppointment"
          ]
        }
      }
    },
    {
      "displayName": "Start Time",
      "name": "startTime",
      "type": "string",
      "default": "",
      "description": "Example: 2021-06-23T03:30:00+05:30",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "calendar"
          ],
          "operation": [
            "bookAppointment"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "End Time",
          "name": "endTime",
          "type": "string",
          "description": "Example: 2021-06-23T04:30:00+05:30",
          "default": "",
          "routing": {
            "send": {
              "type": "body",
              "property": "endTime"
            }
          }
        },
        {
          "displayName": "Title",
          "name": "title",
          "type": "string",
          "default": "",
          "routing": {
            "send": {
              "type": "body",
              "property": "title"
            }
          }
        },
        {
          "displayName": "Appointment Status",
          "name": "appointmentStatus",
          "type": "options",
          "default": "new",
          "description": "The status of the appointment. Allowed values: new, confirmed, cancelled, showed, noshow, invalid.",
          "options": [
            {
              "name": "Cancelled",
              "value": "cancelled"
            },
            {
              "name": "Confirmed",
              "value": "confirmed"
            },
            {
              "name": "Invalid",
              "value": "invalid"
            },
            {
              "name": "New",
              "value": "new"
            },
            {
              "name": "No Show",
              "value": "noshow"
            },
            {
              "name": "Showed",
              "value": "showed"
            }
          ],
          "routing": {
            "send": {
              "type": "body",
              "property": "appointmentStatus"
            }
          }
        },
        {
          "displayName": "Assigned User ID",
          "name": "assignedUserId",
          "type": "string",
          "default": "",
          "routing": {
            "send": {
              "type": "body",
              "property": "assignedUserId"
            }
          }
        },
        {
          "displayName": "Address",
          "name": "address",
          "type": "string",
          "default": "",
          "routing": {
            "send": {
              "type": "body",
              "property": "address"
            }
          }
        },
        {
          "displayName": "Ignore Date Range",
          "name": "ignoreDateRange",
          "type": "boolean",
          "default": false,
          "routing": {
            "send": {
              "type": "body",
              "property": "ignoreDateRange"
            }
          }
        },
        {
          "displayName": "Notify",
          "name": "toNotify",
          "type": "boolean",
          "default": true,
          "routing": {
            "send": {
              "type": "body",
              "property": "toNotify"
            }
          }
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "calendar"
          ],
          "operation": [
            "bookAppointment"
          ]
        }
      }
    },
    {
      "displayName": "Calendar ID",
      "name": "calendarId",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "calendar"
          ],
          "operation": [
            "getFreeSlots"
          ]
        }
      }
    },
    {
      "displayName": "Start Date",
      "name": "startDate",
      "type": "number",
      "default": "",
      "description": "The start date for fetching free calendar slots. Example: 1548898600000.",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "calendar"
          ],
          "operation": [
            "getFreeSlots"
          ]
        }
      }
    },
    {
      "displayName": "End Date",
      "name": "endDate",
      "type": "number",
      "default": "",
      "description": "The end date for fetching free calendar slots. Example: 1601490599999.",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "calendar"
          ],
          "operation": [
            "getFreeSlots"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Timezone",
          "name": "timezone",
          "type": "string",
          "default": "",
          "description": "The timezone to use for the returned slots. Example: America/Chihuahua.",
          "routing": {
            "send": {
              "type": "query",
              "property": "timezone"
            }
          }
        },
        {
          "displayName": "User ID",
          "name": "userId",
          "type": "string",
          "default": "",
          "description": "User ID to filter the slots (optional)",
          "routing": {
            "send": {
              "type": "query",
              "property": "userId"
            }
          }
        },
        {
          "displayName": "User IDs",
          "name": "userIds",
          "type": "collection",
          "default": {},
          "options": [
            {
              "displayName": "User IDs",
              "name": "userIds",
              "type": "string",
              "default": "",
              "description": "Comma-separated list of user IDs to filter the slots",
              "routing": {
                "send": {
                  "type": "query",
                  "property": "userIds"
                }
              }
            }
          ]
        },
        {
          "displayName": "Apply Look Busy",
          "name": "enableLookBusy",
          "type": "boolean",
          "default": false,
          "description": "Apply Look Busy to the slots",
          "routing": {
            "send": {
              "type": "query",
              "property": "enableLookBusy"
            }
          }
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "calendar"
          ],
          "operation": [
            "getFreeSlots"
          ]
        }
      }
    }
  ]

operations:
  [
    {
      "operation": "create",
      "name": "Create or Update"
    },
    {
      "operation": "delete",
      "name": "Delete"
    },
    {
      "operation": "get",
      "name": "Get"
    },
    {
      "operation": "getAll",
      "name": "Get Many"
    },
    {
      "operation": "update",
      "name": "Update"
    }
  ]


node_type: nodes-base.homeAssistantTool
package_name: n8n-nodes-base
display_name: Home Assistant Tool
description: Consume Home Assistant API (AI Tool variant for use with AI Agents)
category: output
development_style: programmatic
version: 1
outputs:
  [
  {
  "type": "ai_tool",
  "displayName": "Tool"
  }
  ]

output_names:
  [
  "Tool"
  ]

updated_at: 2026-03-25 21:12:27
tool_variant_of: nodes-base.homeAssistant
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: Home Assistant node documentation
  description: Learn how to use the Home Assistant node in n8n. Follow technical documentation to integrate Home Assistant node into your workflows.
  contentType: [integration, reference]
  priority: medium
  ---

  # Home Assistant node

  Use the Home Assistant node to automate work in Home Assistant, and integrate Home Assistant with other applications. n8n has built-in support for a wide range of Home Assistant features, including getting, creating, and checking camera proxies, configurations, logs, services, and templates. 

  On this page, you'll find a list of operations the Home Assistant node supports and links to more resources.

  /// note | Credentials
  Refer to [Home Assistant credentials](/integrations/builtin/credentials/homeassistant.md) for guidance on setting up authentication. 
  ///

  --8<-- "_snippets/integrations/builtin/app-nodes/ai-tools.md"

  ## Operations

  * Camera Proxy
      * Get the camera screenshot
  * Config
      * Get the configuration
      * Check the configuration
  * Event
      * Create an event
      * Get all events
  * Log
      * Get a log for a specific entity
      * Get all logs
  * Service
      * Call a service within a specific domain
      * Get all services
  * State
      * Create a new record, or update the current one if it already exists (upsert)
      * Get a state for a specific entity
      * Get all states
  * Template
      * Create a template

  ## Templates and examples

  <!-- see https://www.notion.so/n8n/Pull-in-templates-for-the-integrations-pages-37c716837b804d30a33b47475f6e3780 -->
  [[ templatesWidget(page.title, 'home-assistant') ]]

  ## Related resources

  Refer to [Home Assistant's documentation](https://developers.home-assistant.io/docs/api/rest/){:target=_blank .external-link} for more information about the service.

properties_schema:
  [
    {
      "displayName": "Tool Description",
      "name": "toolDescription",
      "type": "string",
      "default": "",
      "required": false,
      "description": "Description for the AI to understand what this tool does and when to use it",
      "typeOptions": {
        "rows": 3
      },
      "placeholder": "e.g., Use this tool to interact with Home Assistant"
    },
    {
      "displayName": "Resource",
      "name": "resource",
      "type": "options",
      "default": "config",
      "options": [
        {
          "name": "Camera Proxy",
          "value": "cameraProxy"
        },
        {
          "name": "Config",
          "value": "config"
        },
        {
          "name": "Event",
          "value": "event"
        },
        {
          "name": "Log",
          "value": "log"
        },
        {
          "name": "Service",
          "value": "service"
        },
        {
          "name": "State",
          "value": "state"
        },
        {
          "name": "Template",
          "value": "template"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "getScreenshot",
      "options": [
        {
          "name": "Get Screenshot",
          "value": "getScreenshot",
          "description": "Get the camera screenshot",
          "action": "Get a screenshot"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "cameraProxy"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Camera Entity Name or ID",
      "name": "cameraEntityId",
      "type": "options",
      "default": "",
      "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "getScreenshot"
          ],
          "resource": [
            "cameraProxy"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getCameraEntities"
      }
    },
    {
      "displayName": "Put Output File in Field",
      "name": "binaryPropertyName",
      "type": "string",
      "default": "data",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "getScreenshot"
          ],
          "resource": [
            "cameraProxy"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "get",
      "options": [
        {
          "name": "Get",
          "value": "get",
          "description": "Get the configuration",
          "action": "Get the config"
        },
        {
          "name": "Check Configuration",
          "value": "check",
          "description": "Check the configuration",
          "action": "Check the config"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "config"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "getAll",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create an event",
          "action": "Create an event"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get many events",
          "action": "Get many events"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "event"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Return All",
      "name": "returnAll",
      "type": "boolean",
      "default": false,
      "description": "Whether to return all results or only up to a given limit",
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "event"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 50,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "event"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 100
      }
    },
    {
      "displayName": "Event Type",
      "name": "eventType",
      "type": "string",
      "default": "",
      "description": "The Entity ID for which an event will be created",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "create"
          ],
          "resource": [
            "event"
          ]
        }
      }
    },
    {
      "displayName": "Event Attributes",
      "name": "eventAttributes",
      "type": "fixedCollection",
      "default": {},
      "options": [
        {
          "displayName": "Attributes",
          "name": "attributes",
          "values": [
            {
              "displayName": "Name",
              "name": "name",
              "type": "string",
              "default": "",
              "description": "Name of the attribute"
            },
            {
              "displayName": "Value",
              "name": "value",
              "type": "string",
              "default": "",
              "description": "Value of the attribute"
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "event"
          ],
          "operation": [
            "create"
          ]
        }
      },
      "typeOptions": {
        "multipleValues": true
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "getAll",
      "options": [
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get many state changes",
          "action": "Get many state changes"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "history"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Return All",
      "name": "returnAll",
      "type": "boolean",
      "default": false,
      "description": "Whether to return all results or only up to a given limit",
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "history"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 50,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "history"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 100
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "End Time",
          "name": "endTime",
          "type": "dateTime",
          "default": "",
          "description": "The end of the period"
        },
        {
          "displayName": "Entity IDs",
          "name": "entityIds",
          "type": "string",
          "default": "",
          "description": "The entities IDs separated by comma"
        },
        {
          "displayName": "Minimal Response",
          "name": "minimalResponse",
          "type": "boolean",
          "default": false,
          "description": "Whether to only return <code>last_changed</code> and state for states"
        },
        {
          "displayName": "Significant Changes Only",
          "name": "significantChangesOnly",
          "type": "boolean",
          "default": false,
          "description": "Whether to only return significant state changes"
        },
        {
          "displayName": "Start Time",
          "name": "startTime",
          "type": "dateTime",
          "default": "",
          "description": "The beginning of the period"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "history"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "getErroLogs",
      "options": [
        {
          "name": "Get Error Logs",
          "value": "getErroLogs",
          "description": "Get a log for a specific entity",
          "action": "Get a log for an entity"
        },
        {
          "name": "Get Logbook Entries",
          "value": "getLogbookEntries",
          "description": "Get all logs",
          "action": "Get all logs for an entity"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "log"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "End Time",
          "name": "endTime",
          "type": "dateTime",
          "default": "",
          "description": "The end of the period"
        },
        {
          "displayName": "Entity ID",
          "name": "entityId",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Start Time",
          "name": "startTime",
          "type": "dateTime",
          "default": "",
          "description": "The beginning of the period"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "log"
          ],
          "operation": [
            "getLogbookEntries"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "getAll",
      "options": [
        {
          "name": "Call",
          "value": "call",
          "description": "Call a service within a specific domain",
          "action": "Call a service"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get many services",
          "action": "Get many services"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "service"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Return All",
      "name": "returnAll",
      "type": "boolean",
      "default": false,
      "description": "Whether to return all results or only up to a given limit",
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "service"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 50,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "service"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 100
      }
    },
    {
      "displayName": "Domain Name or ID",
      "name": "domain",
      "type": "options",
      "default": "",
      "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "service"
          ],
          "operation": [
            "call"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getDomains"
      }
    },
    {
      "displayName": "Service Name or ID",
      "name": "service",
      "type": "options",
      "default": "",
      "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "service"
          ],
          "operation": [
            "call"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsDependsOn": [
          "domain"
        ],
        "loadOptionsMethod": "getDomainServices"
      }
    },
    {
      "displayName": "Service Attributes",
      "name": "serviceAttributes",
      "type": "fixedCollection",
      "default": {},
      "options": [
        {
          "name": "attributes",
          "displayName": "Attributes",
          "values": [
            {
              "displayName": "Name",
              "name": "name",
              "type": "string",
              "default": "",
              "description": "Name of the field"
            },
            {
              "displayName": "Value",
              "name": "value",
              "type": "string",
              "default": "",
              "description": "Value of the field"
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "service"
          ],
          "operation": [
            "call"
          ]
        }
      },
      "typeOptions": {
        "multipleValues": true
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "get",
      "options": [
        {
          "name": "Create or Update",
          "value": "upsert",
          "description": "Create a new record, or update the current one if it already exists (upsert)",
          "action": "Create or update a state"
        },
        {
          "name": "Get",
          "value": "get",
          "description": "Get a state for a specific entity",
          "action": "Get a state"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get many states",
          "action": "Get many states"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "state"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Entity Name or ID",
      "name": "entityId",
      "type": "options",
      "default": "",
      "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "get"
          ],
          "resource": [
            "state"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getAllEntities"
      }
    },
    {
      "displayName": "Return All",
      "name": "returnAll",
      "type": "boolean",
      "default": false,
      "description": "Whether to return all results or only up to a given limit",
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "state"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 50,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "state"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 100
      }
    },
    {
      "displayName": "Entity Name or ID",
      "name": "entityId",
      "type": "options",
      "default": "",
      "description": "The entity ID for which a state will be created. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "upsert"
          ],
          "resource": [
            "state"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getAllEntities"
      }
    },
    {
      "displayName": "State",
      "name": "state",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "state"
          ],
          "operation": [
            "upsert"
          ]
        }
      }
    },
    {
      "displayName": "State Attributes",
      "name": "stateAttributes",
      "type": "fixedCollection",
      "default": {},
      "options": [
        {
          "displayName": "Attributes",
          "name": "attributes",
          "values": [
            {
              "displayName": "Name",
              "name": "name",
              "type": "string",
              "default": "",
              "description": "Name of the attribute"
            },
            {
              "displayName": "Value",
              "name": "value",
              "type": "string",
              "default": "",
              "description": "Value of the attribute"
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "state"
          ],
          "operation": [
            "upsert"
          ]
        }
      },
      "typeOptions": {
        "multipleValues": true
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create a template",
          "action": "Create a template"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "template"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Template",
      "name": "template",
      "type": "string",
      "default": "",
      "description": "Render a Home Assistant template. <a href=\"https://www.home-assistant.io/docs/configuration/templating/\">See template docs for more information.</a>.",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "template"
          ],
          "operation": [
            "create"
          ]
        }
      }
    }
  ]

operations:
  [
    {
      "operation": "getScreenshot",
      "name": "Get Screenshot",
      "description": "Get the camera screenshot"
    }
  ]

credentials_required:
  [
    {
      "name": "homeAssistantApi",
      "required": true,
      "testedBy": "homeAssistantApiTest"
    }
  ]


node_type: nodes-base.homeAssistant
package_name: n8n-nodes-base
display_name: Home Assistant
description: Consume Home Assistant API
category: output
development_style: programmatic
version: 1
outputs:
  [
  "main"
  ]

updated_at: 2026-03-25 21:12:27
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: Home Assistant node documentation
  description: Learn how to use the Home Assistant node in n8n. Follow technical documentation to integrate Home Assistant node into your workflows.
  contentType: [integration, reference]
  priority: medium
  ---

  # Home Assistant node

  Use the Home Assistant node to automate work in Home Assistant, and integrate Home Assistant with other applications. n8n has built-in support for a wide range of Home Assistant features, including getting, creating, and checking camera proxies, configurations, logs, services, and templates. 

  On this page, you'll find a list of operations the Home Assistant node supports and links to more resources.

  /// note | Credentials
  Refer to [Home Assistant credentials](/integrations/builtin/credentials/homeassistant.md) for guidance on setting up authentication. 
  ///

  --8<-- "_snippets/integrations/builtin/app-nodes/ai-tools.md"

  ## Operations

  * Camera Proxy
      * Get the camera screenshot
  * Config
      * Get the configuration
      * Check the configuration
  * Event
      * Create an event
      * Get all events
  * Log
      * Get a log for a specific entity
      * Get all logs
  * Service
      * Call a service within a specific domain
      * Get all services
  * State
      * Create a new record, or update the current one if it already exists (upsert)
      * Get a state for a specific entity
      * Get all states
  * Template
      * Create a template

  ## Templates and examples

  <!-- see https://www.notion.so/n8n/Pull-in-templates-for-the-integrations-pages-37c716837b804d30a33b47475f6e3780 -->
  [[ templatesWidget(page.title, 'home-assistant') ]]

  ## Related resources

  Refer to [Home Assistant's documentation](https://developers.home-assistant.io/docs/api/rest/){:target=_blank .external-link} for more information about the service.

properties_schema:
  [
    {
      "displayName": "Resource",
      "name": "resource",
      "type": "options",
      "default": "config",
      "options": [
        {
          "name": "Camera Proxy",
          "value": "cameraProxy"
        },
        {
          "name": "Config",
          "value": "config"
        },
        {
          "name": "Event",
          "value": "event"
        },
        {
          "name": "Log",
          "value": "log"
        },
        {
          "name": "Service",
          "value": "service"
        },
        {
          "name": "State",
          "value": "state"
        },
        {
          "name": "Template",
          "value": "template"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "getScreenshot",
      "options": [
        {
          "name": "Get Screenshot",
          "value": "getScreenshot",
          "description": "Get the camera screenshot",
          "action": "Get a screenshot"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "cameraProxy"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Camera Entity Name or ID",
      "name": "cameraEntityId",
      "type": "options",
      "default": "",
      "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "getScreenshot"
          ],
          "resource": [
            "cameraProxy"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getCameraEntities"
      }
    },
    {
      "displayName": "Put Output File in Field",
      "name": "binaryPropertyName",
      "type": "string",
      "default": "data",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "getScreenshot"
          ],
          "resource": [
            "cameraProxy"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "get",
      "options": [
        {
          "name": "Get",
          "value": "get",
          "description": "Get the configuration",
          "action": "Get the config"
        },
        {
          "name": "Check Configuration",
          "value": "check",
          "description": "Check the configuration",
          "action": "Check the config"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "config"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "getAll",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create an event",
          "action": "Create an event"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get many events",
          "action": "Get many events"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "event"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Return All",
      "name": "returnAll",
      "type": "boolean",
      "default": false,
      "description": "Whether to return all results or only up to a given limit",
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "event"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 50,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "event"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 100
      }
    },
    {
      "displayName": "Event Type",
      "name": "eventType",
      "type": "string",
      "default": "",
      "description": "The Entity ID for which an event will be created",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "create"
          ],
          "resource": [
            "event"
          ]
        }
      }
    },
    {
      "displayName": "Event Attributes",
      "name": "eventAttributes",
      "type": "fixedCollection",
      "default": {},
      "options": [
        {
          "displayName": "Attributes",
          "name": "attributes",
          "values": [
            {
              "displayName": "Name",
              "name": "name",
              "type": "string",
              "default": "",
              "description": "Name of the attribute"
            },
            {
              "displayName": "Value",
              "name": "value",
              "type": "string",
              "default": "",
              "description": "Value of the attribute"
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "event"
          ],
          "operation": [
            "create"
          ]
        }
      },
      "typeOptions": {
        "multipleValues": true
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "getAll",
      "options": [
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get many state changes",
          "action": "Get many state changes"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "history"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Return All",
      "name": "returnAll",
      "type": "boolean",
      "default": false,
      "description": "Whether to return all results or only up to a given limit",
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "history"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 50,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "history"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 100
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "End Time",
          "name": "endTime",
          "type": "dateTime",
          "default": "",
          "description": "The end of the period"
        },
        {
          "displayName": "Entity IDs",
          "name": "entityIds",
          "type": "string",
          "default": "",
          "description": "The entities IDs separated by comma"
        },
        {
          "displayName": "Minimal Response",
          "name": "minimalResponse",
          "type": "boolean",
          "default": false,
          "description": "Whether to only return <code>last_changed</code> and state for states"
        },
        {
          "displayName": "Significant Changes Only",
          "name": "significantChangesOnly",
          "type": "boolean",
          "default": false,
          "description": "Whether to only return significant state changes"
        },
        {
          "displayName": "Start Time",
          "name": "startTime",
          "type": "dateTime",
          "default": "",
          "description": "The beginning of the period"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "history"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "getErroLogs",
      "options": [
        {
          "name": "Get Error Logs",
          "value": "getErroLogs",
          "description": "Get a log for a specific entity",
          "action": "Get a log for an entity"
        },
        {
          "name": "Get Logbook Entries",
          "value": "getLogbookEntries",
          "description": "Get all logs",
          "action": "Get all logs for an entity"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "log"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "End Time",
          "name": "endTime",
          "type": "dateTime",
          "default": "",
          "description": "The end of the period"
        },
        {
          "displayName": "Entity ID",
          "name": "entityId",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Start Time",
          "name": "startTime",
          "type": "dateTime",
          "default": "",
          "description": "The beginning of the period"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "log"
          ],
          "operation": [
            "getLogbookEntries"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "getAll",
      "options": [
        {
          "name": "Call",
          "value": "call",
          "description": "Call a service within a specific domain",
          "action": "Call a service"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get many services",
          "action": "Get many services"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "service"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Return All",
      "name": "returnAll",
      "type": "boolean",
      "default": false,
      "description": "Whether to return all results or only up to a given limit",
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "service"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 50,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "service"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 100
      }
    },
    {
      "displayName": "Domain Name or ID",
      "name": "domain",
      "type": "options",
      "default": "",
      "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "service"
          ],
          "operation": [
            "call"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getDomains"
      }
    },
    {
      "displayName": "Service Name or ID",
      "name": "service",
      "type": "options",
      "default": "",
      "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "service"
          ],
          "operation": [
            "call"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsDependsOn": [
          "domain"
        ],
        "loadOptionsMethod": "getDomainServices"
      }
    },
    {
      "displayName": "Service Attributes",
      "name": "serviceAttributes",
      "type": "fixedCollection",
      "default": {},
      "options": [
        {
          "name": "attributes",
          "displayName": "Attributes",
          "values": [
            {
              "displayName": "Name",
              "name": "name",
              "type": "string",
              "default": "",
              "description": "Name of the field"
            },
            {
              "displayName": "Value",
              "name": "value",
              "type": "string",
              "default": "",
              "description": "Value of the field"
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "service"
          ],
          "operation": [
            "call"
          ]
        }
      },
      "typeOptions": {
        "multipleValues": true
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "get",
      "options": [
        {
          "name": "Create or Update",
          "value": "upsert",
          "description": "Create a new record, or update the current one if it already exists (upsert)",
          "action": "Create or update a state"
        },
        {
          "name": "Get",
          "value": "get",
          "description": "Get a state for a specific entity",
          "action": "Get a state"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get many states",
          "action": "Get many states"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "state"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Entity Name or ID",
      "name": "entityId",
      "type": "options",
      "default": "",
      "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "get"
          ],
          "resource": [
            "state"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getAllEntities"
      }
    },
    {
      "displayName": "Return All",
      "name": "returnAll",
      "type": "boolean",
      "default": false,
      "description": "Whether to return all results or only up to a given limit",
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "state"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 50,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "state"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 100
      }
    },
    {
      "displayName": "Entity Name or ID",
      "name": "entityId",
      "type": "options",
      "default": "",
      "description": "The entity ID for which a state will be created. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "upsert"
          ],
          "resource": [
            "state"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getAllEntities"
      }
    },
    {
      "displayName": "State",
      "name": "state",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "state"
          ],
          "operation": [
            "upsert"
          ]
        }
      }
    },
    {
      "displayName": "State Attributes",
      "name": "stateAttributes",
      "type": "fixedCollection",
      "default": {},
      "options": [
        {
          "displayName": "Attributes",
          "name": "attributes",
          "values": [
            {
              "displayName": "Name",
              "name": "name",
              "type": "string",
              "default": "",
              "description": "Name of the attribute"
            },
            {
              "displayName": "Value",
              "name": "value",
              "type": "string",
              "default": "",
              "description": "Value of the attribute"
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "state"
          ],
          "operation": [
            "upsert"
          ]
        }
      },
      "typeOptions": {
        "multipleValues": true
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create a template",
          "action": "Create a template"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "template"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Template",
      "name": "template",
      "type": "string",
      "default": "",
      "description": "Render a Home Assistant template. <a href=\"https://www.home-assistant.io/docs/configuration/templating/\">See template docs for more information.</a>.",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "template"
          ],
          "operation": [
            "create"
          ]
        }
      }
    }
  ]

operations:
  [
    {
      "operation": "getScreenshot",
      "name": "Get Screenshot",
      "description": "Get the camera screenshot"
    }
  ]

credentials_required:
  [
    {
      "name": "homeAssistantApi",
      "required": true,
      "testedBy": "homeAssistantApiTest"
    }
  ]


node_type: nodes-base.htmlExtract
package_name: n8n-nodes-base
display_name: HTML Extract
description: Extracts data from HTML
category: transform
development_style: programmatic
version: 1
operations: []
credentials_required: []
outputs:
  [
  "main"
  ]

updated_at: 2026-03-25 21:12:27
properties_schema:
  [
    {
      "displayName": "Source Data",
      "name": "sourceData",
      "type": "options",
      "default": "json",
      "description": "If HTML should be read from binary or JSON data",
      "options": [
        {
          "name": "Binary",
          "value": "binary"
        },
        {
          "name": "JSON",
          "value": "json"
        }
      ]
    },
    {
      "displayName": "Input Binary Field",
      "name": "dataPropertyName",
      "type": "string",
      "default": "data",
      "required": true,
      "displayOptions": {
        "show": {
          "sourceData": [
            "binary"
          ]
        }
      }
    },
    {
      "displayName": "JSON Property",
      "name": "dataPropertyName",
      "type": "string",
      "default": "data",
      "description": "Name of the JSON property in which the HTML to extract the data from can be found. The property can either contain a string or an array of strings.",
      "required": true,
      "displayOptions": {
        "show": {
          "sourceData": [
            "json"
          ]
        }
      }
    },
    {
      "displayName": "Extraction Values",
      "name": "extractionValues",
      "type": "fixedCollection",
      "default": {},
      "options": [
        {
          "name": "values",
          "displayName": "Values",
          "values": [
            {
              "displayName": "Key",
              "name": "key",
              "type": "string",
              "default": "",
              "description": "The key under which the extracted value should be saved"
            },
            {
              "displayName": "CSS Selector",
              "name": "cssSelector",
              "type": "string",
              "default": "",
              "placeholder": ".price",
              "description": "The CSS selector to use"
            },
            {
              "displayName": "Return Value",
              "name": "returnValue",
              "type": "options",
              "options": [
                {
                  "name": "Attribute",
                  "value": "attribute",
                  "description": "Get an attribute value like \"class\" from an element"
                },
                {
                  "name": "HTML",
                  "value": "html",
                  "description": "Get the HTML the element contains"
                },
                {
                  "name": "Text",
                  "value": "text",
                  "description": "Get only the text content of the element"
                },
                {
                  "name": "Value",
                  "value": "value",
                  "description": "Get value of an input, select or textarea"
                }
              ],
              "default": "text",
              "description": "What kind of data should be returned"
            },
            {
              "displayName": "Attribute",
              "name": "attribute",
              "type": "string",
              "displayOptions": {
                "show": {
                  "returnValue": [
                    "attribute"
                  ]
                }
              },
              "default": "",
              "placeholder": "class",
              "description": "The name of the attribute to return the value off"
            },
            {
              "displayName": "Return Array",
              "name": "returnArray",
              "type": "boolean",
              "default": false,
              "description": "Whether to return the values as an array so if multiple ones get found they also get returned separately. If not set all will be returned as a single string."
            }
          ]
        }
      ],
      "typeOptions": {
        "multipleValues": true
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Trim Values",
          "name": "trimValues",
          "type": "boolean",
          "default": true,
          "description": "Whether to remove automatically all spaces and newlines from the beginning and end of the values"
        }
      ]
    }
  ]


node_type: nodes-base.html
package_name: n8n-nodes-base
display_name: HTML
description: Work with HTML
category: transform
development_style: programmatic
version: 1.2
credentials_required: []
outputs:
  [
  "main"
  ]

updated_at: 2026-03-25 21:12:27
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: HTML
  description: Documentation for the HTML node in n8n, a workflow automation platform. Includes guidance on usage, and links to examples.
  contentType: [integration, reference]
  priority: high
  ---

  # HTML

  The HTML node provides operations to help you work with HTML in n8n.

  /// note | HTML Extract node
  The HTML node replaces the HTML Extract node from version 0.213.0 on. If you're using an older version of n8n, you can still view the [HTML Extract node documentation](https://github.com/n8n-io/n8n-docs/blob/86fe33b681621e618e3adcab9a27e8605dbc23ad/docs/integrations/builtin/core-nodes/n8n-nodes-base.htmlextract.md){:target=_blank .external-link}.
  ///
  /// warning | Cross-site scripting
  When using the HTML node to generate an HTML template you can introduce [XSS (cross-site scripting)](https://owasp.org/www-community/attacks/xss/){:target=_blank .external-link}. This is a security risk. Be careful with un-trusted inputs.
  ///

  ## Operations

  * [**Generate HTML template**](#generate-html-template): Use this operation to create an HTML template. This allows you to take data from your workflow and output it as HTML.
  * [**Extract HTML content**](#extract-html-content): Extract contents from an HTML-formatted source. The source can be in JSON or a binary file (`.html`).
  * [**Convert to HTML Table**](#convert-to-html-table): Convert content to an HTML table.

  The node parameters and options depend on the operation you select. Refer to the sections below for more details on configuring each operation.

  ## Generate HTML template

  Create an HTML template. This allows you to take data from your workflow and output it as HTML. 

  You can include:

  * Standard HTML
  * CSS in `<style>` tags.
  * JavaScript in `<script>` tags. n8n doesn't execute the JavaScript.
  * Expressions, wrapped in `{{}}`.

  You can use [Expressions](/code/expressions.md) in the template, including n8n's [Built-in methods and variables](/code/builtin/overview.md). 

  ## Extract HTML Content

  Extract contents from an HTML-formatted source. The source can be in JSON or a binary file (`.html`).

  Use these parameters:

  ### Source Data

  Select the source type for your HTML content. Choose between:

  * **JSON**: If you select this source data, enter the **JSON Property**: the name of the input containing the HTML you want to extract. The property can contain a string or an array of strings.
  * **Binary**: If you select this source data, enter the **Input Binary Field**: the name of the input containing the HTML you want to extract. The property can contain a string or an array of strings.

  ### Extraction Values

  - **Key**: Enter the key to save the extracted value under.
  - **CSS Selector**: Enter the CSS selector to search for.
  - **Return Value**: Select the type of data to return. Choose from:
  	- **Attribute**: Return an attribute value like `class` from an element.
  		- If you select this option, enter the name of the **Attribute** to return the value of.
  	- **HTML**: Return the HTML that the element contains.
  	- **Text**: Return the text content of the element.
  		- If you choose this option, you can also enter a comma-separated list of selectors to skip in the **Skip Selectors**.
  	- **Value**: Return the value of an input, select, or text area.
  - **Return Array**: Choose whether to return multiple extraction values as an array (turned on) or as a single string (turned off).

  ### Extract HTML Content options

  You can also configure this operation with these options:

  * **Trim Values**: Controls whether to remove all spaces and newlines from the beginning and end of the values (turned on) or leaves them (turned off).
  * **Clean Up Text**: Controls whether to remove leading whitespaces, trailing whitespaces, and line breaks (newlines) and condense multiple consecutive whitespaces into a single space (turned on) or to leave them as-is (turned off).

  ## Convert to HTML Table

  This operation expects data from another node. It has no parameters. It includes these options:

  * **Capitalize Headers**: Controls whether to capitalize the table's headers (turned on) or not (turned off).
  * **Custom Styling**: Controls whether to use custom styling (turned on) or not (turned off).
  * **Caption**: Enter a caption to add to the table.
  * **Table Attributes**: Enter any attributes to apply to the `<table>`, such as style attributes.
  * **Header Attributes**: Enter any attributes to apply to the table's headers `<th>`.
  * **Row Attributes**: Enter any attributes to apply to the table's rows `<tr>`.
  * **Cell Attributes**: Enter any attributes to apply to the table's cells `<td>`.

  ## Templates and examples

  <!-- see https://www.notion.so/n8n/Pull-in-templates-for-the-integrations-pages-37c716837b804d30a33b47475f6e3780 -->
  [[ templatesWidget(page.title, 'html') ]]

properties_schema:
  [
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "generateHtmlTemplate",
      "options": [
        {
          "name": "Generate HTML Template",
          "value": "generateHtmlTemplate",
          "action": "Generate HTML template"
        },
        {
          "name": "Extract HTML Content",
          "value": "extractHtmlContent",
          "action": "Extract HTML Content"
        },
        {
          "name": "Convert to HTML Table",
          "value": "convertToHtmlTable",
          "action": "Convert to HTML Table"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "HTML Template",
      "name": "html",
      "type": "string",
      "default": "<!DOCTYPE html>\n\n<html>\n<head>\n  <meta charset=\"UTF-8\" />\n  <title>My HTML document</title>\n</head>\n<body>\n  <div class=\"container\">\n    <h1>This is an H1 heading</h1>\n    <h2>This is an H2 heading</h2>\n    <p>This is a paragraph</p>\n  </div>\n</body>\n</html>\n\n<style>\n.container {\n  background-color: #ffffff;\n  text-align: center;\n  padding: 16px;\n  border-radius: 8px;\n}\n\nh1 {\n  color: #ff6d5a;\n  font-size: 24px;\n  font-weight: bold;\n  padding: 8px;\n}\n\nh2 {\n  color: #909399;\n  font-size: 18px;\n  font-weight: bold;\n  padding: 8px;\n}\n</style>\n\n<script>\nconsole.log(\"Hello World!\");\n</script>",
      "description": "HTML template to render",
      "displayOptions": {
        "show": {
          "operation": [
            "generateHtmlTemplate"
          ]
        }
      },
      "typeOptions": {
        "editor": "htmlEditor"
      },
      "noDataExpression": true
    },
    {
      "displayName": "<b>Tips</b>: Type ctrl+space for completions. Use <code>{{ }}</code> for expressions and <code>&lt;style&gt;</code> tags for CSS. JS in <code>&lt;script&gt;</code> tags is included but not executed in n8n.",
      "name": "notice",
      "type": "notice",
      "default": "",
      "displayOptions": {
        "show": {
          "operation": [
            "generateHtmlTemplate"
          ]
        }
      }
    },
    {
      "displayName": "Source Data",
      "name": "sourceData",
      "type": "options",
      "default": "json",
      "description": "If HTML should be read from binary or JSON data",
      "options": [
        {
          "name": "Binary",
          "value": "binary"
        },
        {
          "name": "JSON",
          "value": "json"
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "extractHtmlContent"
          ]
        }
      }
    },
    {
      "displayName": "Input Binary Field",
      "name": "dataPropertyName",
      "type": "string",
      "default": "data",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "extractHtmlContent"
          ],
          "sourceData": [
            "binary"
          ]
        }
      }
    },
    {
      "displayName": "JSON Property",
      "name": "dataPropertyName",
      "type": "string",
      "default": "data",
      "description": "Name of the JSON property in which the HTML to extract the data from can be found. The property can either contain a string or an array of strings.",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "extractHtmlContent"
          ],
          "sourceData": [
            "json"
          ]
        }
      }
    },
    {
      "displayName": "Extraction Values",
      "name": "extractionValues",
      "type": "fixedCollection",
      "default": {},
      "options": [
        {
          "name": "values",
          "displayName": "Values",
          "values": [
            {
              "displayName": "Key",
              "name": "key",
              "type": "string",
              "default": "",
              "description": "The key under which the extracted value should be saved"
            },
            {
              "displayName": "CSS Selector",
              "name": "cssSelector",
              "type": "string",
              "default": "",
              "placeholder": ".price",
              "description": "The CSS selector to use"
            },
            {
              "displayName": "Return Value",
              "name": "returnValue",
              "type": "options",
              "options": [
                {
                  "name": "Attribute",
                  "value": "attribute",
                  "description": "Get an attribute value like \"class\" from an element"
                },
                {
                  "name": "HTML",
                  "value": "html",
                  "description": "Get the HTML the element contains"
                },
                {
                  "name": "Text",
                  "value": "text",
                  "description": "Get only the text content of the element"
                },
                {
                  "name": "Value",
                  "value": "value",
                  "description": "Get value of an input, select or textarea"
                }
              ],
              "default": "text",
              "description": "What kind of data should be returned"
            },
            {
              "displayName": "Attribute",
              "name": "attribute",
              "type": "string",
              "displayOptions": {
                "show": {
                  "returnValue": [
                    "attribute"
                  ]
                }
              },
              "default": "",
              "placeholder": "class",
              "description": "The name of the attribute to return the value off"
            },
            {
              "displayName": "Skip Selectors",
              "name": "skipSelectors",
              "type": "string",
              "displayOptions": {
                "show": {
                  "returnValue": [
                    "text"
                  ],
                  "@version": [
                    {
                      "_cnd": {
                        "gt": 1.1
                      }
                    }
                  ]
                }
              },
              "default": "",
              "placeholder": "e.g. img, .className, #ItemId",
              "description": "Comma-separated list of selectors to skip in the text extraction"
            },
            {
              "displayName": "Return Array",
              "name": "returnArray",
              "type": "boolean",
              "default": false,
              "description": "Whether to return the values as an array so if multiple ones get found they also get returned separately. If not set all will be returned as a single string."
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "extractHtmlContent"
          ],
          "@version": [
            1
          ]
        }
      },
      "typeOptions": {
        "multipleValues": true
      }
    },
    {
      "displayName": "Extraction Values",
      "name": "extractionValues",
      "type": "fixedCollection",
      "default": {
        "values": [
          {
            "key": "",
            "cssSelector": "",
            "returnValue": "text",
            "returnArray": false
          }
        ]
      },
      "options": [
        {
          "name": "values",
          "displayName": "Values",
          "values": [
            {
              "displayName": "Key",
              "name": "key",
              "type": "string",
              "default": "",
              "description": "The key under which the extracted value should be saved"
            },
            {
              "displayName": "CSS Selector",
              "name": "cssSelector",
              "type": "string",
              "default": "",
              "placeholder": ".price",
              "description": "The CSS selector to use"
            },
            {
              "displayName": "Return Value",
              "name": "returnValue",
              "type": "options",
              "options": [
                {
                  "name": "Attribute",
                  "value": "attribute",
                  "description": "Get an attribute value like \"class\" from an element"
                },
                {
                  "name": "HTML",
                  "value": "html",
                  "description": "Get the HTML the element contains"
                },
                {
                  "name": "Text",
                  "value": "text",
                  "description": "Get only the text content of the element"
                },
                {
                  "name": "Value",
                  "value": "value",
                  "description": "Get value of an input, select or textarea"
                }
              ],
              "default": "text",
              "description": "What kind of data should be returned"
            },
            {
              "displayName": "Attribute",
              "name": "attribute",
              "type": "string",
              "displayOptions": {
                "show": {
                  "returnValue": [
                    "attribute"
                  ]
                }
              },
              "default": "",
              "placeholder": "class",
              "description": "The name of the attribute to return the value off"
            },
            {
              "displayName": "Skip Selectors",
              "name": "skipSelectors",
              "type": "string",
              "displayOptions": {
                "show": {
                  "returnValue": [
                    "text"
                  ],
                  "@version": [
                    {
                      "_cnd": {
                        "gt": 1.1
                      }
                    }
                  ]
                }
              },
              "default": "",
              "placeholder": "e.g. img, .className, #ItemId",
              "description": "Comma-separated list of selectors to skip in the text extraction"
            },
            {
              "displayName": "Return Array",
              "name": "returnArray",
              "type": "boolean",
              "default": false,
              "description": "Whether to return the values as an array so if multiple ones get found they also get returned separately. If not set all will be returned as a single string."
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "extractHtmlContent"
          ],
          "@version": [
            {
              "_cnd": {
                "gt": 1
              }
            }
          ]
        }
      },
      "typeOptions": {
        "multipleValues": true
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Trim Values",
          "name": "trimValues",
          "type": "boolean",
          "default": true,
          "description": "Whether to remove automatically all spaces and newlines from the beginning and end of the values"
        },
        {
          "displayName": "Clean Up Text",
          "name": "cleanUpText",
          "type": "boolean",
          "default": true,
          "description": "Whether to remove leading and trailing whitespaces, line breaks (newlines) and condense multiple consecutive whitespaces into a single space"
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "extractHtmlContent"
          ]
        }
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Capitalize Headers",
          "name": "capitalize",
          "type": "boolean",
          "default": false,
          "description": "Whether to capitalize the headers"
        },
        {
          "displayName": "Custom Styling",
          "name": "customStyling",
          "type": "boolean",
          "default": false,
          "description": "Whether to use custom styling"
        },
        {
          "displayName": "Caption",
          "name": "caption",
          "type": "string",
          "default": "",
          "description": "Caption to add to the table"
        },
        {
          "displayName": "Table Attributes",
          "name": "tableAttributes",
          "type": "string",
          "default": "",
          "description": "Attributes to attach to the table",
          "placeholder": "e.g. style=\"padding:10px\""
        },
        {
          "displayName": "Header Attributes",
          "name": "headerAttributes",
          "type": "string",
          "default": "",
          "description": "Attributes to attach to the table header",
          "placeholder": "e.g. style=\"padding:10px\""
        },
        {
          "displayName": "Row Attributes",
          "name": "rowAttributes",
          "type": "string",
          "default": "",
          "description": "Attributes to attach to the table row",
          "placeholder": "e.g. style=\"padding:10px\""
        },
        {
          "displayName": "Cell Attributes",
          "name": "cellAttributes",
          "type": "string",
          "default": "",
          "description": "Attributes to attach to the table cell",
          "placeholder": "e.g. style=\"padding:10px\""
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "convertToHtmlTable"
          ]
        }
      }
    }
  ]

operations:
  [
    {
      "operation": "generateHtmlTemplate",
      "name": "Generate HTML Template"
    },
    {
      "operation": "extractHtmlContent",
      "name": "Extract HTML Content"
    },
    {
      "operation": "convertToHtmlTable",
      "name": "Convert to HTML Table"
    }
  ]


node_type: nodes-base.httpRequest
package_name: n8n-nodes-base
display_name: HTTP Request
description: Makes an HTTP request and returns the response data
category: output
development_style: programmatic
version: 4.4
operations: []
outputs:
  [
  "main"
  ]

updated_at: 2026-03-25 21:12:27
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: HTTP Request node documentation
  description: Learn how to use the HTTP Request node in n8n. Follow technical documentation to integrate HTTP Request node into your workflows.
  contentType: [integration, reference]
  priority: critical
  ---

  # HTTP Request node

  The HTTP Request node is one of the most versatile nodes in n8n. It allows you to make HTTP requests to query data from any app or service with a REST API. You can use the HTTP Request node a regular node or attached to an [AI agent](/integrations/builtin/cluster-nodes/root-nodes/n8n-nodes-langchain.agent/tools-agent.md) to use as a [tool](/advanced-ai/examples/understand-tools.md){ data-preview }.

  When using this node, you're creating a REST API call. You need some understanding of basic API terminology and concepts.

  There are two ways to create an HTTP request: configure the [node parameters](#node-parameters) or [import a curl command](#import-curl-command).

  /// note | Credentials
  Refer to [HTTP Request credentials](/integrations/builtin/credentials/httprequest.md) for guidance on setting up authentication. 
  ///

  ## Node parameters

  ### Method

  Select the method to use for the request:

  - DELETE
  - GET
  - HEAD
  - OPTIONS
  - PATCH
  - POST
  - PUT

  ### URL

  Enter the endpoint you want to use.

  ### Authentication

  n8n recommends using the **Predefined Credential Type** option when it's available. It offers an easier way to set up and manage credentials, compared to configuring generic credentials.

  #### Predefined credentials

  Credentials for integrations supported by n8n, including both built-in and community nodes. Use **Predefined Credential Type** for custom operations without extra setup. Refer to [Custom API operations](/integrations/custom-operations.md) for more information.

  #### Generic credentials

  Credentials for integrations not supported by n8n. You'll need to manually configure the authentication process, including specifying the required API endpoints, necessary parameters, and the authentication method. 

  You can select one of the following methods:

  * Basic auth
  * Custom auth
  * Digest auth
  * Header auth
  * OAuth1 API
  * OAuth2 API
  * Query auth

  Refer to [HTTP request credentials](/integrations/builtin/credentials/httprequest.md) for more information on setting up each credential type.

  ### Send Query Parameters

  Query parameters act as filters on HTTP requests. If the API you're interacting with supports them and the request you're making needs a filter, turn this option on.

  **Specify your query parameters** using one of the available options:

  * **Using Fields Below**: Enter **Name**/**Value** pairs of **Query Parameters**. To enter more query parameter name/value pairs, select **Add Parameter**. The name is the name of the field you're filtering on, and the value is the filter value.
  * **Using JSON**: Enter **JSON** to define your query parameters.

  Refer to your service's API documentation for detailed guidance.

  ### Send Headers

  Use this parameter to send headers with your request. Headers contain metadata or context about your request.

  **Specify Headers** using one of the available options:

  * **Using Fields Below**: Enter **Name**/**Value** pairs of **Header Parameters**. To enter more header parameter name/value pairs, select **Add Parameter**. The name is the header you wish to set, and the value is the value you want to pass for that header.
  * **Using JSON**: Enter **JSON** to define your header parameters.

  Refer to your service's API documentation for detailed guidance.

  ### Send Body

  If you need to send a body with your API request, turn this option on.

  Then select the **Body Content Type** that best matches the format for the body content you wish to send.

  <!-- vale Vale.Spelling = NO -->
  #### Form URLencoded
  <!-- vale Vale.Spelling = YES -->

  Use this option to send your body as `application/x-www-form-urlencoded`.

  **Specify Body** using one of the available options:

  * **Using Fields Below**: Enter **Name**/**Value** pairs of **Body Parameters**. To enter more body parameter name/value pairs, select **Add Parameter**. The name should be the form field name, and the value is what you wish to set that field to.
  * **Using Single Field**: Enter your name/value pairs in a single **Body** parameter with format `fieldname1=value1&fieldname2=value2`.

  Refer to your service's API documentation for detailed guidance.

  #### Form-Data

  Use this option to send your body as `multipart/form-data`.

  Configure your **Body Parameters** by selecting the **Parameter Type**:

  * Choose **Form Data** to enter **Name**/**Value** pairs.
  * Choose **n8n Binary File** to pull the body from a file the node has access to.
      * **Name**: Enter the ID of the field to set.
      * **Input Data Field Name**: Enter the name of the incoming field containing the binary file data you want to process.

  Select **Add Parameter** to enter more parameters.

  Refer to your service's API documentation for detailed guidance.

  #### JSON

  Use this option to send your body as JSON.

  **Specify Body** using one of the available options:

  * **Using Fields Below**: Enter **Name**/**Value** pairs of **Body Parameters**. To enter more body parameter name/value pairs, select **Add Parameter**.
  * **Using JSON**: Enter **JSON** to define your body.

  Refer to your service's API documentation for detailed guidance.

  #### n8n Binary File

  Use this option to send the contents of a file stored in n8n as the body.

  Enter the name of the incoming field that contains the file as the **Input Data Field Name**.

  Refer to your service's API documentation for detailed guidance on how to format the file.

  #### Raw

  Use this option to send raw data in the body.

  * **Content Type**: Enter the `Content-Type` header to use for the raw body content. Refer to the IANA [Media types](https://www.iana.org/assignments/media-types/media-types.xhtml){:target=_blank .external-link} documentation for a full list of MIME content types.
  * **Body**: Enter the raw body content to send.

  Refer to your service's API documentation for detailed guidance.

  ## Node options

  Select **Add Option** to view and select these options. Options are available to all parameters unless otherwise noted.

  ### Array Format in Query Parameters

  /// note | Option availability
  This option is only available when you turn on **Send Query Parameters**.
  ///

  Use this option to control the format for arrays included in query parameters. Choose from these options:

  * **No Brackets**: Arrays will format as the name=value for each item in the array, for example: `foo=bar&foo=qux`.
  * **Brackets Only**: The node adds square brackets after each array name, for example: `foo[]=bar&foo[]=qux`.
  * **Brackets with Indices**: The node adds square brackets with an index value after each array name, for example: `foo[0]=bar&foo[1]=qux`.

  Refer to your service's API documentation for guidance on which option to use.

  ### Batching

  Control how to batch large numbers of input items:

  * **Items per Batch**: Enter the number of input items to include in each batch.
  * **Batch Interval**: Enter the time to wait between each batch of requests in milliseconds. Enter 0 for no batch interval.

  ### Ignore SSL Issues

  By default, n8n only downloads the response if SSL certificate validation succeeds. If you'd like to download the response even if SSL certificate validation fails, turn this option on.

  ### Lowercase Headers

  Choose whether to lowercase header names (turned on, default) or not (turned off).

  ### Redirects

  Choose whether to follow redirects (turned on by default) or not (turned off). If turned on, enter the maximum number of redirects the request should follow in **Max Redirects**.

  ### Response

  Use this option to set some details about the expected API response, including:

  * **Include Response Headers and Status**: By default, the node returns only the body. Turn this option on to return the full response (headers and response status code) as well as the body.
  * **Never Error**: By default, the node returns success only when the response returns with a 2xx code. Turn this option on to return success regardless of the code returned.
  * **Response Format**: Select the format in which the data gets returned. Choose from:
      * **Autodetect** (default): The node detects and formats the response based on the data returned.
      * **File**: Select this option to put the response into a file. Enter the field name where you want the file returned in **Put Output in Field**.
      * **JSON**: Select this option to format the response as JSON.
      * **Text**: Select this option to format the response as plain text. Enter the field name where you want the file returned in **Put Output in Field**.

  ### Pagination

  Use this option to paginate results, useful for handling query results that are too big for the API to return in a single call.

  /// note | Inspect the API data first
  Some options for pagination require knowledge of the data returned by the API you're using. Before setting up pagination, either check the API documentation, or do an API call without pagination, to see the data it returns.
  ///
  ??? Details "Understand pagination"
      Pagination means splitting a large set of data into multiple pages. The amount of data on each page depends on the limit you set.
    
      For example, you make an API call to an endpoint called `/users`. The API wants to send back information on 300 users, but this is too much data for the API to send in one response. 
    
      If the API supports pagination, you can incrementally fetch the data. To do this, you call `/users` with a pagination limit, and a page number or URL to tell the API which page to send. In this example, say you use a limit of 10, and start from page 0. The API sends the first 10 users in its response. You then call the API again, increasing the page number by 1, to get the next 10 results.

  Configure the pagination settings:

  * **Pagination Mode**:
      * **Off**: Turn off pagination.
      * **Update a Parameter in Each Request**: Use this when you need to dynamically set parameters for each request.
      * **Response Contains Next URL**: Use this when the API response includes the URL of the next page. Use an expression to set **Next URL**.

  For example setups, refer to [HTTP Request node cookbook | Pagination](/code/cookbook/http-node/pagination.md).

  n8n provides built-in variables for working with HTTP node requests and responses when using pagination:

  --8<-- "_snippets/integrations/builtin/core-nodes/http/pagination-variables.md"

  --8<-- "_snippets/integrations/builtin/core-nodes/http/pagination-api-differences.md"

  ### Proxy

  Use this option if you need to specify an HTTP proxy.

  Enter the **Proxy** the request should use.

  ### Timeout

  Use this option to set how long the node should wait for the server to send response headers (and start the response body). The node aborts requests that exceed this value for the initial response.

  Enter the **Timeout** time to wait in milliseconds.

  ## Tool-only options

  The following options are only available when attached to an [AI agent](/integrations/builtin/cluster-nodes/root-nodes/n8n-nodes-langchain.agent/tools-agent.md) as a [tool](/advanced-ai/examples/understand-tools.md){ data-preview }.

  ### Optimize Response

  Whether to optimize the tool response to reduce the amount of data passed to the LLM. Optimizing the response can reduce costs and can help the LLM ignore unimportant details, often leading to better results.

  When optimizing responses, you select an expected response type, which determines other options you can configure. The supported response types are:

  #### JSON

  When expecting a **JSON** response, you can configure which parts of the JSON data to use as a response with the following choices:

  * **Field Containing Data**: This field identifies a specific part of the JSON object that contains your relevant data. You can leave this blank to use the entire response.
  * **Include Fields**: This is how you choose which fields you want in your response object. There are three choices:
  	* **All**: Include all fields in the response object.
  	* **Selected**: Include only the fields specified below.
  		* **Fields**: A comma-separated list of fields to include in the response. You can use dot notation to specify nested fields. You can drag fields from the Input panel to add them to the field list.
  	* **Exclude**: Include all fields *except* the fields specified below.
  		* **Fields**: A comma-separated list of fields to exclude from the response. You can use dot notation to specify nested fields. You can drag fields from the Input panel to add them to the field list.

  #### HTML

  When expecting **HTML**, you can identify the part of an HTML document relevant to the LLM and optimize the response with the following options:

  * **Selector (CSS)**: A specific element or element type to include in the response HTML. Uses the `body` element by default.
  * **Return Only Content**: Whether to strip HTML tags and attributes from the response, leaving only the actual content. This uses fewer tokens and may be easier for the model to understand.
  	* **Elements To Omit**: A comma-separated list of CSS selectors to exclude when extracting content.
  * **Truncate Response**: Whether to limit the response size to save tokens.
  	* **Max Response Characters**: The maximum number of characters to include in the HTML response. The default value is 1000.

  #### Text

  When expecting a generic **Text** response, you can optimize the results with the following options:

  * **Truncate Response**: Whether to limit the response size to save tokens.
  	* **Max Response Characters**: The maximum number of characters to include in the HTML response. The default value is 1000.

  ## Import curl command

  [curl](https://curl.se/){:target=_blank .external-link} is a command line tool and library for transferring data with URLs.

  You can use curl to call REST APIs. If the API documentation of the service you want to use provides curl examples, you can copy them out of the documentation and into n8n to configure the HTTP Request node.

  Import a curl command:

  1. From the HTTP Request node's **Parameters** tab, select **Import cURL**. The **Import cURL command** modal opens.
  2. Paste your curl command into the text box.
  3. Select **Import**. n8n loads the request configuration into the node fields. This overwrites any existing configuration.

  ## Templates and examples

  <!-- see https://www.notion.so/n8n/Pull-in-templates-for-the-integrations-pages-37c716837b804d30a33b47475f6e3780 -->
  [[ templatesWidget(page.title, 'http-request') ]]

  ## Common issues

  For common questions or issues and suggested solutions, refer to [Common Issues](/integrations/builtin/core-nodes/n8n-nodes-base.httprequest/common-issues.md).

properties_schema:
  [
    {
      "displayName": "",
      "name": "curlImport",
      "type": "curlImport",
      "default": ""
    },
    {
      "displayName": "Method",
      "name": "method",
      "type": "options",
      "default": "GET",
      "description": "The request method to use",
      "options": [
        {
          "name": "DELETE",
          "value": "DELETE"
        },
        {
          "name": "GET",
          "value": "GET"
        },
        {
          "name": "HEAD",
          "value": "HEAD"
        },
        {
          "name": "OPTIONS",
          "value": "OPTIONS"
        },
        {
          "name": "PATCH",
          "value": "PATCH"
        },
        {
          "name": "POST",
          "value": "POST"
        },
        {
          "name": "PUT",
          "value": "PUT"
        }
      ]
    },
    {
      "displayName": "URL",
      "name": "url",
      "type": "string",
      "default": "",
      "description": "The URL to make the request to",
      "required": true
    },
    {
      "displayName": "Authentication",
      "name": "authentication",
      "type": "options",
      "default": "none",
      "options": [
        {
          "name": "None",
          "value": "none"
        },
        {
          "name": "Predefined Credential Type",
          "value": "predefinedCredentialType",
          "description": "We've already implemented auth for many services so that you don't have to set it up manually"
        },
        {
          "name": "Generic Credential Type",
          "value": "genericCredentialType",
          "description": "Fully customizable. Choose between basic, header, OAuth2, etc."
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "Credential Type",
      "name": "nodeCredentialType",
      "type": "credentialsSelect",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "authentication": [
            "predefinedCredentialType"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Make sure you have specified the scope(s) for the Service Account in the credential",
      "name": "googleApiWarning",
      "type": "notice",
      "default": "",
      "displayOptions": {
        "show": {
          "nodeCredentialType": [
            "googleApi"
          ]
        }
      }
    },
    {
      "displayName": "Generic Auth Type",
      "name": "genericAuthType",
      "type": "credentialsSelect",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "authentication": [
            "genericCredentialType"
          ]
        }
      }
    },
    {
      "displayName": "SSL Certificates",
      "name": "provideSslCertificates",
      "type": "boolean",
      "default": false
    },
    {
      "displayName": "Provide certificates in node's 'Credential for SSL Certificates' parameter",
      "name": "provideSslCertificatesNotice",
      "type": "notice",
      "default": "",
      "displayOptions": {
        "show": {
          "provideSslCertificates": [
            true
          ]
        }
      }
    },
    {
      "displayName": "SSL Certificate",
      "name": "sslCertificate",
      "type": "credentials",
      "default": "",
      "displayOptions": {
        "show": {
          "provideSslCertificates": [
            true
          ]
        }
      }
    },
    {
      "displayName": "Send Query Parameters",
      "name": "sendQuery",
      "type": "boolean",
      "default": false,
      "description": "Whether the request has query params or not",
      "noDataExpression": true
    },
    {
      "displayName": "Specify Query Parameters",
      "name": "specifyQuery",
      "type": "options",
      "default": "keypair",
      "options": [
        {
          "name": "Using Fields Below",
          "value": "keypair"
        },
        {
          "name": "Using JSON",
          "value": "json"
        }
      ],
      "displayOptions": {
        "show": {
          "sendQuery": [
            true
          ]
        }
      }
    },
    {
      "displayName": "Query Parameters",
      "name": "queryParameters",
      "type": "fixedCollection",
      "default": {
        "parameters": [
          {
            "name": "",
            "value": ""
          }
        ]
      },
      "options": [
        {
          "name": "parameters",
          "displayName": "Query Parameter",
          "builderHint": {
            "message": "NEVER put static authentication values (API keys, tokens, PATs) in queryParameters. It's insecure to store credentials directly in parameters. Instead set authentication to \"genericCredentialType\", genericAuthType to \"httpQueryAuth\", and add credentials: { httpQueryAuth:\n newCredential(\"Name\") }. Only use queryParameters for non-auth values. Dynamic values from previous nodes via expr() are acceptable."
          },
          "values": [
            {
              "displayName": "Name",
              "name": "name",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "Value",
              "name": "value",
              "type": "string",
              "default": ""
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "sendQuery": [
            true
          ],
          "specifyQuery": [
            "keypair"
          ]
        }
      },
      "typeOptions": {
        "multipleValues": true,
        "fixedCollection": {
          "itemTitle": "={{ $collection.item.value.name }}"
        }
      }
    },
    {
      "displayName": "JSON",
      "name": "jsonQuery",
      "type": "json",
      "default": "",
      "displayOptions": {
        "show": {
          "sendQuery": [
            true
          ],
          "specifyQuery": [
            "json"
          ]
        }
      }
    },
    {
      "displayName": "Send Headers",
      "name": "sendHeaders",
      "type": "boolean",
      "default": false,
      "description": "Whether the request has headers or not",
      "noDataExpression": true
    },
    {
      "displayName": "Specify Headers",
      "name": "specifyHeaders",
      "type": "options",
      "default": "keypair",
      "options": [
        {
          "name": "Using Fields Below",
          "value": "keypair"
        },
        {
          "name": "Using JSON",
          "value": "json"
        }
      ],
      "displayOptions": {
        "show": {
          "sendHeaders": [
            true
          ]
        }
      }
    },
    {
      "displayName": "Headers",
      "name": "headerParameters",
      "type": "fixedCollection",
      "default": {
        "parameters": [
          {
            "name": "",
            "value": ""
          }
        ]
      },
      "options": [
        {
          "name": "parameters",
          "displayName": "Header",
          "builderHint": {
            "message": "NEVER put static authentication values (API keys, tokens, PATs) in headerParameters. It's insecure to store credentials directly in parameters. Instead set authentication to \"genericCredentialType\", genericAuthType to \"httpHeaderAuth\", and add credentials: { httpHeaderAuth:\n newCredential(\"Name\") }. Only use headerParameters for non-auth headers like Content-Type or Accept. Dynamic values from previous nodes via expr() are acceptable."
          },
          "values": [
            {
              "displayName": "Name",
              "name": "name",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "Value",
              "name": "value",
              "type": "string",
              "default": ""
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "sendHeaders": [
            true
          ],
          "specifyHeaders": [
            "keypair"
          ]
        }
      },
      "typeOptions": {
        "multipleValues": true,
        "fixedCollection": {
          "itemTitle": "={{ $collection.item.value.name }}"
        }
      }
    },
    {
      "displayName": "JSON",
      "name": "jsonHeaders",
      "type": "json",
      "default": "",
      "displayOptions": {
        "show": {
          "sendHeaders": [
            true
          ],
          "specifyHeaders": [
            "json"
          ]
        }
      }
    },
    {
      "displayName": "Send Body",
      "name": "sendBody",
      "type": "boolean",
      "default": false,
      "description": "Whether the request has a body or not",
      "noDataExpression": true
    },
    {
      "displayName": "Body Content Type",
      "name": "contentType",
      "type": "options",
      "default": "json",
      "description": "Content-Type to use to send body parameters",
      "options": [
        {
          "name": "Form Urlencoded",
          "value": "form-urlencoded"
        },
        {
          "name": "Form-Data",
          "value": "multipart-form-data"
        },
        {
          "name": "JSON",
          "value": "json"
        },
        {
          "name": "n8n Binary File",
          "value": "binaryData"
        },
        {
          "name": "Raw",
          "value": "raw"
        }
      ],
      "displayOptions": {
        "show": {
          "sendBody": [
            true
          ]
        }
      }
    },
    {
      "displayName": "Specify Body",
      "name": "specifyBody",
      "type": "options",
      "default": "keypair",
      "description": "The body can be specified using explicit fields (<code>keypair</code>) or using a JavaScript object (<code>json</code>)",
      "options": [
        {
          "name": "Using Fields Below",
          "value": "keypair"
        },
        {
          "name": "Using JSON",
          "value": "json"
        }
      ],
      "displayOptions": {
        "show": {
          "sendBody": [
            true
          ],
          "contentType": [
            "json"
          ]
        }
      }
    },
    {
      "displayName": "Body Parameters",
      "name": "bodyParameters",
      "type": "fixedCollection",
      "default": {
        "parameters": [
          {
            "name": "",
            "value": ""
          }
        ]
      },
      "options": [
        {
          "name": "parameters",
          "displayName": "Body Field",
          "values": [
            {
              "displayName": "Name",
              "name": "name",
              "type": "string",
              "default": "",
              "description": "ID of the field to set. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
            },
            {
              "displayName": "Value",
              "name": "value",
              "type": "string",
              "default": "",
              "description": "Value of the field to set"
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "sendBody": [
            true
          ],
          "contentType": [
            "json"
          ],
          "specifyBody": [
            "keypair"
          ]
        }
      },
      "typeOptions": {
        "multipleValues": true,
        "fixedCollection": {
          "itemTitle": "={{ $collection.item.value.name }}"
        }
      }
    },
    {
      "displayName": "JSON",
      "name": "jsonBody",
      "type": "json",
      "default": "",
      "displayOptions": {
        "show": {
          "sendBody": [
            true
          ],
          "contentType": [
            "json"
          ],
          "specifyBody": [
            "json"
          ]
        }
      }
    },
    {
      "displayName": "Body",
      "name": "bodyParameters",
      "type": "fixedCollection",
      "default": {
        "parameters": [
          {
            "name": "",
            "value": ""
          }
        ]
      },
      "options": [
        {
          "name": "parameters",
          "displayName": "Body Field",
          "values": [
            {
              "displayName": "Type",
              "name": "parameterType",
              "type": "options",
              "options": [
                {
                  "name": "n8n Binary File",
                  "value": "formBinaryData"
                },
                {
                  "name": "Form Data",
                  "value": "formData"
                }
              ],
              "default": "formData"
            },
            {
              "displayName": "Name",
              "name": "name",
              "type": "string",
              "default": "",
              "description": "ID of the field to set. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
            },
            {
              "displayName": "Value",
              "name": "value",
              "type": "string",
              "displayOptions": {
                "show": {
                  "parameterType": [
                    "formData"
                  ]
                }
              },
              "default": "",
              "description": "Value of the field to set"
            },
            {
              "displayName": "Input Data Field Name",
              "name": "inputDataFieldName",
              "type": "string",
              "displayOptions": {
                "show": {
                  "parameterType": [
                    "formBinaryData"
                  ]
                }
              },
              "default": "",
              "description": "The name of the incoming field containing the binary file data to be processed"
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "sendBody": [
            true
          ],
          "contentType": [
            "multipart-form-data"
          ]
        }
      },
      "typeOptions": {
        "multipleValues": true,
        "fixedCollection": {
          "itemTitle": "={{ $collection.item.value.name }}"
        }
      }
    },
    {
      "displayName": "Specify Body",
      "name": "specifyBody",
      "type": "options",
      "default": "keypair",
      "options": [
        {
          "name": "Using Fields Below",
          "value": "keypair"
        },
        {
          "name": "Using Single Field",
          "value": "string"
        }
      ],
      "displayOptions": {
        "show": {
          "sendBody": [
            true
          ],
          "contentType": [
            "form-urlencoded"
          ]
        }
      }
    },
    {
      "displayName": "Body Fields",
      "name": "bodyParameters",
      "type": "fixedCollection",
      "default": {
        "parameters": [
          {
            "name": "",
            "value": ""
          }
        ]
      },
      "options": [
        {
          "name": "parameters",
          "displayName": "Field",
          "values": [
            {
              "displayName": "Name",
              "name": "name",
              "type": "string",
              "default": "",
              "description": "ID of the field to set. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
            },
            {
              "displayName": "Value",
              "name": "value",
              "type": "string",
              "default": "",
              "description": "Value of the field to set"
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "sendBody": [
            true
          ],
          "contentType": [
            "form-urlencoded"
          ],
          "specifyBody": [
            "keypair"
          ]
        }
      },
      "typeOptions": {
        "multipleValues": true,
        "fixedCollection": {
          "itemTitle": "={{ $collection.item.value.name }}"
        }
      }
    },
    {
      "displayName": "Body",
      "name": "body",
      "type": "string",
      "default": "",
      "displayOptions": {
        "show": {
          "sendBody": [
            true
          ],
          "specifyBody": [
            "string"
          ]
        }
      }
    },
    {
      "displayName": "Input Data Field Name",
      "name": "inputDataFieldName",
      "type": "string",
      "default": "",
      "description": "The name of the incoming field containing the binary file data to be processed",
      "displayOptions": {
        "show": {
          "sendBody": [
            true
          ],
          "contentType": [
            "binaryData"
          ]
        }
      }
    },
    {
      "displayName": "Content Type",
      "name": "rawContentType",
      "type": "string",
      "default": "",
      "displayOptions": {
        "show": {
          "sendBody": [
            true
          ],
          "contentType": [
            "raw"
          ]
        }
      }
    },
    {
      "displayName": "Body",
      "name": "body",
      "type": "string",
      "default": "",
      "displayOptions": {
        "show": {
          "sendBody": [
            true
          ],
          "contentType": [
            "raw"
          ]
        }
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Batching",
          "name": "batching",
          "placeholder": "Add Batching",
          "type": "fixedCollection",
          "typeOptions": {
            "multipleValues": false
          },
          "default": {
            "batch": {}
          },
          "options": [
            {
              "displayName": "Batching",
              "name": "batch",
              "values": [
                {
                  "displayName": "Items per Batch",
                  "name": "batchSize",
                  "type": "number",
                  "typeOptions": {
                    "minValue": -1
                  },
                  "default": 50,
                  "description": "Input will be split in batches to throttle requests. -1 for disabled. 0 will be treated as 1."
                },
                {
                  "displayName": "Batch Interval (ms)",
                  "name": "batchInterval",
                  "type": "number",
                  "typeOptions": {
                    "minValue": 0
                  },
                  "default": 1000,
                  "description": "Time (in milliseconds) between each batch of requests. 0 for disabled."
                }
              ]
            }
          ]
        },
        {
          "displayName": "Ignore SSL Issues (Insecure)",
          "name": "allowUnauthorizedCerts",
          "type": "boolean",
          "noDataExpression": true,
          "default": false,
          "description": "Whether to download the response even if SSL certificate validation is not possible"
        },
        {
          "displayName": "Array Format in Query Parameters",
          "name": "queryParameterArrays",
          "type": "options",
          "displayOptions": {
            "show": {
              "/sendQuery": [
                true
              ]
            }
          },
          "options": [
            {
              "name": "No Brackets",
              "value": "repeat",
              "description": "e.g. foo=bar&foo=qux"
            },
            {
              "name": "Brackets Only",
              "value": "brackets",
              "description": "e.g. foo[]=bar&foo[]=qux"
            },
            {
              "name": "Brackets with Indices",
              "value": "indices",
              "description": "e.g. foo[0]=bar&foo[1]=qux"
            }
          ],
          "default": "brackets"
        },
        {
          "displayName": "Lowercase Headers",
          "name": "lowercaseHeaders",
          "type": "boolean",
          "default": true,
          "description": "Whether to lowercase header names"
        },
        {
          "displayName": "Redirects",
          "name": "redirect",
          "placeholder": "Add Redirect",
          "type": "fixedCollection",
          "typeOptions": {
            "multipleValues": false
          },
          "default": {
            "redirect": {}
          },
          "options": [
            {
              "displayName": "Redirect",
              "name": "redirect",
              "values": [
                {
                  "displayName": "Follow Redirects",
                  "name": "followRedirects",
                  "type": "boolean",
                  "default": false,
                  "noDataExpression": true,
                  "description": "Whether to follow all redirects"
                },
                {
                  "displayName": "Max Redirects",
                  "name": "maxRedirects",
                  "type": "number",
                  "displayOptions": {
                    "show": {
                      "followRedirects": [
                        true
                      ]
                    }
                  },
                  "default": 21,
                  "description": "Max number of redirects to follow"
                }
              ]
            }
          ],
          "displayOptions": {
            "show": {
              "@version": [
                1,
                2,
                3
              ]
            }
          }
        },
        {
          "displayName": "Redirects",
          "name": "redirect",
          "placeholder": "Add Redirect",
          "type": "fixedCollection",
          "typeOptions": {
            "multipleValues": false
          },
          "default": {
            "redirect": {}
          },
          "options": [
            {
              "displayName": "Redirect",
              "name": "redirect",
              "values": [
                {
                  "displayName": "Follow Redirects",
                  "name": "followRedirects",
                  "type": "boolean",
                  "default": true,
                  "noDataExpression": true,
                  "description": "Whether to follow all redirects"
                },
                {
                  "displayName": "Max Redirects",
                  "name": "maxRedirects",
                  "type": "number",
                  "displayOptions": {
                    "show": {
                      "followRedirects": [
                        true
                      ]
                    }
                  },
                  "default": 21,
                  "description": "Max number of redirects to follow"
                }
              ]
            }
          ],
          "displayOptions": {
            "hide": {
              "@version": [
                1,
                2,
                3
              ]
            }
          }
        },
        {
          "displayName": "Response",
          "name": "response",
          "placeholder": "Add response",
          "type": "fixedCollection",
          "typeOptions": {
            "multipleValues": false
          },
          "default": {
            "response": {}
          },
          "options": [
            {
              "displayName": "Response",
              "name": "response",
              "values": [
                {
                  "displayName": "Include Response Headers and Status",
                  "name": "fullResponse",
                  "type": "boolean",
                  "default": false,
                  "description": "Whether to return the full response (headers and response status code) data instead of only the body"
                },
                {
                  "displayName": "Never Error",
                  "name": "neverError",
                  "type": "boolean",
                  "default": false,
                  "description": "Whether to succeeds also when status code is not 2xx"
                },
                {
                  "displayName": "Response Format",
                  "name": "responseFormat",
                  "type": "options",
                  "noDataExpression": true,
                  "options": [
                    {
                      "name": "Autodetect",
                      "value": "autodetect"
                    },
                    {
                      "name": "File",
                      "value": "file"
                    },
                    {
                      "name": "JSON",
                      "value": "json"
                    },
                    {
                      "name": "Text",
                      "value": "text"
                    }
                  ],
                  "default": "autodetect",
                  "description": "The format in which the data gets returned from the URL"
                },
                {
                  "displayName": "Put Output in Field",
                  "name": "outputPropertyName",
                  "type": "string",
                  "default": "data",
                  "required": true,
                  "displayOptions": {
                    "show": {
                      "responseFormat": [
                        "file",
                        "text"
                      ]
                    }
                  },
                  "description": "Name of the binary property to which to write the data of the read file"
                }
              ]
            }
          ]
        },
        {
          "displayName": "Pagination",
          "name": "pagination",
          "placeholder": "Add pagination",
          "type": "fixedCollection",
          "typeOptions": {
            "multipleValues": false
          },
          "default": {
            "pagination": {}
          },
          "options": [
            {
              "displayName": "Pagination",
              "name": "pagination",
              "values": [
                {
                  "displayName": "Pagination Mode",
                  "name": "paginationMode",
                  "type": "options",
                  "typeOptions": {
                    "noDataExpression": true
                  },
                  "options": [
                    {
                      "name": "Off",
                      "value": "off"
                    },
                    {
                      "name": "Update a Parameter in Each Request",
                      "value": "updateAParameterInEachRequest"
                    },
                    {
                      "name": "Response Contains Next URL",
                      "value": "responseContainsNextURL"
                    }
                  ],
                  "default": "updateAParameterInEachRequest",
                  "description": "If pagination should be used"
                },
                {
                  "displayName": "Use the $response variables to access the data of the previous response. Refer to the <a href=\"https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.httprequest/#pagination/?utm_source=n8n_app&utm_medium=node_settings_modal-credential_link&utm_campaign=n8n-nodes-base.httprequest\" target=\"_blank\">docs</a> for more info about pagination/",
                  "name": "webhookNotice",
                  "displayOptions": {
                    "hide": {
                      "paginationMode": [
                        "off"
                      ]
                    }
                  },
                  "type": "notice",
                  "default": ""
                },
                {
                  "displayName": "Next URL",
                  "name": "nextURL",
                  "type": "string",
                  "displayOptions": {
                    "show": {
                      "paginationMode": [
                        "responseContainsNextURL"
                      ]
                    }
                  },
                  "default": "",
                  "description": "Should evaluate to the URL of the next page. <a href=\"https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.httprequest/#pagination\" target=\"_blank\">More info</a>."
                },
                {
                  "displayName": "Parameters",
                  "name": "parameters",
                  "type": "fixedCollection",
                  "displayOptions": {
                    "show": {
                      "paginationMode": [
                        "updateAParameterInEachRequest"
                      ]
                    }
                  },
                  "typeOptions": {
                    "multipleValues": true,
                    "noExpression": true,
                    "fixedCollection": {
                      "itemTitle": "={{ (() => { const name = $collection.item.value.name; if (!name) return \"\"; const typeName = $collection.item.properties.find(p => p.name === \"type\").options.find(o => o.value === $collection.item.value.type).name; return typeName + \": \" + name; })() }}"
                    }
                  },
                  "placeholder": "Add Parameter",
                  "default": {
                    "parameters": [
                      {
                        "type": "qs",
                        "name": "",
                        "value": ""
                      }
                    ]
                  },
                  "options": [
                    {
                      "name": "parameters",
                      "displayName": "Parameter",
                      "values": [
                        {
                          "displayName": "Type",
                          "name": "type",
                          "type": "options",
                          "options": [
                            {
                              "name": "Body",
                              "value": "body"
                            },
                            {
                              "name": "Header",
                              "value": "headers"
                            },
                            {
                              "name": "Query",
                              "value": "qs"
                            }
                          ],
                          "default": "qs",
                          "description": "Where the parameter should be set"
                        },
                        {
                          "displayName": "Name",
                          "name": "name",
                          "type": "string",
                          "default": "",
                          "placeholder": "e.g page"
                        },
                        {
                          "displayName": "Value",
                          "name": "value",
                          "type": "string",
                          "default": "",
                          "hint": "Use expression mode and $response to access response data"
                        }
                      ]
                    }
                  ]
                },
                {
                  "displayName": "Pagination Complete When",
                  "name": "paginationCompleteWhen",
                  "type": "options",
                  "typeOptions": {
                    "noDataExpression": true
                  },
                  "displayOptions": {
                    "hide": {
                      "paginationMode": [
                        "off"
                      ]
                    }
                  },
                  "options": [
                    {
                      "name": "Response Is Empty",
                      "value": "responseIsEmpty"
                    },
                    {
                      "name": "Receive Specific Status Code(s)",
                      "value": "receiveSpecificStatusCodes"
                    },
                    {
                      "name": "Other",
                      "value": "other"
                    }
                  ],
                  "default": "responseIsEmpty",
                  "description": "When should no further requests be made?"
                },
                {
                  "displayName": "Status Code(s) when Complete",
                  "name": "statusCodesWhenComplete",
                  "type": "string",
                  "typeOptions": {
                    "noDataExpression": true
                  },
                  "displayOptions": {
                    "show": {
                      "paginationCompleteWhen": [
                        "receiveSpecificStatusCodes"
                      ]
                    }
                  },
                  "default": "",
                  "description": "Accepts comma-separated values"
                },
                {
                  "displayName": "Complete Expression",
                  "name": "completeExpression",
                  "type": "string",
                  "displayOptions": {
                    "show": {
                      "paginationCompleteWhen": [
                        "other"
                      ]
                    }
                  },
                  "default": "",
                  "description": "Should evaluate to true when pagination is complete. <a href=\"https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.httprequest/#pagination\" target=\"_blank\">More info</a>."
                },
                {
                  "displayName": "Limit Pages Fetched",
                  "name": "limitPagesFetched",
                  "type": "boolean",
                  "typeOptions": {
                    "noDataExpression": true
                  },
                  "displayOptions": {
                    "hide": {
                      "paginationMode": [
                        "off"
                      ]
                    }
                  },
                  "default": false,
                  "noDataExpression": true,
                  "description": "Whether the number of requests should be limited"
                },
                {
                  "displayName": "Max Pages",
                  "name": "maxRequests",
                  "type": "number",
                  "typeOptions": {
                    "noDataExpression": true
                  },
                  "displayOptions": {
                    "show": {
                      "limitPagesFetched": [
                        true
                      ]
                    }
                  },
                  "default": 100,
                  "description": "Maximum amount of request to be make"
                },
                {
                  "displayName": "Interval Between Requests (ms)",
                  "name": "requestInterval",
                  "type": "number",
                  "displayOptions": {
                    "hide": {
                      "paginationMode": [
                        "off"
                      ]
                    }
                  },
                  "default": 0,
                  "description": "Time in milliseconds to wait between requests",
                  "hint": "At 0 no delay will be added",
                  "typeOptions": {
                    "minValue": 0
                  }
                }
              ]
            }
          ]
        },
        {
          "displayName": "Proxy",
          "name": "proxy",
          "type": "string",
          "default": "",
          "placeholder": "e.g. http://myproxy:3128",
          "description": "HTTP proxy to use"
        },
        {
          "displayName": "Timeout",
          "name": "timeout",
          "type": "number",
          "typeOptions": {
            "minValue": 1
          },
          "default": 10000,
          "description": "Time in ms to wait for the server to send response headers (and start the response body) before aborting the request"
        },
        {
          "displayName": "Send Credentials on Cross-Origin Redirect",
          "name": "sendCredentialsOnCrossOriginRedirect",
          "type": "boolean",
          "default": false,
          "description": "Whether to send credentials, like the \"Authorization\" header, on redirects to a different origin"
        }
      ]
    },
    {
      "displayName": "Optimize Response",
      "name": "optimizeResponse",
      "type": "boolean",
      "default": false,
      "description": "Whether the optimize the tool response to reduce amount of data passed to the LLM that could lead to better result and reduce cost",
      "displayOptions": {
        "show": {
          "@tool": [
            true
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Expected Response Type",
      "name": "responseType",
      "type": "options",
      "default": "json",
      "options": [
        {
          "name": "JSON",
          "value": "json"
        },
        {
          "name": "HTML",
          "value": "html"
        },
        {
          "name": "Text",
          "value": "text"
        }
      ],
      "displayOptions": {
        "show": {
          "optimizeResponse": [
            true
          ],
          "@tool": [
            true
          ]
        }
      }
    },
    {
      "displayName": "Field Containing Data",
      "name": "dataField",
      "type": "string",
      "default": "",
      "description": "Specify the name of the field in the response containing the data",
      "displayOptions": {
        "show": {
          "optimizeResponse": [
            true
          ],
          "responseType": [
            "json"
          ],
          "@tool": [
            true
          ]
        }
      }
    },
    {
      "displayName": "Include Fields",
      "name": "fieldsToInclude",
      "type": "options",
      "default": "all",
      "description": "What fields response object should include",
      "options": [
        {
          "name": "All",
          "value": "all",
          "description": "Include all fields"
        },
        {
          "name": "Selected",
          "value": "selected",
          "description": "Include only fields specified below"
        },
        {
          "name": "Except",
          "value": "except",
          "description": "Exclude fields specified below"
        }
      ],
      "displayOptions": {
        "show": {
          "optimizeResponse": [
            true
          ],
          "responseType": [
            "json"
          ],
          "@tool": [
            true
          ]
        }
      }
    },
    {
      "displayName": "Fields",
      "name": "fields",
      "type": "string",
      "default": "",
      "description": "Comma-separated list of the field names. Supports dot notation. You can drag the selected fields from the input panel.",
      "displayOptions": {
        "show": {
          "optimizeResponse": [
            true
          ],
          "responseType": [
            "json"
          ],
          "@tool": [
            true
          ]
        },
        "hide": {
          "fieldsToInclude": [
            "all"
          ]
        }
      }
    },
    {
      "displayName": "Selector (CSS)",
      "name": "cssSelector",
      "type": "string",
      "default": "body",
      "description": "Select specific element(e.g. body) or multiple elements(e.g. div) of chosen type in the response HTML.",
      "displayOptions": {
        "show": {
          "optimizeResponse": [
            true
          ],
          "responseType": [
            "html"
          ],
          "@tool": [
            true
          ]
        }
      }
    },
    {
      "displayName": "Return Only Content",
      "name": "onlyContent",
      "type": "boolean",
      "default": false,
      "description": "Whether to return only content of html elements, stripping html tags and attributes",
      "displayOptions": {
        "show": {
          "optimizeResponse": [
            true
          ],
          "responseType": [
            "html"
          ],
          "@tool": [
            true
          ]
        }
      }
    },
    {
      "displayName": "Elements To Omit",
      "name": "elementsToOmit",
      "type": "string",
      "default": "",
      "description": "Comma-separated list of selectors that would be excluded when extracting content",
      "displayOptions": {
        "show": {
          "optimizeResponse": [
            true
          ],
          "responseType": [
            "html"
          ],
          "onlyContent": [
            true
          ],
          "@tool": [
            true
          ]
        }
      }
    },
    {
      "displayName": "Truncate Response",
      "name": "truncateResponse",
      "type": "boolean",
      "default": false,
      "displayOptions": {
        "show": {
          "optimizeResponse": [
            true
          ],
          "responseType": [
            "text",
            "html"
          ],
          "@tool": [
            true
          ]
        }
      }
    },
    {
      "displayName": "Max Response Characters",
      "name": "maxLength",
      "type": "number",
      "default": 1000,
      "displayOptions": {
        "show": {
          "optimizeResponse": [
            true
          ],
          "responseType": [
            "text",
            "html"
          ],
          "truncateResponse": [
            true
          ],
          "@tool": [
            true
          ]
        }
      },
      "typeOptions": {
        "minValue": 1
      }
    },
    {
      "displayName": "You can view the raw requests this node makes in your browser's developer console",
      "name": "infoMessage",
      "type": "notice",
      "default": ""
    }
  ]

credentials_required:
  [
    {
      "name": "httpSslAuth",
      "required": true,
      "displayOptions": {
        "show": {
          "provideSslCertificates": [
            true
          ]
        }
      }
    }
  ]


node_type: nodes-base.hubspot
package_name: n8n-nodes-base
display_name: HubSpot
description: Consume HubSpot API
category: output
development_style: programmatic
version: 2.2
outputs:
  [
  "main"
  ]

updated_at: 2026-03-25 21:12:27
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: HubSpot node documentation
  description: Learn how to use the HubSpot node in n8n. Follow technical documentation to integrate HubSpot node into your workflows.
  contentType: [integration, reference]
  priority: medium
  ---

  # HubSpot node

  Use the HubSpot node to automate work in HubSpot, and integrate HubSpot with other applications. n8n has built-in support for a wide range of HubSpot features, including creating, updating, deleting, and getting contacts, deals, lists, engagements and companies. 

  On this page, you'll find a list of operations the HubSpot node supports and links to more resources.

  /// note | Credentials
  Refer to [HubSpot credentials](/integrations/builtin/credentials/hubspot.md) for guidance on setting up authentication. 
  ///

  --8<-- "_snippets/integrations/builtin/app-nodes/ai-tools.md"

  ## Operations

  * Contact
      * Create/Update a contact
      * Delete a contact
      * Get a contact
      * Get all contacts
      * Get recently created/updated contacts
      * Search contacts
  * Contact List
      * Add contact to a list
      * Remove a contact from a list
  * Company
      * Create a company
      * Delete a company
      * Get a company
      * Get all companies
      * Get recently created companies
      * Get recently modified companies
      * Search companies by domain
      * Update a company
  * Deal
      * Create a deal
      * Delete a deal
      * Get a deal
      * Get all deals
      * Get recently created deals
      * Get recently modified deals
      * Search deals
      * Update a deal
  * Engagement
      * Create an engagement
      * Delete an engagement
      * Get an engagement
      * Get all engagements
  * Form
      * Get all fields from a form
      * Submit data to a form
  * Ticket
      * Create a ticket
      * Delete a ticket
      * Get a ticket
      * Get all tickets
      * Update a ticket

  ## Templates and examples

  <!-- see https://www.notion.so/n8n/Pull-in-templates-for-the-integrations-pages-37c716837b804d30a33b47475f6e3780 -->
  [[ templatesWidget(page.title, 'hubspot') ]]

  --8<-- "_snippets/integrations/builtin/app-nodes/operation-not-supported.md"

properties_schema:
  [
    {
      "displayName": "Authentication",
      "name": "authentication",
      "type": "options",
      "default": "apiKey",
      "options": [
        {
          "name": "API Key",
          "value": "apiKey"
        },
        {
          "name": "APP Token",
          "value": "appToken"
        },
        {
          "name": "OAuth2",
          "value": "oAuth2"
        }
      ]
    },
    {
      "displayName": "Resource",
      "name": "resource",
      "type": "options",
      "default": "contact",
      "options": [
        {
          "name": "Company",
          "value": "company"
        },
        {
          "name": "Contact",
          "value": "contact"
        },
        {
          "name": "Contact List",
          "value": "contactList"
        },
        {
          "name": "Deal",
          "value": "deal"
        },
        {
          "name": "Engagement",
          "value": "engagement"
        },
        {
          "name": "Ticket",
          "value": "ticket"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "upsert",
      "options": [
        {
          "name": "Create or Update",
          "value": "upsert",
          "description": "Create a new contact, or update the current one if it already exists (upsert)",
          "action": "Create or update a contact"
        },
        {
          "name": "Delete",
          "value": "delete",
          "description": "Delete a contact",
          "action": "Delete a contact"
        },
        {
          "name": "Get",
          "value": "get",
          "description": "Get a contact",
          "action": "Get a contact"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get many contacts",
          "action": "Get many contacts"
        },
        {
          "name": "Get Recently Created/Updated",
          "value": "getRecentlyCreatedUpdated",
          "description": "Get recently created/updated contacts",
          "action": "Get recently created/updated contacts"
        },
        {
          "name": "Search",
          "value": "search",
          "description": "Search contacts",
          "action": "Search contacts"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "contact"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Email",
      "name": "email",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "contact"
          ],
          "operation": [
            "upsert"
          ]
        }
      }
    },
    {
      "displayName": "Contact Properties",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Annual Revenue",
          "name": "annualRevenue",
          "type": "number",
          "typeOptions": {
            "minValue": 0
          },
          "default": 0
        },
        {
          "displayName": "Associated Company Name or ID",
          "name": "associatedCompanyId",
          "type": "options",
          "typeOptions": {
            "loadOptionsMethod": "getCompanies"
          },
          "default": "",
          "description": "Companies associated with the ticket. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        },
        {
          "displayName": "Buying Role",
          "name": "buyingRole",
          "description": "Role the contact plays during the sales process. Contacts can have multiple roles, and can share roles with others.",
          "type": "multiOptions",
          "default": [],
          "options": [
            {
              "name": "Blocker",
              "value": "BLOCKER"
            },
            {
              "name": "Budget Holder",
              "value": "BUDGET_HOLDER"
            },
            {
              "name": "Champion",
              "value": "CHAMPION"
            },
            {
              "name": "Decision Maker",
              "value": "DECISION_MAKER"
            },
            {
              "name": "End User",
              "value": "END_USER"
            },
            {
              "name": "Executive Sponsor",
              "value": "EXECUTIVE_SPONSOR"
            },
            {
              "name": "Influencer",
              "value": "INFLUENCER"
            },
            {
              "name": "Legal & Compliance",
              "value": "LEGAL_AND_COMPLIANCE"
            },
            {
              "name": "Other",
              "value": "OTHER"
            }
          ]
        },
        {
          "displayName": "City",
          "name": "city",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Clicked Facebook Ad",
          "name": "clickedFacebookAd",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Close Date",
          "name": "closeDate",
          "type": "dateTime",
          "default": "",
          "description": "When using expressions, the time should be specified in YYYY-MM-DD hh-mm-ss format"
        },
        {
          "displayName": "Company Name",
          "name": "companyName",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Company Size",
          "name": "companySize",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Contact Owner Name or ID",
          "name": "contactOwner",
          "type": "options",
          "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
          "typeOptions": {
            "loadOptionsMethod": "getOwners"
          },
          "default": ""
        },
        {
          "displayName": "Contact Properties to Include",
          "name": "properties",
          "type": "multiOptions",
          "typeOptions": {
            "loadOptionsMethod": "getContactProperties"
          },
          "displayOptions": {
            "show": {
              "/resolveData": [
                false
              ]
            }
          },
          "default": [],
          "description": "Whether to include specific Contact properties in the returned results. Choose from a list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>. Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        },
        {
          "displayName": "Country/Region",
          "name": "country",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Country/Region Code",
          "name": "countryRegionCode",
          "description": "The contact's two-letter country code",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Custom Properties",
          "name": "customPropertiesUi",
          "placeholder": "Add Custom Property",
          "type": "fixedCollection",
          "typeOptions": {
            "multipleValues": true
          },
          "default": {},
          "options": [
            {
              "name": "customPropertiesValues",
              "displayName": "Custom Property",
              "values": [
                {
                  "displayName": "Property Name or ID",
                  "name": "property",
                  "type": "options",
                  "typeOptions": {
                    "loadOptionsMethod": "getContactCustomProperties"
                  },
                  "default": "",
                  "description": "Name of the property. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
                },
                {
                  "displayName": "Value",
                  "name": "value",
                  "type": "string",
                  "default": "",
                  "required": true,
                  "description": "Value of the property"
                }
              ]
            }
          ]
        },
        {
          "displayName": "Date of Birth",
          "name": "dateOfBirth",
          "type": "dateTime",
          "default": "",
          "description": "When using expressions, the time should be specified in YYYY-MM-DD hh-mm-ss format"
        },
        {
          "displayName": "Degree",
          "name": "degree",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Email Address Quarantine Reason",
          "name": "emailCustomerQuarantinedReason",
          "description": "The reason why the email address has been quarantined",
          "type": "options",
          "default": "",
          "options": [
            {
              "name": "Suspension Remediation",
              "value": "SUSPENSION_REMEDIATION"
            },
            {
              "name": "Blocklist Remediation",
              "value": "BLOCKLIST_REMEDIATION"
            },
            {
              "name": "Trust & Safety Remediation",
              "value": "TRUST_SAFETY_REMEDIATION"
            }
          ]
        },
        {
          "displayName": "Employment Role",
          "name": "employmentRole",
          "description": "Job role",
          "type": "options",
          "default": "",
          "options": [
            {
              "name": "Accounting",
              "value": "accounting"
            },
            {
              "name": "Administrative",
              "value": "administrative"
            },
            {
              "name": "Business Development",
              "value": "business_development"
            },
            {
              "name": "Communications",
              "value": "communications"
            },
            {
              "name": "Consulting",
              "value": "consulting"
            },
            {
              "name": "Customer Service",
              "value": "customer_service"
            },
            {
              "name": "Design",
              "value": "design"
            },
            {
              "name": "Education",
              "value": "education"
            },
            {
              "name": "Engineering",
              "value": "engineering"
            },
            {
              "name": "Entrepreneurship",
              "value": "entrepreneurship"
            },
            {
              "name": "Finance",
              "value": "finance"
            },
            {
              "name": "Health Professional",
              "value": "health_professional"
            },
            {
              "name": "Human Resources",
              "value": "human_resources"
            },
            {
              "name": "Information Technology",
              "value": "information_technology"
            },
            {
              "name": "Legal",
              "value": "legal"
            },
            {
              "name": "Marketing",
              "value": "marketing"
            },
            {
              "name": "Operations",
              "value": "operations"
            },
            {
              "name": "Product",
              "value": "product"
            },
            {
              "name": "Project Management",
              "value": "project_management"
            },
            {
              "name": "Public Relations",
              "value": "public_relations"
            },
            {
              "name": "Quality Assurance",
              "value": "quality_assurance"
            },
            {
              "name": "Real Estate",
              "value": "real_estate"
            },
            {
              "name": "Recruiting",
              "value": "recruiting"
            },
            {
              "name": "Research",
              "value": "research"
            },
            {
              "name": "Retired",
              "value": "retired"
            },
            {
              "name": "Sales",
              "value": "sales"
            },
            {
              "name": "Support",
              "value": "support"
            }
          ]
        },
        {
          "displayName": "Employment Seniority",
          "name": "employmentSeniority",
          "description": "Job Seniority",
          "type": "options",
          "default": "",
          "options": [
            {
              "name": "Director",
              "value": "director"
            },
            {
              "name": "Employee",
              "value": "employee"
            },
            {
              "name": "Entry",
              "value": "entry"
            },
            {
              "name": "Executive",
              "value": "executive"
            },
            {
              "name": "Manager",
              "value": "manager"
            },
            {
              "name": "Owner",
              "value": "owner"
            },
            {
              "name": "Partner",
              "value": "partner"
            },
            {
              "name": "Senior",
              "value": "senior"
            },
            {
              "name": "VP",
              "value": "vp"
            }
          ]
        },
        {
          "displayName": "Employment Sub Role",
          "name": "employmentSubRole",
          "description": "Job sub role",
          "type": "options",
          "default": "",
          "options": [
            {
              "name": "Account Executive",
              "value": "account_executive"
            },
            {
              "name": "Account Manager",
              "value": "account_manager"
            },
            {
              "name": "Accountant",
              "value": "accountant"
            },
            {
              "name": "Accounting Manager",
              "value": "accounting_manager"
            },
            {
              "name": "Administrative Assistant",
              "value": "administrative_assistant"
            },
            {
              "name": "Appraisal",
              "value": "appraisal"
            },
            {
              "name": "Architect IT",
              "value": "architect_it"
            },
            {
              "name": "Assistant",
              "value": "assistant"
            },
            {
              "name": "Attorney",
              "value": "attorney"
            },
            {
              "name": "Auditor",
              "value": "auditor"
            },
            {
              "name": "Brand Marketing",
              "value": "brand_marketing"
            },
            {
              "name": "Business Analyst",
              "value": "business_analyst"
            },
            {
              "name": "Business Consultant",
              "value": "business_consultant"
            },
            {
              "name": "Business Manager",
              "value": "business_manager"
            },
            {
              "name": "Chief Compliance Officer",
              "value": "chief_compliance_officer"
            },
            {
              "name": "Chief Data Officer",
              "value": "chief_data_officer"
            },
            {
              "name": "Chief Executive Officer",
              "value": "chief_executive_officer"
            },
            {
              "name": "Chief Experience Officer",
              "value": "chief_experience_officer"
            },
            {
              "name": "Chief Financial Officer",
              "value": "chief_financial_officer"
            },
            {
              "name": "Chief Human Resources Officer",
              "value": "chief_human_resources_officer"
            },
            {
              "name": "Chief Information Officer",
              "value": "chief_information_officer"
            },
            {
              "name": "Chief Innovation Officer",
              "value": "chief_innovation_officer"
            },
            {
              "name": "Chief Legal Officer",
              "value": "chief_legal_officer"
            },
            {
              "name": "Chief Marketing Officer",
              "value": "chief_marketing_officer"
            },
            {
              "name": "Chief Operating Officer",
              "value": "chief_operating_officer"
            },
            {
              "name": "Chief Product Officer",
              "value": "chief_product_officer"
            },
            {
              "name": "Chief Revenue Officer",
              "value": "chief_revenue_officer"
            },
            {
              "name": "Chief Risk Officer",
              "value": "chief_risk_officer"
            },
            {
              "name": "Chief Security Officer",
              "value": "chief_security_officer"
            },
            {
              "name": "Chief Sustainability Officer",
              "value": "chief_sustainability_officer"
            },
            {
              "name": "Chief Technology Officer",
              "value": "chief_technology_officer"
            },
            {
              "name": "Communications Manager",
              "value": "communications_manager"
            },
            {
              "name": "Community",
              "value": "community"
            },
            {
              "name": "Content Marketing",
              "value": "content_marketing"
            },
            {
              "name": "Contracts",
              "value": "contracts"
            },
            {
              "name": "Creative",
              "value": "creative"
            },
            {
              "name": "Customer Service Specialist",
              "value": "customer_service_specialist"
            },
            {
              "name": "Customer Success",
              "value": "customer_success"
            },
            {
              "name": "Data IT",
              "value": "data_it"
            },
            {
              "name": "Data Science Engineer",
              "value": "data_science_engineer"
            },
            {
              "name": "Database Administrator",
              "value": "database_administrator"
            },
            {
              "name": "Design Engineer",
              "value": "design_engineer"
            },
            {
              "name": "Development Specialist",
              "value": "development_specialist"
            },
            {
              "name": "Devops Engineer",
              "value": "devops_engineer"
            },
            {
              "name": "Digital Marketing",
              "value": "digital_marketing"
            },
            {
              "name": "Director of Development",
              "value": "director_of_development"
            },
            {
              "name": "Editorial",
              "value": "editorial"
            },
            {
              "name": "Electrical Engineer",
              "value": "electrical_engineer"
            },
            {
              "name": "Engineering Manager",
              "value": "engineering_manager"
            },
            {
              "name": "Events",
              "value": "events"
            },
            {
              "name": "Executive Assistant",
              "value": "executive_assistant"
            },
            {
              "name": "Facilities",
              "value": "facilities"
            },
            {
              "name": "Fashion Design",
              "value": "fashion_design"
            },
            {
              "name": "Field Marketing",
              "value": "field_marketing"
            },
            {
              "name": "Financial Analyst",
              "value": "financial_analyst"
            },
            {
              "name": "Financial Controller",
              "value": "financial_controller"
            },
            {
              "name": "Fitness",
              "value": "fitness"
            },
            {
              "name": "Founder",
              "value": "founder"
            },
            {
              "name": "General Counsel",
              "value": "general_counsel"
            },
            {
              "name": "General Manager",
              "value": "general_manager"
            },
            {
              "name": "General Partner",
              "value": "general_partner"
            },
            {
              "name": "Graphic Design",
              "value": "graphic_design"
            },
            {
              "name": "Human Resources Specialist",
              "value": "human_resources_specialist"
            },
            {
              "name": "Information Technology Specialist",
              "value": "information_technology_specialist"
            },
            {
              "name": "Investment",
              "value": "investment"
            },
            {
              "name": "Investment Banker",
              "value": "investment_banker"
            },
            {
              "name": "Journalist",
              "value": "journalist"
            },
            {
              "name": "Key Account Manager",
              "value": "key_account_manager"
            },
            {
              "name": "Law Enforcement",
              "value": "law_enforcement"
            },
            {
              "name": "Lawyer",
              "value": "lawyer"
            },
            {
              "name": "Logistics Manager",
              "value": "logistics_manager"
            },
            {
              "name": "Management",
              "value": "management"
            },
            {
              "name": "Marketing Specialist",
              "value": "marketing_specialist"
            },
            {
              "name": "Mechanical Engineer",
              "value": "mechanical_engineer"
            },
            {
              "name": "Medical Doctor",
              "value": "medical_doctor"
            },
            {
              "name": "Network Engineer",
              "value": "network_engineer"
            },
            {
              "name": "Nurse",
              "value": "nurse"
            },
            {
              "name": "Office Management",
              "value": "office_management"
            },
            {
              "name": "Office Manager",
              "value": "office_manager"
            },
            {
              "name": "Operational Specialist",
              "value": "operational_specialist"
            },
            {
              "name": "Owner",
              "value": "owner"
            },
            {
              "name": "Paralegal",
              "value": "paralegal"
            },
            {
              "name": "Principal",
              "value": "principal"
            },
            {
              "name": "Product Design",
              "value": "product_design"
            },
            {
              "name": "Product Manager",
              "value": "product_manager"
            },
            {
              "name": "Product Marketing",
              "value": "product_marketing"
            },
            {
              "name": "Production Manager",
              "value": "production_manager"
            },
            {
              "name": "Professor",
              "value": "professor"
            },
            {
              "name": "Program Coordinator",
              "value": "program_coordinator"
            },
            {
              "name": "Program Manager",
              "value": "program_manager"
            },
            {
              "name": "Project Engineer",
              "value": "project_engineer"
            },
            {
              "name": "Project Manager",
              "value": "project_manager"
            },
            {
              "name": "Property Manager",
              "value": "property_manager"
            },
            {
              "name": "QA Engineer",
              "value": "qa_engineer"
            },
            {
              "name": "QA IT",
              "value": "qa_it"
            },
            {
              "name": "Quality Assurance Manager",
              "value": "quality_assurance_manager"
            },
            {
              "name": "Quality Assurance Specialist",
              "value": "quality_assurance_specialist"
            },
            {
              "name": "Realtor",
              "value": "realtor"
            },
            {
              "name": "Recruiter",
              "value": "recruiter"
            },
            {
              "name": "Relationship Manager",
              "value": "relationship_manager"
            },
            {
              "name": "Research Analyst",
              "value": "research_analyst"
            },
            {
              "name": "Retail",
              "value": "retail"
            },
            {
              "name": "Retired",
              "value": "retired"
            },
            {
              "name": "Risk Compliance",
              "value": "risk_compliance"
            },
            {
              "name": "Sales Executive",
              "value": "sales_executive"
            },
            {
              "name": "Sales Operations",
              "value": "sales_operations"
            },
            {
              "name": "Sales Specialist",
              "value": "sales_specialist"
            },
            {
              "name": "Salesperson",
              "value": "salesperson"
            },
            {
              "name": "Secretary",
              "value": "secretary"
            },
            {
              "name": "Social Marketing",
              "value": "social_marketing"
            },
            {
              "name": "Software Engineer",
              "value": "software_engineer"
            },
            {
              "name": "Strategy",
              "value": "strategy"
            },
            {
              "name": "Student",
              "value": "student"
            },
            {
              "name": "Support",
              "value": "support"
            },
            {
              "name": "Support Specialist",
              "value": "support_specialist"
            },
            {
              "name": "System Administrator",
              "value": "system_administrator"
            },
            {
              "name": "System Analyst",
              "value": "system_analyst"
            },
            {
              "name": "Systems Engineer",
              "value": "systems_engineer"
            },
            {
              "name": "Talent",
              "value": "talent"
            },
            {
              "name": "Tax Audit",
              "value": "tax_audit"
            },
            {
              "name": "Teacher",
              "value": "teacher"
            },
            {
              "name": "Technical Manager",
              "value": "technical_manager"
            },
            {
              "name": "Technical Support Specialist",
              "value": "technical_support_specialist"
            },
            {
              "name": "Therapist",
              "value": "therapist"
            },
            {
              "name": "Training",
              "value": "training"
            },
            {
              "name": "Video",
              "value": "video"
            },
            {
              "name": "Web Developer",
              "value": "web_developer"
            },
            {
              "name": "Writer",
              "value": "writer"
            }
          ]
        },
        {
          "displayName": "Enriched Email Bounce Detected",
          "name": "enrichedEmailBounceDetected",
          "type": "boolean",
          "default": false
        },
        {
          "displayName": "Facebook Click ID",
          "name": "facebookClickId",
          "type": "number",
          "default": ""
        },
        {
          "displayName": "Fax Number",
          "name": "faxNumber",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Field Of Study",
          "name": "fieldOfStudy",
          "type": "string",
          "default": "",
          "description": "A contact's field of study. This property is required for the Facebook Ads Integration. This property will be automatically synced via the Lead Ads tool"
        },
        {
          "displayName": "First Name",
          "name": "firstName",
          "type": "string",
          "default": "",
          "description": "A contact's first name"
        },
        {
          "displayName": "Gender",
          "name": "gender",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Google Ad Click ID",
          "name": "googleAdClickId",
          "type": "number",
          "default": ""
        },
        {
          "displayName": "Graduation Date",
          "name": "graduationDate",
          "type": "dateTime",
          "default": "",
          "description": "A contact's graduation date. This property is required for the Facebook Ads Integration. This property will be automatically synced via the Lead Ads tool. When using expressions, the time should be specified in YYYY-MM-DD hh-mm-ss format"
        },
        {
          "displayName": "Industry",
          "name": "industry",
          "type": "string",
          "default": "",
          "description": "The industry a contact is in"
        },
        {
          "displayName": "Inferred Language Codes",
          "name": "inferredLanguageCodes",
          "description": "Inferred languages based on location. ISO 639-1.",
          "type": "options",
          "default": "",
          "options": [
            {
              "name": "Abkhazian",
              "value": "ab"
            },
            {
              "name": "Afar",
              "value": "aa"
            },
            {
              "name": "Afrikaans",
              "value": "af"
            },
            {
              "name": "Akan",
              "value": "ak"
            },
            {
              "name": "Albanian",
              "value": "sq"
            },
            {
              "name": "Amharic",
              "value": "am"
            },
            {
              "name": "Arabic",
              "value": "ar"
            },
            {
              "name": "Aragonese",
              "value": "an"
            },
            {
              "name": "Armenian",
              "value": "hy"
            },
            {
              "name": "Assamese",
              "value": "as"
            },
            {
              "name": "Avaric",
              "value": "av"
            },
            {
              "name": "Avestan",
              "value": "ae"
            },
            {
              "name": "Aymara",
              "value": "ay"
            },
            {
              "name": "Azerbaijani",
              "value": "az"
            },
            {
              "name": "Bambara",
              "value": "bm"
            },
            {
              "name": "Bashkir",
              "value": "ba"
            },
            {
              "name": "Basque",
              "value": "eu"
            },
            {
              "name": "Belarusian",
              "value": "be"
            },
            {
              "name": "Bengali",
              "value": "bn"
            },
            {
              "name": "Bislama",
              "value": "bi"
            },
            {
              "name": "Bokmål, Norwegian; Norwegian Bokmål",
              "value": "nb"
            },
            {
              "name": "Bosnian",
              "value": "bs"
            },
            {
              "name": "Breton",
              "value": "br"
            },
            {
              "name": "Bulgarian",
              "value": "bg"
            },
            {
              "name": "Burmese",
              "value": "my"
            },
            {
              "name": "Catalan; Valencian",
              "value": "ca"
            },
            {
              "name": "Central Khmer",
              "value": "km"
            },
            {
              "name": "Chamorro",
              "value": "ch"
            },
            {
              "name": "Chechen",
              "value": "ce"
            },
            {
              "name": "Chichewa; Chewa; Nyanja",
              "value": "ny"
            },
            {
              "name": "Chinese",
              "value": "zh"
            },
            {
              "name": "Church Slavic; Old Slavonic; Church Slavonic; Old Bulgarian; Old Church Slavonic",
              "value": "cu"
            },
            {
              "name": "Chuvash",
              "value": "cv"
            },
            {
              "name": "Cornish",
              "value": "kw"
            },
            {
              "name": "Corsican",
              "value": "co"
            },
            {
              "name": "Cree",
              "value": "cr"
            },
            {
              "name": "Croatian",
              "value": "hr"
            },
            {
              "name": "Czech",
              "value": "cs"
            },
            {
              "name": "Danish",
              "value": "da"
            },
            {
              "name": "Divehi; Dhivehi; Maldivian",
              "value": "dv"
            },
            {
              "name": "Dutch; Flemish",
              "value": "nl"
            },
            {
              "name": "Dzongkha",
              "value": "dz"
            },
            {
              "name": "English",
              "value": "en"
            },
            {
              "name": "Esperanto",
              "value": "eo"
            },
            {
              "name": "Estonian",
              "value": "et"
            },
            {
              "name": "Ewe",
              "value": "ee"
            },
            {
              "name": "Faroese",
              "value": "fo"
            },
            {
              "name": "Fijian",
              "value": "fj"
            },
            {
              "name": "Finnish",
              "value": "fi"
            },
            {
              "name": "French",
              "value": "fr"
            },
            {
              "name": "Fulah",
              "value": "ff"
            },
            {
              "name": "Gaelic; Scottish Gaelic",
              "value": "gd"
            },
            {
              "name": "Galician",
              "value": "gl"
            },
            {
              "name": "Ganda",
              "value": "lg"
            },
            {
              "name": "Georgian",
              "value": "ka"
            },
            {
              "name": "German",
              "value": "de"
            },
            {
              "name": "Greek, Modern (1453-)",
              "value": "el"
            },
            {
              "name": "Guarani",
              "value": "gn"
            },
            {
              "name": "Gujarati",
              "value": "gu"
            },
            {
              "name": "Haitian; Haitian Creole",
              "value": "ht"
            },
            {
              "name": "Hausa",
              "value": "ha"
            },
            {
              "name": "Hebrew",
              "value": "he"
            },
            {
              "name": "Herero",
              "value": "hz"
            },
            {
              "name": "Hindi",
              "value": "hi"
            },
            {
              "name": "Hiri Motu",
              "value": "ho"
            },
            {
              "name": "Hungarian",
              "value": "hu"
            },
            {
              "name": "Icelandic",
              "value": "is"
            },
            {
              "name": "Ido",
              "value": "io"
            },
            {
              "name": "Igbo",
              "value": "ig"
            },
            {
              "name": "Indonesian",
              "value": "id"
            },
            {
              "name": "Interlingua (International Auxiliary Language Association)",
              "value": "ia"
            },
            {
              "name": "Interlingue; Occidental",
              "value": "ie"
            },
            {
              "name": "Inuktitut",
              "value": "iu"
            },
            {
              "name": "Inupiaq",
              "value": "ik"
            },
            {
              "name": "Irish",
              "value": "ga"
            },
            {
              "name": "Italian",
              "value": "it"
            },
            {
              "name": "Japanese",
              "value": "ja"
            },
            {
              "name": "Javanese",
              "value": "jv"
            },
            {
              "name": "Kalaallisut; Greenlandic",
              "value": "kl"
            },
            {
              "name": "Kannada",
              "value": "kn"
            },
            {
              "name": "Kanuri",
              "value": "kr"
            },
            {
              "name": "Kashmiri",
              "value": "ks"
            },
            {
              "name": "Kazakh",
              "value": "kk"
            },
            {
              "name": "Kikuyu; Gikuyu",
              "value": "ki"
            },
            {
              "name": "Kinyarwanda",
              "value": "rw"
            },
            {
              "name": "Kirghiz; Kyrgyz",
              "value": "ky"
            },
            {
              "name": "Komi",
              "value": "kv"
            },
            {
              "name": "Kongo",
              "value": "kg"
            },
            {
              "name": "Korean",
              "value": "ko"
            },
            {
              "name": "Kuanyama; Kwanyama",
              "value": "kj"
            },
            {
              "name": "Kurdish",
              "value": "ku"
            },
            {
              "name": "Lao",
              "value": "lo"
            },
            {
              "name": "Latin",
              "value": "la"
            },
            {
              "name": "Latvian",
              "value": "lv"
            },
            {
              "name": "Limburgan; Limburger; Limburgish",
              "value": "li"
            },
            {
              "name": "Lingala",
              "value": "ln"
            },
            {
              "name": "Lithuanian",
              "value": "lt"
            },
            {
              "name": "Luba-Katanga",
              "value": "lu"
            },
            {
              "name": "Luxembourgish; Letzeburgesch",
              "value": "lb"
            },
            {
              "name": "Macedonian",
              "value": "mk"
            },
            {
              "name": "Malagasy",
              "value": "mg"
            },
            {
              "name": "Malay (Macrolanguage)",
              "value": "ms"
            },
            {
              "name": "Malayalam",
              "value": "ml"
            },
            {
              "name": "Maltese",
              "value": "mt"
            },
            {
              "name": "Manx",
              "value": "gv"
            },
            {
              "name": "Maori",
              "value": "mi"
            },
            {
              "name": "Marathi",
              "value": "mr"
            },
            {
              "name": "Marshallese",
              "value": "mh"
            },
            {
              "name": "Mongolian",
              "value": "mn"
            },
            {
              "name": "Nauru",
              "value": "na"
            },
            {
              "name": "Navajo; Navaho",
              "value": "nv"
            },
            {
              "name": "Ndebele, North; North Ndebele",
              "value": "nd"
            },
            {
              "name": "Ndebele, South; South Ndebele",
              "value": "nr"
            },
            {
              "name": "Ndonga",
              "value": "ng"
            },
            {
              "name": "Nepali (Macrolanguage)",
              "value": "ne"
            },
            {
              "name": "Northern Sami",
              "value": "se"
            },
            {
              "name": "Norwegian",
              "value": "no"
            },
            {
              "name": "Norwegian Nynorsk; Nynorsk, Norwegian",
              "value": "nn"
            },
            {
              "name": "Occitan (Post 1500)",
              "value": "oc"
            },
            {
              "name": "Ojibwa",
              "value": "oj"
            },
            {
              "name": "Oriya (Macrolanguage)",
              "value": "or"
            },
            {
              "name": "Oromo",
              "value": "om"
            },
            {
              "name": "Ossetian; Ossetic",
              "value": "os"
            },
            {
              "name": "Pali",
              "value": "pi"
            },
            {
              "name": "Panjabi; Punjabi",
              "value": "pa"
            },
            {
              "name": "Persian",
              "value": "fa"
            },
            {
              "name": "Polish",
              "value": "pl"
            },
            {
              "name": "Portuguese",
              "value": "pt"
            },
            {
              "name": "Pushto; Pashto",
              "value": "ps"
            },
            {
              "name": "Quechua",
              "value": "qu"
            },
            {
              "name": "Romanian; Moldavian; Moldovan",
              "value": "ro"
            },
            {
              "name": "Romansh",
              "value": "rm"
            },
            {
              "name": "Rundi",
              "value": "rn"
            },
            {
              "name": "Russian",
              "value": "ru"
            },
            {
              "name": "Samoan",
              "value": "sm"
            },
            {
              "name": "Sango",
              "value": "sg"
            },
            {
              "name": "Sanskrit",
              "value": "sa"
            },
            {
              "name": "Sardinian",
              "value": "sc"
            },
            {
              "name": "Serbian",
              "value": "sr"
            },
            {
              "name": "Shona",
              "value": "sn"
            },
            {
              "name": "Sichuan Yi; Nuosu",
              "value": "ii"
            },
            {
              "name": "Sindhi",
              "value": "sd"
            },
            {
              "name": "Sinhala; Sinhalese",
              "value": "si"
            },
            {
              "name": "Slovak",
              "value": "sk"
            },
            {
              "name": "Slovenian",
              "value": "sl"
            },
            {
              "name": "Somali",
              "value": "so"
            },
            {
              "name": "Sotho, Southern",
              "value": "st"
            },
            {
              "name": "Spanish; Castilian",
              "value": "es"
            },
            {
              "name": "Sundanese",
              "value": "su"
            },
            {
              "name": "Swahili (Macrolanguage)",
              "value": "sw"
            },
            {
              "name": "Swati",
              "value": "ss"
            },
            {
              "name": "Swedish",
              "value": "sv"
            },
            {
              "name": "Tagalog",
              "value": "tl"
            },
            {
              "name": "Tahitian",
              "value": "ty"
            },
            {
              "name": "Tajik",
              "value": "tg"
            },
            {
              "name": "Tamil",
              "value": "ta"
            },
            {
              "name": "Tatar",
              "value": "tt"
            },
            {
              "name": "Telugu",
              "value": "te"
            },
            {
              "name": "Thai",
              "value": "th"
            },
            {
              "name": "Tibetan",
              "value": "bo"
            },
            {
              "name": "Tigrinya",
              "value": "ti"
            },
            {
              "name": "Tonga (Tonga Islands)",
              "value": "to"
            },
            {
              "name": "Tsonga",
              "value": "ts"
            },
            {
              "name": "Tswana",
              "value": "tn"
            },
            {
              "name": "Turkish",
              "value": "tr"
            },
            {
              "name": "Turkmen",
              "value": "tk"
            },
            {
              "name": "Twi",
              "value": "tw"
            },
            {
              "name": "Uighur; Uyghur",
              "value": "ug"
            },
            {
              "name": "Ukrainian",
              "value": "uk"
            },
            {
              "name": "Urdu",
              "value": "ur"
            },
            {
              "name": "Uzbek",
              "value": "uz"
            },
            {
              "name": "Venda",
              "value": "ve"
            },
            {
              "name": "Vietnamese",
              "value": "vi"
            },
            {
              "name": "Volapük",
              "value": "vo"
            },
            {
              "name": "Walloon",
              "value": "wa"
            },
            {
              "name": "Welsh",
              "value": "cy"
            },
            {
              "name": "Western Frisian",
              "value": "fy"
            },
            {
              "name": "Wolof",
              "value": "wo"
            },
            {
              "name": "Xhosa",
              "value": "xh"
            },
            {
              "name": "Yiddish",
              "value": "yi"
            },
            {
              "name": "Yoruba",
              "value": "yo"
            },
            {
              "name": "Zhuang; Chuang",
              "value": "za"
            },
            {
              "name": "Zulu",
              "value": "zu"
            }
          ]
        },
        {
          "displayName": "Job Function",
          "name": "jobFunction",
          "type": "string",
          "default": "",
          "description": "A contact's job function. This property is required for the Facebook Ads Integration. This property will be automatically synced via the Lead Ads tool"
        },
        {
          "displayName": "Job Title",
          "name": "jobTitle",
          "type": "string",
          "default": "",
          "description": "A contact's job title"
        },
        {
          "displayName": "Last Name",
          "name": "lastName",
          "type": "string",
          "default": "",
          "description": "A contact's last name"
        },
        {
          "displayName": "Latest Traffic Source",
          "name": "latestTrafficSource",
          "description": "The source of the latest session for a contact",
          "type": "options",
          "default": "",
          "options": [
            {
              "name": "Direct Traffic",
              "value": "DIRECT_TRAFFIC"
            },
            {
              "name": "Email Marketing",
              "value": "EMAIL_MARKETING"
            },
            {
              "name": "Offline Sources",
              "value": "OFFLINE"
            },
            {
              "name": "Organic Search",
              "value": "ORGANIC_SEARCH"
            },
            {
              "name": "Organic Social",
              "value": "SOCIAL_MEDIA"
            },
            {
              "name": "Other Campaigns",
              "value": "OTHER_CAMPAIGNS"
            },
            {
              "name": "Paid Search",
              "value": "PAID_SEARCH"
            },
            {
              "name": "Paid Social",
              "value": "PAID_SOCIAL"
            },
            {
              "name": "Referrals",
              "value": "REFERRALS"
            }
          ]
        },
        {
          "displayName": "Latest Traffic Source Date",
          "name": "latestTrafficSourceDate",
          "description": "The time of the latest session for a contact",
          "type": "dateTime",
          "default": ""
        },
        {
          "displayName": "Lead Status Name or ID",
          "name": "leadStatus",
          "type": "options",
          "typeOptions": {
            "loadOptionsMethod": "getContactLeadStatuses"
          },
          "default": "",
          "description": "The contact's sales, prospecting or outreach status. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        },
        {
          "displayName": "Legal Basic For Processing Contact Data Name or ID",
          "name": "processingContactData",
          "type": "options",
          "typeOptions": {
            "loadOptionsMethod": "getContactLealBasics"
          },
          "default": "",
          "description": "Legal basis for processing contact's data; 'Not applicable' will exempt the contact from GDPR protections. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        },
        {
          "displayName": "Lifecycle Stage Name or ID",
          "name": "lifeCycleStage",
          "type": "options",
          "typeOptions": {
            "loadOptionsMethod": "getContactLifeCycleStages"
          },
          "default": "",
          "description": "The qualification of contacts to sales readiness. It can be set through imports, forms, workflows, and manually on a per contact basis. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        },
        {
          "displayName": "LinkedIn URL",
          "name": "linkedinUrl",
          "description": "The URL of the contact's LinkedIn page",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Marital Status",
          "name": "maritalStatus",
          "type": "string",
          "default": "",
          "description": "A contact's marital status. This property is required for the Facebook Ads Integration. This property will be automatically synced via the Lead Ads tool"
        },
        {
          "displayName": "Member Email",
          "name": "memberEmail",
          "description": "Email used to send private content information to members",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Membership Note",
          "name": "membershipNote",
          "type": "string",
          "typeOptions": {
            "alwaysOpenEditWindow": true
          },
          "default": "",
          "description": "The notes relating to the contact's content membership"
        },
        {
          "displayName": "Message",
          "name": "message",
          "type": "string",
          "typeOptions": {
            "alwaysOpenEditWindow": true
          },
          "default": "",
          "description": "A default property to be used for any message or comments a contact may want to leave on a form"
        },
        {
          "displayName": "Military Status",
          "name": "militaryStatus",
          "description": "Contact's military status. Required for the Facebook Ads Integration. Automatically synced from the Lead Ads tool.",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Mobile Phone Number",
          "name": "mobilePhoneNumber",
          "type": "string",
          "default": "",
          "description": "A contact's mobile phone number"
        },
        {
          "displayName": "Number Of Employees",
          "name": "numberOfEmployees",
          "type": "options",
          "typeOptions": {
            "loadOptionsMethod": "getContactNumberOfEmployees"
          },
          "default": "",
          "description": "The number of company employees. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        },
        {
          "displayName": "Original Source Name or ID",
          "name": "originalSource",
          "type": "options",
          "typeOptions": {
            "loadOptionsMethod": "getContactOriginalSources"
          },
          "default": "",
          "description": "The first known source through which a contact found your website. Source is automatically set by HubSpot, but may be updated manually. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        },
        {
          "displayName": "Persona",
          "name": "persona",
          "description": "A contact's persona",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Phone Number",
          "name": "phoneNumber",
          "type": "string",
          "default": "",
          "description": "A contact's primary phone number"
        },
        {
          "displayName": "Postal Code",
          "name": "postalCode",
          "type": "string",
          "default": "",
          "description": "The contact's zip code. This might be set via import, form, or integration."
        },
        {
          "displayName": "Preffered Language Name or ID",
          "name": "prefferedLanguage",
          "type": "options",
          "typeOptions": {
            "loadOptionsMethod": "getContactPrefferedLanguages"
          },
          "default": "",
          "description": "Set your contact's preferred language for communications. This property can be changed from an import, form, or integration. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        },
        {
          "displayName": "Prospecting Agent Last Enrolled",
          "name": "prospectingAgentLastEnrolled",
          "description": "The last time the Prospecting Agent enrolled this contact",
          "type": "dateTime",
          "default": ""
        },
        {
          "displayName": "Prospecting Agent Total Enrolled Count",
          "name": "prospectingAgentTotalEnrolledCount",
          "type": "number",
          "default": ""
        },
        {
          "displayName": "Relationship Status",
          "name": "relationshipStatus",
          "type": "string",
          "default": "",
          "description": "A contact's relationship status. This property is required for the Facebook Ads Integration. This property will be automatically synced via the Lead Ads tool"
        },
        {
          "displayName": "Salutation",
          "name": "salutation",
          "type": "string",
          "default": "",
          "description": "The title used to address a contact"
        },
        {
          "displayName": "School",
          "name": "school",
          "type": "string",
          "default": "",
          "description": "A contact's school. This property is required for the Facebook Ads Integration. This property will be automatically synced via the Lead Ads tool"
        },
        {
          "displayName": "Seniority",
          "name": "seniority",
          "type": "string",
          "default": "",
          "description": "A contact's seniority. This property is required for the Facebook Ads Integration. This property will be automatically synced via the Lead Ads tool"
        },
        {
          "displayName": "Start Date",
          "name": "startDate",
          "type": "dateTime",
          "default": "",
          "description": "A contact's start date. This property is required for the Facebook Ads Integration. This property will be automatically synced via the Lead Ads tool. When using expressions, the time should be specified in YYYY-MM-DD hh-mm-ss format"
        },
        {
          "displayName": "State/Region",
          "name": "stateRegion",
          "type": "string",
          "default": "",
          "description": "The contact's state of residence. This might be set via import, form, or integration."
        },
        {
          "displayName": "State/Region Code",
          "name": "stateRegionCode",
          "description": "The contact's state or region code",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Status Name or ID",
          "name": "status",
          "type": "options",
          "typeOptions": {
            "loadOptionsMethod": "getContactStatuses"
          },
          "default": "",
          "description": "The status of the contact's content membership. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        },
        {
          "displayName": "Street Address",
          "name": "streetAddress",
          "type": "string",
          "default": "",
          "description": "A contact's street address, including apartment or unit #"
        },
        {
          "displayName": "Time Zone",
          "name": "timeZone",
          "description": "The contact’s time zone. This can be set automatically by HubSpot based on other contact properties. It can also be set manually for each contact.",
          "type": "options",
          "default": "",
          "options": [
            {
              "name": "UTC -01:00 Atlantic Cape Verde",
              "value": "atlantic_slash_cape_verde"
            },
            {
              "name": "UTC -02:00 America Godthab",
              "value": "america_slash_godthab"
            },
            {
              "name": "UTC -02:00 America Miquelon",
              "value": "america_slash_miquelon"
            },
            {
              "name": "UTC -02:00 America Noronha",
              "value": "america_slash_noronha"
            },
            {
              "name": "UTC -02:00 Atlantic South Georgia",
              "value": "atlantic_slash_south_georgia"
            },
            {
              "name": "UTC -02:00 Brazil DeNoronha",
              "value": "brazil_slash_denoronha"
            },
            {
              "name": "UTC -02:30 America St Johns",
              "value": "america_slash_st_johns"
            },
            {
              "name": "UTC -02:30 Canada Newfoundland",
              "value": "canada_slash_newfoundland"
            },
            {
              "name": "UTC -03:00 America Araguaina",
              "value": "america_slash_araguaina"
            },
            {
              "name": "UTC -03:00 America Argentina (Buenos Aires)",
              "value": "america_slash_argentina_slash_buenos_aires"
            },
            {
              "name": "UTC -03:00 America Argentina (Catamarca)",
              "value": "america_slash_argentina_slash_catamarca"
            },
            {
              "name": "UTC -03:00 America Argentina (ComodRivadavia)",
              "value": "america_slash_argentina_slash_comodrivadavia"
            },
            {
              "name": "UTC -03:00 America Argentina (Cordoba)",
              "value": "america_slash_argentina_slash_cordoba"
            },
            {
              "name": "UTC -03:00 America Argentina (Jujuy)",
              "value": "america_slash_argentina_slash_jujuy"
            },
            {
              "name": "UTC -03:00 America Argentina (La Rioja)",
              "value": "america_slash_argentina_slash_la_rioja"
            },
            {
              "name": "UTC -03:00 America Argentina (Mendoza)",
              "value": "america_slash_argentina_slash_mendoza"
            },
            {
              "name": "UTC -03:00 America Argentina (Rio Gallegos)",
              "value": "america_slash_argentina_slash_rio_gallegos"
            },
            {
              "name": "UTC -03:00 America Argentina (Salta)",
              "value": "america_slash_argentina_slash_salta"
            },
            {
              "name": "UTC -03:00 America Argentina (San Juan)",
              "value": "america_slash_argentina_slash_san_juan"
            },
            {
              "name": "UTC -03:00 America Argentina (San Luis)",
              "value": "america_slash_argentina_slash_san_luis"
            },
            {
              "name": "UTC -03:00 America Argentina (Tucuman)",
              "value": "america_slash_argentina_slash_tucuman"
            },
            {
              "name": "UTC -03:00 America Argentina (Ushuaia)",
              "value": "america_slash_argentina_slash_ushuaia"
            },
            {
              "name": "UTC -03:00 America Bahia",
              "value": "america_slash_bahia"
            },
            {
              "name": "UTC -03:00 America Belem",
              "value": "america_slash_belem"
            },
            {
              "name": "UTC -03:00 America Buenos Aires",
              "value": "america_slash_buenos_aires"
            },
            {
              "name": "UTC -03:00 America Catamarca",
              "value": "america_slash_catamarca"
            },
            {
              "name": "UTC -03:00 America Cayenne",
              "value": "america_slash_cayenne"
            },
            {
              "name": "UTC -03:00 America Cordoba",
              "value": "america_slash_cordoba"
            },
            {
              "name": "UTC -03:00 America Fortaleza",
              "value": "america_slash_fortaleza"
            },
            {
              "name": "UTC -03:00 America Glace Bay",
              "value": "america_slash_glace_bay"
            },
            {
              "name": "UTC -03:00 America Goose Bay",
              "value": "america_slash_goose_bay"
            },
            {
              "name": "UTC -03:00 America Halifax",
              "value": "america_slash_halifax"
            },
            {
              "name": "UTC -03:00 America Jujuy",
              "value": "america_slash_jujuy"
            },
            {
              "name": "UTC -03:00 America Maceio",
              "value": "america_slash_maceio"
            },
            {
              "name": "UTC -03:00 America Mendoza",
              "value": "america_slash_mendoza"
            },
            {
              "name": "UTC -03:00 America Moncton",
              "value": "america_slash_moncton"
            },
            {
              "name": "UTC -03:00 America Montevideo",
              "value": "america_slash_montevideo"
            },
            {
              "name": "UTC -03:00 America Paramaribo",
              "value": "america_slash_paramaribo"
            },
            {
              "name": "UTC -03:00 America Punta Arenas",
              "value": "america_slash_punta_arenas"
            },
            {
              "name": "UTC -03:00 America Recife",
              "value": "america_slash_recife"
            },
            {
              "name": "UTC -03:00 America Rosario",
              "value": "america_slash_rosario"
            },
            {
              "name": "UTC -03:00 America Santarem",
              "value": "america_slash_santarem"
            },
            {
              "name": "UTC -03:00 America Sao Paulo",
              "value": "america_slash_sao_paulo"
            },
            {
              "name": "UTC -03:00 America Thule",
              "value": "america_slash_thule"
            },
            {
              "name": "UTC -03:00 Antarctica Palmer",
              "value": "antarctica_slash_palmer"
            },
            {
              "name": "UTC -03:00 Antarctica Rothera",
              "value": "antarctica_slash_rothera"
            },
            {
              "name": "UTC -03:00 Atlantic Bermuda",
              "value": "atlantic_slash_bermuda"
            },
            {
              "name": "UTC -03:00 Atlantic Stanley",
              "value": "atlantic_slash_stanley"
            },
            {
              "name": "UTC -03:00 Brazil East",
              "value": "brazil_slash_east"
            },
            {
              "name": "UTC -03:00 Canada Atlantic",
              "value": "canada_slash_atlantic"
            },
            {
              "name": "UTC -04:00 America Anguilla",
              "value": "america_slash_anguilla"
            },
            {
              "name": "UTC -04:00 America Antigua",
              "value": "america_slash_antigua"
            },
            {
              "name": "UTC -04:00 America Aruba",
              "value": "america_slash_aruba"
            },
            {
              "name": "UTC -04:00 America Asuncion",
              "value": "america_slash_asuncion"
            },
            {
              "name": "UTC -04:00 America Barbados",
              "value": "america_slash_barbados"
            },
            {
              "name": "UTC -04:00 America Blanc-Sablon",
              "value": "america_slash_blanc_hyphen_sablon"
            },
            {
              "name": "UTC -04:00 America Boa Vista",
              "value": "america_slash_boa_vista"
            },
            {
              "name": "UTC -04:00 America Campo Grande",
              "value": "america_slash_campo_grande"
            },
            {
              "name": "UTC -04:00 America Caracas",
              "value": "america_slash_caracas"
            },
            {
              "name": "UTC -04:00 America Cuba",
              "value": "cuba"
            },
            {
              "name": "UTC -04:00 America Cuiaba",
              "value": "america_slash_cuiaba"
            },
            {
              "name": "UTC -04:00 America Curacao",
              "value": "america_slash_curacao"
            },
            {
              "name": "UTC -04:00 America Detroit",
              "value": "america_slash_detroit"
            },
            {
              "name": "UTC -04:00 America Dominica",
              "value": "america_slash_dominica"
            },
            {
              "name": "UTC -04:00 America Fort Wayne",
              "value": "america_slash_fort_wayne"
            },
            {
              "name": "UTC -04:00 America Grand Turk",
              "value": "america_slash_grand_turk"
            },
            {
              "name": "UTC -04:00 America Grenada",
              "value": "america_slash_grenada"
            },
            {
              "name": "UTC -04:00 America Guadeloupe",
              "value": "america_slash_guadeloupe"
            },
            {
              "name": "UTC -04:00 America Guyana",
              "value": "america_slash_guyana"
            },
            {
              "name": "UTC -04:00 America Havana",
              "value": "america_slash_havana"
            },
            {
              "name": "UTC -04:00 America Indiana (Indianapolis)",
              "value": "america_slash_indiana_slash_indianapolis"
            },
            {
              "name": "UTC -04:00 America Indiana (Marengo)",
              "value": "america_slash_indiana_slash_marengo"
            },
            {
              "name": "UTC -04:00 America Indiana (Petersburg)",
              "value": "america_slash_indiana_slash_petersburg"
            },
            {
              "name": "UTC -04:00 America Indiana (Vevay)",
              "value": "america_slash_indiana_slash_vevay"
            },
            {
              "name": "UTC -04:00 America Indiana (Vincennes)",
              "value": "america_slash_indiana_slash_vincennes"
            },
            {
              "name": "UTC -04:00 America Indiana (Winamac)",
              "value": "america_slash_indiana_slash_winamac"
            },
            {
              "name": "UTC -04:00 America Indianapolis",
              "value": "america_slash_indianapolis"
            },
            {
              "name": "UTC -04:00 America Iqaluit",
              "value": "america_slash_iqaluit"
            },
            {
              "name": "UTC -04:00 America Kentucky (Louisville)",
              "value": "america_slash_kentucky_slash_louisville"
            },
            {
              "name": "UTC -04:00 America Kentucky (Monticello)",
              "value": "america_slash_kentucky_slash_monticello"
            },
            {
              "name": "UTC -04:00 America Kralendijk",
              "value": "america_slash_kralendijk"
            },
            {
              "name": "UTC -04:00 America La Paz",
              "value": "america_slash_la_paz"
            },
            {
              "name": "UTC -04:00 America Louisville",
              "value": "america_slash_louisville"
            },
            {
              "name": "UTC -04:00 America Lower Princes",
              "value": "america_slash_lower_princes"
            },
            {
              "name": "UTC -04:00 America Manaus",
              "value": "america_slash_manaus"
            },
            {
              "name": "UTC -04:00 America Marigot",
              "value": "america_slash_marigot"
            },
            {
              "name": "UTC -04:00 America Martinique",
              "value": "america_slash_martinique"
            },
            {
              "name": "UTC -04:00 America Montreal",
              "value": "america_slash_montreal"
            },
            {
              "name": "UTC -04:00 America Montserrat",
              "value": "america_slash_montserrat"
            },
            {
              "name": "UTC -04:00 America Nassau",
              "value": "america_slash_nassau"
            },
            {
              "name": "UTC -04:00 America New York",
              "value": "america_slash_new_york"
            },
            {
              "name": "UTC -04:00 America Nipigon",
              "value": "america_slash_nipigon"
            },
            {
              "name": "UTC -04:00 America Pangnirtung",
              "value": "america_slash_pangnirtung"
            },
            {
              "name": "UTC -04:00 America Port of Spain",
              "value": "america_slash_port_of_spain"
            },
            {
              "name": "UTC -04:00 America Port-Au-Prince",
              "value": "america_slash_port_hyphen_au_hyphen_prince"
            },
            {
              "name": "UTC -04:00 America Porto Velho",
              "value": "america_slash_porto_velho"
            },
            {
              "name": "UTC -04:00 America Puerto Rico",
              "value": "america_slash_puerto_rico"
            },
            {
              "name": "UTC -04:00 America Santiago",
              "value": "america_slash_santiago"
            },
            {
              "name": "UTC -04:00 America Santo Domingo",
              "value": "america_slash_santo_domingo"
            },
            {
              "name": "UTC -04:00 America St Barthelemy",
              "value": "america_slash_st_barthelemy"
            },
            {
              "name": "UTC -04:00 America St Kitts",
              "value": "america_slash_st_kitts"
            },
            {
              "name": "UTC -04:00 America St Lucia",
              "value": "america_slash_st_lucia"
            },
            {
              "name": "UTC -04:00 America St Thomas",
              "value": "america_slash_st_thomas"
            },
            {
              "name": "UTC -04:00 America St Vincent",
              "value": "america_slash_st_vincent"
            },
            {
              "name": "UTC -04:00 America Thunder Bay",
              "value": "america_slash_thunder_bay"
            },
            {
              "name": "UTC -04:00 America Toronto",
              "value": "america_slash_toronto"
            },
            {
              "name": "UTC -04:00 America Tortola",
              "value": "america_slash_tortola"
            },
            {
              "name": "UTC -04:00 America Virgin",
              "value": "america_slash_virgin"
            },
            {
              "name": "UTC -04:00 Brazil West",
              "value": "brazil_slash_west"
            },
            {
              "name": "UTC -04:00 Canada Eastern",
              "value": "canada_slash_eastern"
            },
            {
              "name": "UTC -04:00 Chile Continental",
              "value": "chile_slash_continental"
            },
            {
              "name": "UTC -04:00 US East-Indiana",
              "value": "us_slash_east_hyphen_indiana"
            },
            {
              "name": "UTC -04:00 US Eastern",
              "value": "us_slash_eastern"
            },
            {
              "name": "UTC -04:00 US Michigan",
              "value": "us_slash_michigan"
            },
            {
              "name": "UTC -05:00 America Atikokan",
              "value": "america_slash_atikokan"
            },
            {
              "name": "UTC -05:00 America Bahia Banderas",
              "value": "america_slash_bahia_banderas"
            },
            {
              "name": "UTC -05:00 America Bogota",
              "value": "america_slash_bogota"
            },
            {
              "name": "UTC -05:00 America Cancun",
              "value": "america_slash_cancun"
            },
            {
              "name": "UTC -05:00 America Cayman",
              "value": "america_slash_cayman"
            },
            {
              "name": "UTC -05:00 America Chicago",
              "value": "america_slash_chicago"
            },
            {
              "name": "UTC -05:00 America Coral Harbour",
              "value": "america_slash_coral_harbour"
            },
            {
              "name": "UTC -05:00 America Eirunepe",
              "value": "america_slash_eirunepe"
            },
            {
              "name": "UTC -05:00 America Guayaquil",
              "value": "america_slash_guayaquil"
            },
            {
              "name": "UTC -05:00 America Indiana (Knox)",
              "value": "america_slash_indiana_slash_knox"
            },
            {
              "name": "UTC -05:00 America Indiana (Tell City)",
              "value": "america_slash_indiana_slash_tell_city"
            },
            {
              "name": "UTC -05:00 America Jamaica",
              "value": "america_slash_jamaica"
            },
            {
              "name": "UTC -05:00 America Knox IN",
              "value": "america_slash_knox_in"
            },
            {
              "name": "UTC -05:00 America Lima",
              "value": "america_slash_lima"
            },
            {
              "name": "UTC -05:00 America Matamoros",
              "value": "america_slash_matamoros"
            },
            {
              "name": "UTC -05:00 America Menominee",
              "value": "america_slash_menominee"
            },
            {
              "name": "UTC -05:00 America Merida",
              "value": "america_slash_merida"
            },
            {
              "name": "UTC -05:00 America Mexico City",
              "value": "america_slash_mexico_city"
            },
            {
              "name": "UTC -05:00 America Monterrey",
              "value": "america_slash_monterrey"
            },
            {
              "name": "UTC -05:00 America North Dakota (Beulah)",
              "value": "america_slash_north_dakota_slash_beulah"
            },
            {
              "name": "UTC -05:00 America North Dakota (Center)",
              "value": "america_slash_north_dakota_slash_center"
            },
            {
              "name": "UTC -05:00 America North Dakota (New Salem)",
              "value": "america_slash_north_dakota_slash_new_salem"
            },
            {
              "name": "UTC -05:00 America Panama",
              "value": "america_slash_panama"
            },
            {
              "name": "UTC -05:00 America Porto Acre",
              "value": "america_slash_porto_acre"
            },
            {
              "name": "UTC -05:00 America Rainy River",
              "value": "america_slash_rainy_river"
            },
            {
              "name": "UTC -05:00 America Rankin Inlet",
              "value": "america_slash_rankin_inlet"
            },
            {
              "name": "UTC -05:00 America Resolute",
              "value": "america_slash_resolute"
            },
            {
              "name": "UTC -05:00 America Rio Branco",
              "value": "america_slash_rio_branco"
            },
            {
              "name": "UTC -05:00 America Winnipeg",
              "value": "america_slash_winnipeg"
            },
            {
              "name": "UTC -05:00 Brazil Acre",
              "value": "brazil_slash_acre"
            },
            {
              "name": "UTC -05:00 Canada Central",
              "value": "canada_slash_central"
            },
            {
              "name": "UTC -05:00 Mexico General",
              "value": "mexico_slash_general"
            },
            {
              "name": "UTC -05:00 US Central",
              "value": "us_slash_central"
            },
            {
              "name": "UTC -05:00 US Indiana-Starke",
              "value": "us_slash_indiana_hyphen_starke"
            },
            {
              "name": "UTC -06:00 America Belize",
              "value": "america_slash_belize"
            },
            {
              "name": "UTC -06:00 America Boise",
              "value": "america_slash_boise"
            },
            {
              "name": "UTC -06:00 America Cambridge Bay",
              "value": "america_slash_cambridge_bay"
            },
            {
              "name": "UTC -06:00 America Chihuahua",
              "value": "america_slash_chihuahua"
            },
            {
              "name": "UTC -06:00 America Costa Rica",
              "value": "america_slash_costa_rica"
            },
            {
              "name": "UTC -06:00 America Denver",
              "value": "america_slash_denver"
            },
            {
              "name": "UTC -06:00 America Edmonton",
              "value": "america_slash_edmonton"
            },
            {
              "name": "UTC -06:00 America El Salvador",
              "value": "america_slash_el_salvador"
            },
            {
              "name": "UTC -06:00 America Guatemala",
              "value": "america_slash_guatemala"
            },
            {
              "name": "UTC -06:00 America Inuvik",
              "value": "america_slash_inuvik"
            },
            {
              "name": "UTC -06:00 America Managua",
              "value": "america_slash_managua"
            },
            {
              "name": "UTC -06:00 America Mazatlan",
              "value": "america_slash_mazatlan"
            },
            {
              "name": "UTC -06:00 America Navajo",
              "value": "navajo"
            },
            {
              "name": "UTC -06:00 America Ojinaga",
              "value": "america_slash_ojinaga"
            },
            {
              "name": "UTC -06:00 America Regina",
              "value": "america_slash_regina"
            },
            {
              "name": "UTC -06:00 America Shiprock",
              "value": "america_slash_shiprock"
            },
            {
              "name": "UTC -06:00 America Swift Current",
              "value": "america_slash_swift_current"
            },
            {
              "name": "UTC -06:00 America Tegucigalpa",
              "value": "america_slash_tegucigalpa"
            },
            {
              "name": "UTC -06:00 America Yellowknife",
              "value": "america_slash_yellowknife"
            },
            {
              "name": "UTC -06:00 Canada Mountain",
              "value": "canada_slash_mountain"
            },
            {
              "name": "UTC -06:00 Canada Saskatchewan",
              "value": "canada_slash_saskatchewan"
            },
            {
              "name": "UTC -06:00 Chile EasterIsland",
              "value": "chile_slash_easterisland"
            },
            {
              "name": "UTC -06:00 Mexico BajaSur",
              "value": "mexico_slash_bajasur"
            },
            {
              "name": "UTC -06:00 Pacific Easter",
              "value": "pacific_slash_easter"
            },
            {
              "name": "UTC -06:00 Pacific Galapagos",
              "value": "pacific_slash_galapagos"
            },
            {
              "name": "UTC -06:00 US Mountain",
              "value": "us_slash_mountain"
            },
            {
              "name": "UTC -07:00 America Creston",
              "value": "america_slash_creston"
            },
            {
              "name": "UTC -07:00 America Dawson",
              "value": "america_slash_dawson"
            },
            {
              "name": "UTC -07:00 America Dawson Creek",
              "value": "america_slash_dawson_creek"
            },
            {
              "name": "UTC -07:00 America Ensenada",
              "value": "america_slash_ensenada"
            },
            {
              "name": "UTC -07:00 America Fort Nelson",
              "value": "america_slash_fort_nelson"
            },
            {
              "name": "UTC -07:00 America Hermosillo",
              "value": "america_slash_hermosillo"
            },
            {
              "name": "UTC -07:00 America Los Angeles",
              "value": "america_slash_los_angeles"
            },
            {
              "name": "UTC -07:00 America Phoenix",
              "value": "america_slash_phoenix"
            },
            {
              "name": "UTC -07:00 America Santa Isabel",
              "value": "america_slash_santa_isabel"
            },
            {
              "name": "UTC -07:00 America Tijuana",
              "value": "america_slash_tijuana"
            },
            {
              "name": "UTC -07:00 America Vancouver",
              "value": "america_slash_vancouver"
            },
            {
              "name": "UTC -07:00 America Whitehorse",
              "value": "america_slash_whitehorse"
            },
            {
              "name": "UTC -07:00 Canada Pacific",
              "value": "canada_slash_pacific"
            },
            {
              "name": "UTC -07:00 Canada Yukon",
              "value": "canada_slash_yukon"
            },
            {
              "name": "UTC -07:00 Mexico BajaNorte",
              "value": "mexico_slash_bajanorte"
            },
            {
              "name": "UTC -07:00 US Arizona",
              "value": "us_slash_arizona"
            },
            {
              "name": "UTC -07:00 US Pacific",
              "value": "us_slash_pacific"
            },
            {
              "name": "UTC -07:00 US Pacific-New",
              "value": "us_slash_pacific_hyphen_new"
            },
            {
              "name": "UTC -08:00 America Anchorage",
              "value": "america_slash_anchorage"
            },
            {
              "name": "UTC -08:00 America Juneau",
              "value": "america_slash_juneau"
            },
            {
              "name": "UTC -08:00 America Metlakatla",
              "value": "america_slash_metlakatla"
            },
            {
              "name": "UTC -08:00 America Nome",
              "value": "america_slash_nome"
            },
            {
              "name": "UTC -08:00 America Sitka",
              "value": "america_slash_sitka"
            },
            {
              "name": "UTC -08:00 America Yakutat",
              "value": "america_slash_yakutat"
            },
            {
              "name": "UTC -08:00 Pacific Pitcairn",
              "value": "pacific_slash_pitcairn"
            },
            {
              "name": "UTC -08:00 US Alaska",
              "value": "us_slash_alaska"
            },
            {
              "name": "UTC -09:00 America Adak",
              "value": "america_slash_adak"
            },
            {
              "name": "UTC -09:00 America Atka",
              "value": "america_slash_atka"
            },
            {
              "name": "UTC -09:00 Pacific Gambier",
              "value": "pacific_slash_gambier"
            },
            {
              "name": "UTC -09:00 US Aleutian",
              "value": "us_slash_aleutian"
            },
            {
              "name": "UTC -09:30 Pacific Marquesas",
              "value": "pacific_slash_marquesas"
            },
            {
              "name": "UTC -10:00 Pacific Honolulu",
              "value": "pacific_slash_honolulu"
            },
            {
              "name": "UTC -10:00 Pacific Johnston",
              "value": "pacific_slash_johnston"
            },
            {
              "name": "UTC -10:00 Pacific Rarotonga",
              "value": "pacific_slash_rarotonga"
            },
            {
              "name": "UTC -10:00 Pacific Tahiti",
              "value": "pacific_slash_tahiti"
            },
            {
              "name": "UTC -10:00 US Hawaii",
              "value": "us_slash_hawaii"
            },
            {
              "name": "UTC -11:00 Pacific Midway",
              "value": "pacific_slash_midway"
            },
            {
              "name": "UTC -11:00 Pacific Niue",
              "value": "pacific_slash_niue"
            },
            {
              "name": "UTC -11:00 Pacific Pago Pago",
              "value": "pacific_slash_pago_pago"
            },
            {
              "name": "UTC -11:00 Pacific Samoa",
              "value": "pacific_slash_samoa"
            },
            {
              "name": "UTC -11:00 US Samoa",
              "value": "us_slash_samoa"
            },
            {
              "name": "UTC +00:00 Africa Abidjan",
              "value": "africa_slash_abidjan"
            },
            {
              "name": "UTC +00:00 Africa Accra",
              "value": "africa_slash_accra"
            },
            {
              "name": "UTC +00:00 Africa Bamako",
              "value": "africa_slash_bamako"
            },
            {
              "name": "UTC +00:00 Africa Banjul",
              "value": "africa_slash_banjul"
            },
            {
              "name": "UTC +00:00 Africa Bissau",
              "value": "africa_slash_bissau"
            },
            {
              "name": "UTC +00:00 Africa Conakry",
              "value": "africa_slash_conakry"
            },
            {
              "name": "UTC +00:00 Africa Dakar",
              "value": "africa_slash_dakar"
            },
            {
              "name": "UTC +00:00 Africa Freetown",
              "value": "africa_slash_freetown"
            },
            {
              "name": "UTC +00:00 Africa Lome",
              "value": "africa_slash_lome"
            },
            {
              "name": "UTC +00:00 Africa Monrovia",
              "value": "africa_slash_monrovia"
            },
            {
              "name": "UTC +00:00 Africa Nouakchott",
              "value": "africa_slash_nouakchott"
            },
            {
              "name": "UTC +00:00 Africa Ouagadougou",
              "value": "africa_slash_ouagadougou"
            },
            {
              "name": "UTC +00:00 Africa Timbuktu",
              "value": "africa_slash_timbuktu"
            },
            {
              "name": "UTC +00:00 America Danmarkshavn",
              "value": "america_slash_danmarkshavn"
            },
            {
              "name": "UTC +00:00 America Scoresbysund",
              "value": "america_slash_scoresbysund"
            },
            {
              "name": "UTC +00:00 Atlantic Azores",
              "value": "atlantic_slash_azores"
            },
            {
              "name": "UTC +00:00 Atlantic Reykjavik",
              "value": "atlantic_slash_reykjavik"
            },
            {
              "name": "UTC +00:00 Atlantic St Helena",
              "value": "atlantic_slash_st_helena"
            },
            {
              "name": "UTC +00:00 Europe Iceland",
              "value": "iceland"
            },
            {
              "name": "UTC +01:00 Africa Algiers",
              "value": "africa_slash_algiers"
            },
            {
              "name": "UTC +01:00 Africa Bangui",
              "value": "africa_slash_bangui"
            },
            {
              "name": "UTC +01:00 Africa Brazzaville",
              "value": "africa_slash_brazzaville"
            },
            {
              "name": "UTC +01:00 Africa Casablanca",
              "value": "africa_slash_casablanca"
            },
            {
              "name": "UTC +01:00 Africa Douala",
              "value": "africa_slash_douala"
            },
            {
              "name": "UTC +01:00 Africa El Aaiun",
              "value": "africa_slash_el_aaiun"
            },
            {
              "name": "UTC +01:00 Africa Kinshasa",
              "value": "africa_slash_kinshasa"
            },
            {
              "name": "UTC +01:00 Africa Lagos",
              "value": "africa_slash_lagos"
            },
            {
              "name": "UTC +01:00 Africa Libreville",
              "value": "africa_slash_libreville"
            },
            {
              "name": "UTC +01:00 Africa Luanda",
              "value": "africa_slash_luanda"
            },
            {
              "name": "UTC +01:00 Africa Malabo",
              "value": "africa_slash_malabo"
            },
            {
              "name": "UTC +01:00 Africa Ndjamena",
              "value": "africa_slash_ndjamena"
            },
            {
              "name": "UTC +01:00 Africa Niamey",
              "value": "africa_slash_niamey"
            },
            {
              "name": "UTC +01:00 Africa Porto-Novo",
              "value": "africa_slash_porto_hyphen_novo"
            },
            {
              "name": "UTC +01:00 Africa Sao Tome",
              "value": "africa_slash_sao_tome"
            },
            {
              "name": "UTC +01:00 Africa Tunis",
              "value": "africa_slash_tunis"
            },
            {
              "name": "UTC +01:00 Atlantic Canary",
              "value": "atlantic_slash_canary"
            },
            {
              "name": "UTC +01:00 Atlantic Faeroe",
              "value": "atlantic_slash_faeroe"
            },
            {
              "name": "UTC +01:00 Atlantic Faroe",
              "value": "atlantic_slash_faroe"
            },
            {
              "name": "UTC +01:00 Atlantic Madeira",
              "value": "atlantic_slash_madeira"
            },
            {
              "name": "UTC +01:00 Europe Belfast",
              "value": "europe_slash_belfast"
            },
            {
              "name": "UTC +01:00 Europe Dublin",
              "value": "europe_slash_dublin"
            },
            {
              "name": "UTC +01:00 Europe Eire",
              "value": "eire"
            },
            {
              "name": "UTC +01:00 Europe Guernsey",
              "value": "europe_slash_guernsey"
            },
            {
              "name": "UTC +01:00 Europe Isle of Man",
              "value": "europe_slash_isle_of_man"
            },
            {
              "name": "UTC +01:00 Europe Jersey",
              "value": "europe_slash_jersey"
            },
            {
              "name": "UTC +01:00 Europe Lisbon",
              "value": "europe_slash_lisbon"
            },
            {
              "name": "UTC +01:00 Europe London",
              "value": "europe_slash_london"
            },
            {
              "name": "UTC +01:00 Europe Portugal",
              "value": "portugal"
            },
            {
              "name": "UTC +02:00 Africa Blantyre",
              "value": "africa_slash_blantyre"
            },
            {
              "name": "UTC +02:00 Africa Bujumbura",
              "value": "africa_slash_bujumbura"
            },
            {
              "name": "UTC +02:00 Africa Cairo",
              "value": "africa_slash_cairo"
            },
            {
              "name": "UTC +02:00 Africa Ceuta",
              "value": "africa_slash_ceuta"
            },
            {
              "name": "UTC +02:00 Africa Egypt",
              "value": "egypt"
            },
            {
              "name": "UTC +02:00 Africa Gaborone",
              "value": "africa_slash_gaborone"
            },
            {
              "name": "UTC +02:00 Africa Harare",
              "value": "africa_slash_harare"
            },
            {
              "name": "UTC +02:00 Africa Johannesburg",
              "value": "africa_slash_johannesburg"
            },
            {
              "name": "UTC +02:00 Africa Khartoum",
              "value": "africa_slash_khartoum"
            },
            {
              "name": "UTC +02:00 Africa Kigali",
              "value": "africa_slash_kigali"
            },
            {
              "name": "UTC +02:00 Africa Libya",
              "value": "libya"
            },
            {
              "name": "UTC +02:00 Africa Lubumbashi",
              "value": "africa_slash_lubumbashi"
            },
            {
              "name": "UTC +02:00 Africa Lusaka",
              "value": "africa_slash_lusaka"
            },
            {
              "name": "UTC +02:00 Africa Maputo",
              "value": "africa_slash_maputo"
            },
            {
              "name": "UTC +02:00 Africa Maseru",
              "value": "africa_slash_maseru"
            },
            {
              "name": "UTC +02:00 Africa Mbabane",
              "value": "africa_slash_mbabane"
            },
            {
              "name": "UTC +02:00 Africa Tripoli",
              "value": "africa_slash_tripoli"
            },
            {
              "name": "UTC +02:00 Africa Windhoek",
              "value": "africa_slash_windhoek"
            },
            {
              "name": "UTC +02:00 Antarctica Troll",
              "value": "antarctica_slash_troll"
            },
            {
              "name": "UTC +02:00 Arctic Longyearbyen",
              "value": "arctic_slash_longyearbyen"
            },
            {
              "name": "UTC +02:00 Atlantic Jan Mayen",
              "value": "atlantic_slash_jan_mayen"
            },
            {
              "name": "UTC +02:00 Europe Amsterdam",
              "value": "europe_slash_amsterdam"
            },
            {
              "name": "UTC +02:00 Europe Andorra",
              "value": "europe_slash_andorra"
            },
            {
              "name": "UTC +02:00 Europe Belgrade",
              "value": "europe_slash_belgrade"
            },
            {
              "name": "UTC +02:00 Europe Berlin",
              "value": "europe_slash_berlin"
            },
            {
              "name": "UTC +02:00 Europe Bratislava",
              "value": "europe_slash_bratislava"
            },
            {
              "name": "UTC +02:00 Europe Brussels",
              "value": "europe_slash_brussels"
            },
            {
              "name": "UTC +02:00 Europe Budapest",
              "value": "europe_slash_budapest"
            },
            {
              "name": "UTC +02:00 Europe Busingen",
              "value": "europe_slash_busingen"
            },
            {
              "name": "UTC +02:00 Europe Copenhagen",
              "value": "europe_slash_copenhagen"
            },
            {
              "name": "UTC +02:00 Europe Gibraltar",
              "value": "europe_slash_gibraltar"
            },
            {
              "name": "UTC +02:00 Europe Kaliningrad",
              "value": "europe_slash_kaliningrad"
            },
            {
              "name": "UTC +02:00 Europe Ljubljana",
              "value": "europe_slash_ljubljana"
            },
            {
              "name": "UTC +02:00 Europe Luxembourg",
              "value": "europe_slash_luxembourg"
            },
            {
              "name": "UTC +02:00 Europe Madrid",
              "value": "europe_slash_madrid"
            },
            {
              "name": "UTC +02:00 Europe Malta",
              "value": "europe_slash_malta"
            },
            {
              "name": "UTC +02:00 Europe Monaco",
              "value": "europe_slash_monaco"
            },
            {
              "name": "UTC +02:00 Europe Oslo",
              "value": "europe_slash_oslo"
            },
            {
              "name": "UTC +02:00 Europe Paris",
              "value": "europe_slash_paris"
            },
            {
              "name": "UTC +02:00 Europe Podgorica",
              "value": "europe_slash_podgorica"
            },
            {
              "name": "UTC +02:00 Europe Poland",
              "value": "poland"
            },
            {
              "name": "UTC +02:00 Europe Prague",
              "value": "europe_slash_prague"
            },
            {
              "name": "UTC +02:00 Europe Rome",
              "value": "europe_slash_rome"
            },
            {
              "name": "UTC +02:00 Europe San Marino",
              "value": "europe_slash_san_marino"
            },
            {
              "name": "UTC +02:00 Europe Sarajevo",
              "value": "europe_slash_sarajevo"
            },
            {
              "name": "UTC +02:00 Europe Skopje",
              "value": "europe_slash_skopje"
            },
            {
              "name": "UTC +02:00 Europe Stockholm",
              "value": "europe_slash_stockholm"
            },
            {
              "name": "UTC +02:00 Europe Tirane",
              "value": "europe_slash_tirane"
            },
            {
              "name": "UTC +02:00 Europe Vaduz",
              "value": "europe_slash_vaduz"
            },
            {
              "name": "UTC +02:00 Europe Vatican",
              "value": "europe_slash_vatican"
            },
            {
              "name": "UTC +02:00 Europe Vienna",
              "value": "europe_slash_vienna"
            },
            {
              "name": "UTC +02:00 Europe Warsaw",
              "value": "europe_slash_warsaw"
            },
            {
              "name": "UTC +02:00 Europe Zagreb",
              "value": "europe_slash_zagreb"
            },
            {
              "name": "UTC +02:00 Europe Zurich",
              "value": "europe_slash_zurich"
            },
            {
              "name": "UTC +03:00 Africa Addis Ababa",
              "value": "africa_slash_addis_ababa"
            },
            {
              "name": "UTC +03:00 Africa Asmara",
              "value": "africa_slash_asmara"
            },
            {
              "name": "UTC +03:00 Africa Asmera",
              "value": "africa_slash_asmera"
            },
            {
              "name": "UTC +03:00 Africa Dar Es Salaam",
              "value": "africa_slash_dar_es_salaam"
            },
            {
              "name": "UTC +03:00 Africa Djibouti",
              "value": "africa_slash_djibouti"
            },
            {
              "name": "UTC +03:00 Africa Juba",
              "value": "africa_slash_juba"
            },
            {
              "name": "UTC +03:00 Africa Kampala",
              "value": "africa_slash_kampala"
            },
            {
              "name": "UTC +03:00 Africa Mogadishu",
              "value": "africa_slash_mogadishu"
            },
            {
              "name": "UTC +03:00 Africa Nairobi",
              "value": "africa_slash_nairobi"
            },
            {
              "name": "UTC +03:00 Antarctica Syowa",
              "value": "antarctica_slash_syowa"
            },
            {
              "name": "UTC +03:00 Asia Aden",
              "value": "asia_slash_aden"
            },
            {
              "name": "UTC +03:00 Asia Amman",
              "value": "asia_slash_amman"
            },
            {
              "name": "UTC +03:00 Asia Baghdad",
              "value": "asia_slash_baghdad"
            },
            {
              "name": "UTC +03:00 Asia Bahrain",
              "value": "asia_slash_bahrain"
            },
            {
              "name": "UTC +03:00 Asia Beirut",
              "value": "asia_slash_beirut"
            },
            {
              "name": "UTC +03:00 Asia Damascus",
              "value": "asia_slash_damascus"
            },
            {
              "name": "UTC +03:00 Asia Famagusta",
              "value": "asia_slash_famagusta"
            },
            {
              "name": "UTC +03:00 Asia Gaza",
              "value": "asia_slash_gaza"
            },
            {
              "name": "UTC +03:00 Asia Hebron",
              "value": "asia_slash_hebron"
            },
            {
              "name": "UTC +03:00 Asia Israel",
              "value": "israel"
            },
            {
              "name": "UTC +03:00 Asia Istanbul",
              "value": "asia_slash_istanbul"
            },
            {
              "name": "UTC +03:00 Asia Jerusalem",
              "value": "asia_slash_jerusalem"
            },
            {
              "name": "UTC +03:00 Asia Kuwait",
              "value": "asia_slash_kuwait"
            },
            {
              "name": "UTC +03:00 Asia Nicosia",
              "value": "asia_slash_nicosia"
            },
            {
              "name": "UTC +03:00 Asia Qatar",
              "value": "asia_slash_qatar"
            },
            {
              "name": "UTC +03:00 Asia Riyadh",
              "value": "asia_slash_riyadh"
            },
            {
              "name": "UTC +03:00 Asia Tel Aviv",
              "value": "asia_slash_tel_aviv"
            },
            {
              "name": "UTC +03:00 Asia Türkiye",
              "value": "turkey"
            },
            {
              "name": "UTC +03:00 Europe Athens",
              "value": "europe_slash_athens"
            },
            {
              "name": "UTC +03:00 Europe Bucharest",
              "value": "europe_slash_bucharest"
            },
            {
              "name": "UTC +03:00 Europe Chisinau",
              "value": "europe_slash_chisinau"
            },
            {
              "name": "UTC +03:00 Europe Helsinki",
              "value": "europe_slash_helsinki"
            },
            {
              "name": "UTC +03:00 Europe Istanbul",
              "value": "europe_slash_istanbul"
            },
            {
              "name": "UTC +03:00 Europe Kirov",
              "value": "europe_slash_kirov"
            },
            {
              "name": "UTC +03:00 Europe Kyiv",
              "value": "europe_slash_kiev"
            },
            {
              "name": "UTC +03:00 Europe Mariehamn",
              "value": "europe_slash_mariehamn"
            },
            {
              "name": "UTC +03:00 Europe Minsk",
              "value": "europe_slash_minsk"
            },
            {
              "name": "UTC +03:00 Europe Moscow",
              "value": "europe_slash_moscow"
            },
            {
              "name": "UTC +03:00 Europe Nicosia",
              "value": "europe_slash_nicosia"
            },
            {
              "name": "UTC +03:00 Europe Riga",
              "value": "europe_slash_riga"
            },
            {
              "name": "UTC +03:00 Europe Simferopol",
              "value": "europe_slash_simferopol"
            },
            {
              "name": "UTC +03:00 Europe Sofia",
              "value": "europe_slash_sofia"
            },
            {
              "name": "UTC +03:00 Europe Tallinn",
              "value": "europe_slash_tallinn"
            },
            {
              "name": "UTC +03:00 Europe Tiraspol",
              "value": "europe_slash_tiraspol"
            },
            {
              "name": "UTC +03:00 Europe Uzhgorod",
              "value": "europe_slash_uzhgorod"
            },
            {
              "name": "UTC +03:00 Europe Vilnius",
              "value": "europe_slash_vilnius"
            },
            {
              "name": "UTC +03:00 Europe Zaporizhzhia",
              "value": "europe_slash_zaporozhye"
            },
            {
              "name": "UTC +03:00 Indian Antananarivo",
              "value": "indian_slash_antananarivo"
            },
            {
              "name": "UTC +03:00 Indian Comoro",
              "value": "indian_slash_comoro"
            },
            {
              "name": "UTC +03:00 Indian Mayotte",
              "value": "indian_slash_mayotte"
            },
            {
              "name": "UTC +04:00 Asia Baku",
              "value": "asia_slash_baku"
            },
            {
              "name": "UTC +04:00 Asia Dubai",
              "value": "asia_slash_dubai"
            },
            {
              "name": "UTC +04:00 Asia Muscat",
              "value": "asia_slash_muscat"
            },
            {
              "name": "UTC +04:00 Asia Tbilisi",
              "value": "asia_slash_tbilisi"
            },
            {
              "name": "UTC +04:00 Asia Yerevan",
              "value": "asia_slash_yerevan"
            },
            {
              "name": "UTC +04:00 Europe Astrakhan",
              "value": "europe_slash_astrakhan"
            },
            {
              "name": "UTC +04:00 Europe Samara",
              "value": "europe_slash_samara"
            },
            {
              "name": "UTC +04:00 Europe Saratov",
              "value": "europe_slash_saratov"
            },
            {
              "name": "UTC +04:00 Europe Ulyanovsk",
              "value": "europe_slash_ulyanovsk"
            },
            {
              "name": "UTC +04:00 Europe Volgograd",
              "value": "europe_slash_volgograd"
            },
            {
              "name": "UTC +04:00 Indian Mahe",
              "value": "indian_slash_mahe"
            },
            {
              "name": "UTC +04:00 Indian Mauritius",
              "value": "indian_slash_mauritius"
            },
            {
              "name": "UTC +04:00 Indian Reunion",
              "value": "indian_slash_reunion"
            },
            {
              "name": "UTC +04:30 Asia Iran",
              "value": "iran"
            },
            {
              "name": "UTC +04:30 Asia Kabul",
              "value": "asia_slash_kabul"
            },
            {
              "name": "UTC +04:30 Asia Tehran",
              "value": "asia_slash_tehran"
            },
            {
              "name": "UTC +05:00 Antarctica Mawson",
              "value": "antarctica_slash_mawson"
            },
            {
              "name": "UTC +05:00 Asia Aqtau",
              "value": "asia_slash_aqtau"
            },
            {
              "name": "UTC +05:00 Asia Aqtobe",
              "value": "asia_slash_aqtobe"
            },
            {
              "name": "UTC +05:00 Asia Ashgabat",
              "value": "asia_slash_ashgabat"
            },
            {
              "name": "UTC +05:00 Asia Ashkhabad",
              "value": "asia_slash_ashkhabad"
            },
            {
              "name": "UTC +05:00 Asia Atyrau",
              "value": "asia_slash_atyrau"
            },
            {
              "name": "UTC +05:00 Asia Dushanbe",
              "value": "asia_slash_dushanbe"
            },
            {
              "name": "UTC +05:00 Asia Karachi",
              "value": "asia_slash_karachi"
            },
            {
              "name": "UTC +05:00 Asia Oral",
              "value": "asia_slash_oral"
            },
            {
              "name": "UTC +05:00 Asia Samarkand",
              "value": "asia_slash_samarkand"
            },
            {
              "name": "UTC +05:00 Asia Tashkent",
              "value": "asia_slash_tashkent"
            },
            {
              "name": "UTC +05:00 Asia Yekaterinburg",
              "value": "asia_slash_yekaterinburg"
            },
            {
              "name": "UTC +05:00 Indian Kerguelen",
              "value": "indian_slash_kerguelen"
            },
            {
              "name": "UTC +05:00 Indian Maldives",
              "value": "indian_slash_maldives"
            },
            {
              "name": "UTC +05:30 Asia Calcutta",
              "value": "asia_slash_calcutta"
            },
            {
              "name": "UTC +05:30 Asia Colombo",
              "value": "asia_slash_colombo"
            },
            {
              "name": "UTC +05:30 Asia Kolkata",
              "value": "asia_slash_kolkata"
            },
            {
              "name": "UTC +05:45 Asia Kathmandu",
              "value": "asia_slash_kathmandu"
            },
            {
              "name": "UTC +05:45 Asia Katmandu",
              "value": "asia_slash_katmandu"
            },
            {
              "name": "UTC +06:00 Antarctica Vostok",
              "value": "antarctica_slash_vostok"
            },
            {
              "name": "UTC +06:00 Asia Almaty",
              "value": "asia_slash_almaty"
            },
            {
              "name": "UTC +06:00 Asia Bishkek",
              "value": "asia_slash_bishkek"
            },
            {
              "name": "UTC +06:00 Asia Dacca",
              "value": "asia_slash_dacca"
            },
            {
              "name": "UTC +06:00 Asia Dhaka",
              "value": "asia_slash_dhaka"
            },
            {
              "name": "UTC +06:00 Asia Kashgar",
              "value": "asia_slash_kashgar"
            },
            {
              "name": "UTC +06:00 Asia Omsk",
              "value": "asia_slash_omsk"
            },
            {
              "name": "UTC +06:00 Asia Qyzylorda",
              "value": "asia_slash_qyzylorda"
            },
            {
              "name": "UTC +06:00 Asia Thimbu",
              "value": "asia_slash_thimbu"
            },
            {
              "name": "UTC +06:00 Asia Thimphu",
              "value": "asia_slash_thimphu"
            },
            {
              "name": "UTC +06:00 Asia Urumqi",
              "value": "asia_slash_urumqi"
            },
            {
              "name": "UTC +06:00 Indian Chagos",
              "value": "indian_slash_chagos"
            },
            {
              "name": "UTC +06:30 Asia Rangoon",
              "value": "asia_slash_rangoon"
            },
            {
              "name": "UTC +06:30 Asia Yangon",
              "value": "asia_slash_yangon"
            },
            {
              "name": "UTC +06:30 Indian Cocos",
              "value": "indian_slash_cocos"
            },
            {
              "name": "UTC +07:00 Antarctica Davis",
              "value": "antarctica_slash_davis"
            },
            {
              "name": "UTC +07:00 Asia Bangkok",
              "value": "asia_slash_bangkok"
            },
            {
              "name": "UTC +07:00 Asia Barnaul",
              "value": "asia_slash_barnaul"
            },
            {
              "name": "UTC +07:00 Asia Ho Chi Minh",
              "value": "asia_slash_ho_chi_minh"
            },
            {
              "name": "UTC +07:00 Asia Hovd",
              "value": "asia_slash_hovd"
            },
            {
              "name": "UTC +07:00 Asia Jakarta",
              "value": "asia_slash_jakarta"
            },
            {
              "name": "UTC +07:00 Asia Krasnoyarsk",
              "value": "asia_slash_krasnoyarsk"
            },
            {
              "name": "UTC +07:00 Asia Novokuznetsk",
              "value": "asia_slash_novokuznetsk"
            },
            {
              "name": "UTC +07:00 Asia Novosibirsk",
              "value": "asia_slash_novosibirsk"
            },
            {
              "name": "UTC +07:00 Asia Phnom Penh",
              "value": "asia_slash_phnom_penh"
            },
            {
              "name": "UTC +07:00 Asia Pontianak",
              "value": "asia_slash_pontianak"
            },
            {
              "name": "UTC +07:00 Asia Saigon",
              "value": "asia_slash_saigon"
            },
            {
              "name": "UTC +07:00 Asia Tomsk",
              "value": "asia_slash_tomsk"
            },
            {
              "name": "UTC +07:00 Asia Vientiane",
              "value": "asia_slash_vientiane"
            },
            {
              "name": "UTC +07:00 Indian Christmas",
              "value": "indian_slash_christmas"
            },
            {
              "name": "UTC +08:00 Antarctica Casey",
              "value": "antarctica_slash_casey"
            },
            {
              "name": "UTC +08:00 Asia Brunei",
              "value": "asia_slash_brunei"
            },
            {
              "name": "UTC +08:00 Asia Choibalsan",
              "value": "asia_slash_choibalsan"
            },
            {
              "name": "UTC +08:00 Asia Chongqing",
              "value": "asia_slash_chongqing"
            },
            {
              "name": "UTC +08:00 Asia Chungking",
              "value": "asia_slash_chungking"
            },
            {
              "name": "UTC +08:00 Asia Harbin",
              "value": "asia_slash_harbin"
            },
            {
              "name": "UTC +08:00 Asia Hong Kong",
              "value": "asia_slash_hong_kong"
            },
            {
              "name": "UTC +08:00 Asia Irkutsk",
              "value": "asia_slash_irkutsk"
            },
            {
              "name": "UTC +08:00 Asia Kuala Lumpur",
              "value": "asia_slash_kuala_lumpur"
            },
            {
              "name": "UTC +08:00 Asia Kuching",
              "value": "asia_slash_kuching"
            },
            {
              "name": "UTC +08:00 Asia Macao",
              "value": "asia_slash_macao"
            },
            {
              "name": "UTC +08:00 Asia Macau",
              "value": "asia_slash_macau"
            },
            {
              "name": "UTC +08:00 Asia Makassar",
              "value": "asia_slash_makassar"
            },
            {
              "name": "UTC +08:00 Asia Manila",
              "value": "asia_slash_manila"
            },
            {
              "name": "UTC +08:00 Asia Shanghai",
              "value": "asia_slash_shanghai"
            },
            {
              "name": "UTC +08:00 Asia Singapore",
              "value": "asia_slash_singapore"
            },
            {
              "name": "UTC +08:00 Asia Taipei",
              "value": "asia_slash_taipei"
            },
            {
              "name": "UTC +08:00 Asia Ujung Pandang",
              "value": "asia_slash_ujung_pandang"
            },
            {
              "name": "UTC +08:00 Asia Ulaanbaatar",
              "value": "asia_slash_ulaanbaatar"
            },
            {
              "name": "UTC +08:00 Asia Ulan Bator",
              "value": "asia_slash_ulan_bator"
            },
            {
              "name": "UTC +08:00 Australia Perth",
              "value": "australia_slash_perth"
            },
            {
              "name": "UTC +08:00 Australia West",
              "value": "australia_slash_west"
            },
            {
              "name": "UTC +08:45 Australia Eucla",
              "value": "australia_slash_eucla"
            },
            {
              "name": "UTC +09:00 Asia Chita",
              "value": "asia_slash_chita"
            },
            {
              "name": "UTC +09:00 Asia Dili",
              "value": "asia_slash_dili"
            },
            {
              "name": "UTC +09:00 Asia Japan",
              "value": "japan"
            },
            {
              "name": "UTC +09:00 Asia Jayapura",
              "value": "asia_slash_jayapura"
            },
            {
              "name": "UTC +09:00 Asia Khandyga",
              "value": "asia_slash_khandyga"
            },
            {
              "name": "UTC +09:00 Asia Pyongyang",
              "value": "asia_slash_pyongyang"
            },
            {
              "name": "UTC +09:00 Asia Seoul",
              "value": "asia_slash_seoul"
            },
            {
              "name": "UTC +09:00 Asia Tokyo",
              "value": "asia_slash_tokyo"
            },
            {
              "name": "UTC +09:00 Asia Yakutsk",
              "value": "asia_slash_yakutsk"
            },
            {
              "name": "UTC +09:00 Pacific Palau",
              "value": "pacific_slash_palau"
            },
            {
              "name": "UTC +09:30 Australia Adelaide",
              "value": "australia_slash_adelaide"
            },
            {
              "name": "UTC +09:30 Australia Broken Hill",
              "value": "australia_slash_broken_hill"
            },
            {
              "name": "UTC +09:30 Australia Darwin",
              "value": "australia_slash_darwin"
            },
            {
              "name": "UTC +09:30 Australia North",
              "value": "australia_slash_north"
            },
            {
              "name": "UTC +09:30 Australia South",
              "value": "australia_slash_south"
            },
            {
              "name": "UTC +09:30 Australia Yancowinna",
              "value": "australia_slash_yancowinna"
            },
            {
              "name": "UTC +10:00 Antarctica DumontDUrville",
              "value": "antarctica_slash_dumontdurville"
            },
            {
              "name": "UTC +10:00 Asia Ust-Nera",
              "value": "asia_slash_ust_hyphen_nera"
            },
            {
              "name": "UTC +10:00 Asia Vladivostok",
              "value": "asia_slash_vladivostok"
            },
            {
              "name": "UTC +10:00 Australia ACT",
              "value": "australia_slash_act"
            },
            {
              "name": "UTC +10:00 Australia Brisbane",
              "value": "australia_slash_brisbane"
            },
            {
              "name": "UTC +10:00 Australia Canberra",
              "value": "australia_slash_canberra"
            },
            {
              "name": "UTC +10:00 Australia Currie",
              "value": "australia_slash_currie"
            },
            {
              "name": "UTC +10:00 Australia Hobart",
              "value": "australia_slash_hobart"
            },
            {
              "name": "UTC +10:00 Australia Lindeman",
              "value": "australia_slash_lindeman"
            },
            {
              "name": "UTC +10:00 Australia Melbourne",
              "value": "australia_slash_melbourne"
            },
            {
              "name": "UTC +10:00 Australia NSW",
              "value": "australia_slash_nsw"
            },
            {
              "name": "UTC +10:00 Australia Queensland",
              "value": "australia_slash_queensland"
            },
            {
              "name": "UTC +10:00 Australia Sydney",
              "value": "australia_slash_sydney"
            },
            {
              "name": "UTC +10:00 Australia Tasmania",
              "value": "australia_slash_tasmania"
            },
            {
              "name": "UTC +10:00 Australia Victoria",
              "value": "australia_slash_victoria"
            },
            {
              "name": "UTC +10:00 Pacific Chuuk",
              "value": "pacific_slash_chuuk"
            },
            {
              "name": "UTC +10:00 Pacific Guam",
              "value": "pacific_slash_guam"
            },
            {
              "name": "UTC +10:00 Pacific Port Moresby",
              "value": "pacific_slash_port_moresby"
            },
            {
              "name": "UTC +10:00 Pacific Saipan",
              "value": "pacific_slash_saipan"
            },
            {
              "name": "UTC +10:00 Pacific Truk",
              "value": "pacific_slash_truk"
            },
            {
              "name": "UTC +10:00 Pacific Yap",
              "value": "pacific_slash_yap"
            },
            {
              "name": "UTC +10:30 Australia LHI",
              "value": "australia_slash_lhi"
            },
            {
              "name": "UTC +10:30 Australia Lord Howe",
              "value": "australia_slash_lord_howe"
            },
            {
              "name": "UTC +11:00 Antarctica Macquarie",
              "value": "antarctica_slash_macquarie"
            },
            {
              "name": "UTC +11:00 Asia Magadan",
              "value": "asia_slash_magadan"
            },
            {
              "name": "UTC +11:00 Asia Sakhalin",
              "value": "asia_slash_sakhalin"
            },
            {
              "name": "UTC +11:00 Asia Srednekolymsk",
              "value": "asia_slash_srednekolymsk"
            },
            {
              "name": "UTC +11:00 Pacific Bougainville",
              "value": "pacific_slash_bougainville"
            },
            {
              "name": "UTC +11:00 Pacific Efate",
              "value": "pacific_slash_efate"
            },
            {
              "name": "UTC +11:00 Pacific Guadalcanal",
              "value": "pacific_slash_guadalcanal"
            },
            {
              "name": "UTC +11:00 Pacific Kosrae",
              "value": "pacific_slash_kosrae"
            },
            {
              "name": "UTC +11:00 Pacific Norfolk",
              "value": "pacific_slash_norfolk"
            },
            {
              "name": "UTC +11:00 Pacific Noumea",
              "value": "pacific_slash_noumea"
            },
            {
              "name": "UTC +11:00 Pacific Pohnpei",
              "value": "pacific_slash_pohnpei"
            },
            {
              "name": "UTC +11:00 Pacific Ponape",
              "value": "pacific_slash_ponape"
            },
            {
              "name": "UTC +12:00 Antarctica McMurdo",
              "value": "antarctica_slash_mcmurdo"
            },
            {
              "name": "UTC +12:00 Antarctica South Pole",
              "value": "antarctica_slash_south_pole"
            },
            {
              "name": "UTC +12:00 Asia Anadyr",
              "value": "asia_slash_anadyr"
            },
            {
              "name": "UTC +12:00 Asia Kamchatka",
              "value": "asia_slash_kamchatka"
            },
            {
              "name": "UTC +12:00 Pacific Auckland",
              "value": "pacific_slash_auckland"
            },
            {
              "name": "UTC +12:00 Pacific Fiji",
              "value": "pacific_slash_fiji"
            },
            {
              "name": "UTC +12:00 Pacific Funafuti",
              "value": "pacific_slash_funafuti"
            },
            {
              "name": "UTC +12:00 Pacific Kwajalein",
              "value": "kwajalein"
            },
            {
              "name": "UTC +12:00 Pacific Majuro",
              "value": "pacific_slash_majuro"
            },
            {
              "name": "UTC +12:00 Pacific Nauru",
              "value": "pacific_slash_nauru"
            },
            {
              "name": "UTC +12:00 Pacific Tarawa",
              "value": "pacific_slash_tarawa"
            },
            {
              "name": "UTC +12:00 Pacific Wake",
              "value": "pacific_slash_wake"
            },
            {
              "name": "UTC +12:00 Pacific Wallis",
              "value": "pacific_slash_wallis"
            },
            {
              "name": "UTC +12:45 Pacific Chatham",
              "value": "pacific_slash_chatham"
            },
            {
              "name": "UTC +13:00 Pacific Apia",
              "value": "pacific_slash_apia"
            },
            {
              "name": "UTC +13:00 Pacific Enderbury",
              "value": "pacific_slash_enderbury"
            },
            {
              "name": "UTC +13:00 Pacific Fakaofo",
              "value": "pacific_slash_fakaofo"
            },
            {
              "name": "UTC +13:00 Pacific Tongatapu",
              "value": "pacific_slash_tongatapu"
            },
            {
              "name": "UTC +14:00 Pacific Kiritimati",
              "value": "pacific_slash_kiritimati"
            }
          ]
        },
        {
          "displayName": "Twitter Username",
          "name": "twitterUsername",
          "type": "string",
          "default": "",
          "description": "The contact's Twitter handle. This is set by HubSpot using the contact's email address."
        },
        {
          "displayName": "Website URL",
          "name": "websiteUrl",
          "type": "string",
          "default": "",
          "description": "The contact's company website"
        },
        {
          "displayName": "WhatsApp Phone Number",
          "name": "whatsappPhoneNumber",
          "description": "The phone number associated with the contact’s WhatsApp account",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Work Email",
          "name": "workEmail",
          "type": "string",
          "default": "",
          "description": "A contact's work email. This property is required for the Facebook Ads Integration. This property will be automatically synced via the Lead Ads tool"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "contact"
          ],
          "operation": [
            "upsert"
          ]
        }
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Simplify Output",
          "name": "resolveData",
          "type": "boolean",
          "default": false,
          "description": "By default the response only includes the ID. If this option gets activated, it will resolve the data automatically."
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "contact"
          ],
          "operation": [
            "upsert"
          ]
        }
      }
    },
    {
      "displayName": "Contact to Get",
      "name": "contactId",
      "type": "resourceLocator",
      "default": {
        "mode": "list",
        "value": ""
      },
      "description": "This is not a contact's email but a number like 1485",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "contact"
          ],
          "operation": [
            "get"
          ]
        }
      },
      "modes": [
        {
          "displayName": "From List",
          "name": "list",
          "type": "list",
          "placeholder": "Select from the list",
          "typeOptions": {
            "searchListMethod": "searchContacts",
            "searchable": true
          }
        },
        {
          "displayName": "By Id",
          "name": "id",
          "type": "string",
          "placeholder": "58539222",
          "validation": [
            {
              "type": "regex",
              "properties": {
                "regex": "[0-9]+",
                "errorMessage": "Not a valid HubSpot Contact ID"
              }
            }
          ]
        }
      ]
    },
    {
      "displayName": "Options",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Form Submission Mode",
          "name": "formSubmissionMode",
          "type": "options",
          "options": [
            {
              "name": "All",
              "value": "all"
            },
            {
              "name": "None",
              "value": "none"
            },
            {
              "name": "Newest",
              "value": "newest"
            },
            {
              "name": "Oldest",
              "value": "oldest"
            }
          ],
          "default": "all",
          "description": "Specify which form submissions should be fetched"
        },
        {
          "displayName": "Include List Memberships",
          "name": "listMemberships",
          "type": "boolean",
          "default": true,
          "description": "Whether current list memberships should be fetched for the contact"
        },
        {
          "displayName": "Contact Properties to Include",
          "name": "propertiesCollection",
          "type": "fixedCollection",
          "default": {},
          "options": [
            {
              "name": "propertiesValues",
              "displayName": "Contact Properties to Include",
              "values": [
                {
                  "displayName": "Contact Properties to Include",
                  "name": "properties",
                  "type": "multiOptions",
                  "typeOptions": {
                    "multipleValueButtonText": "test",
                    "loadOptionsMethod": "getContactProperties"
                  },
                  "default": [],
                  "description": "Whether to include specific Contact properties in the returned results. Choose from a list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>. Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
                },
                {
                  "displayName": "Include",
                  "name": "propertyMode",
                  "type": "options",
                  "options": [
                    {
                      "name": "Value And History",
                      "value": "valueAndHistory"
                    },
                    {
                      "name": "Value Only",
                      "value": "valueOnly"
                    }
                  ],
                  "default": "valueAndHistory",
                  "description": "Specify if the current value for a property should be fetched, or the value and all the historical values for that property"
                }
              ]
            }
          ],
          "description": "<p>Used to include specific contact properties in the results. By default, the results will only include Contact ID and will not include the values for any properties for your Contact.</p><p>Including this parameter will include the data for the specified property in the results. You can include this parameter multiple times to request multiple properties separated by a comma: <code>,</code>.</p>. Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "contact"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Return All",
      "name": "returnAll",
      "type": "boolean",
      "default": false,
      "description": "Whether to return all results or only up to a given limit",
      "displayOptions": {
        "show": {
          "resource": [
            "contact"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 100,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "contact"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 250
      }
    },
    {
      "displayName": "Options",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Form Submission Mode",
          "name": "formSubmissionMode",
          "type": "options",
          "options": [
            {
              "name": "All",
              "value": "all"
            },
            {
              "name": "None",
              "value": "none"
            },
            {
              "name": "Newest",
              "value": "newest"
            },
            {
              "name": "Oldest",
              "value": "oldest"
            }
          ],
          "default": "all",
          "description": "Specify which form submissions should be fetched"
        },
        {
          "displayName": "Include List Memberships",
          "name": "listMemberships",
          "type": "boolean",
          "default": true,
          "description": "Whether current list memberships should be fetched for the contact"
        },
        {
          "displayName": "Contact Properties to Include",
          "name": "propertiesCollection",
          "type": "fixedCollection",
          "default": {},
          "options": [
            {
              "name": "propertiesValues",
              "displayName": "Contact Properties to Include",
              "values": [
                {
                  "displayName": "Contact Properties to Include",
                  "name": "properties",
                  "type": "multiOptions",
                  "typeOptions": {
                    "loadOptionsMethod": "getContactProperties"
                  },
                  "default": [],
                  "description": "Whether to include specific Contact properties in the returned results. Choose from a list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>. Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
                },
                {
                  "displayName": "Include",
                  "name": "propertyMode",
                  "type": "options",
                  "options": [
                    {
                      "name": "Value And History",
                      "value": "valueAndHistory"
                    },
                    {
                      "name": "Value Only",
                      "value": "valueOnly"
                    }
                  ],
                  "default": "valueAndHistory",
                  "description": "Specify if the current value for a property should be fetched, or the value and all the historical values for that property"
                }
              ]
            }
          ],
          "description": "<p>Used to include specific contact properties in the results. By default, the results will only include Contact ID and will not include the values for any properties for your Contact.</p><p>Including this parameter will include the data for the specified property in the results. You can include this parameter multiple times to request multiple properties separated by a comma: <code>,</code>.</p>. Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "contact"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Contact to Delete",
      "name": "contactId",
      "type": "resourceLocator",
      "default": {
        "mode": "list",
        "value": ""
      },
      "description": "This is not a contact's email but a number like 1485",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "contact"
          ],
          "operation": [
            "delete"
          ]
        }
      },
      "modes": [
        {
          "displayName": "From List",
          "name": "list",
          "type": "list",
          "placeholder": "Select from the list",
          "typeOptions": {
            "searchListMethod": "searchContacts",
            "searchable": true
          }
        },
        {
          "displayName": "By Id",
          "name": "id",
          "type": "string",
          "placeholder": "58539222",
          "validation": [
            {
              "type": "regex",
              "properties": {
                "regex": "[0-9]+",
                "errorMessage": "Not a valid HubSpot Contact ID"
              }
            }
          ]
        }
      ]
    },
    {
      "displayName": "Return All",
      "name": "returnAll",
      "type": "boolean",
      "default": false,
      "description": "Whether to return all results or only up to a given limit",
      "displayOptions": {
        "show": {
          "resource": [
            "contact"
          ],
          "operation": [
            "getRecentlyCreatedUpdated"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 100,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "contact"
          ],
          "operation": [
            "getRecentlyCreatedUpdated"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 250
      }
    },
    {
      "displayName": "Options",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Form Submission Mode",
          "name": "formSubmissionMode",
          "type": "options",
          "options": [
            {
              "name": "All",
              "value": "all"
            },
            {
              "name": "None",
              "value": "none"
            },
            {
              "name": "Newest",
              "value": "newest"
            },
            {
              "name": "Oldest",
              "value": "oldest"
            }
          ],
          "default": "all",
          "description": "Specify which form submissions should be fetched"
        },
        {
          "displayName": "Include List Memberships",
          "name": "listMemberships",
          "type": "boolean",
          "default": true,
          "description": "Whether current list memberships should be fetched for the contact"
        },
        {
          "displayName": "Contact Properties to Include",
          "name": "propertiesCollection",
          "type": "fixedCollection",
          "default": {},
          "options": [
            {
              "name": "propertiesValues",
              "displayName": "Contact Properties to Include",
              "values": [
                {
                  "displayName": "Contact Properties to Include",
                  "name": "properties",
                  "type": "multiOptions",
                  "typeOptions": {
                    "loadOptionsMethod": "getContactProperties"
                  },
                  "default": [],
                  "description": "Whether to include specific Contact properties in the returned results. Choose from a list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>. Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
                },
                {
                  "displayName": "Include",
                  "name": "propertyMode",
                  "type": "options",
                  "options": [
                    {
                      "name": "Value And History",
                      "value": "valueAndHistory"
                    },
                    {
                      "name": "Value Only",
                      "value": "valueOnly"
                    }
                  ],
                  "default": "valueAndHistory",
                  "description": "Specify if the current value for a property should be fetched, or the value and all the historical values for that property"
                }
              ]
            }
          ],
          "description": "<p>Used to include specific contact properties in the results. By default, the results will only include Contact ID and will not include the values for any properties for your Contact.</p><p>Including this parameter will include the data for the specified property in the results. You can include this parameter multiple times to request multiple properties separated by a comma: <code>,</code>.</p>. Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "contact"
          ],
          "operation": [
            "getRecentlyCreatedUpdated"
          ]
        }
      }
    },
    {
      "displayName": "Return All",
      "name": "returnAll",
      "type": "boolean",
      "default": false,
      "description": "Whether to return all results or only up to a given limit",
      "displayOptions": {
        "show": {
          "resource": [
            "contact"
          ],
          "operation": [
            "search"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 100,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "contact"
          ],
          "operation": [
            "search"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 250
      }
    },
    {
      "displayName": "Filter Groups",
      "name": "filterGroupsUi",
      "type": "fixedCollection",
      "default": {},
      "description": "When multiple filters are provided within a Filter Group, they will be combined using a logical AND operator. When multiple Filter Groups are provided, they will be combined using a logical OR operator. The system supports a maximum of three Filter Groups with up to three filters each. More info <a href=\"https://developers.hubspot.com/docs/api/crm/search\">here</a>",
      "options": [
        {
          "name": "filterGroupsValues",
          "displayName": "Filter Group",
          "values": [
            {
              "displayName": "Filters",
              "name": "filtersUi",
              "type": "fixedCollection",
              "default": {},
              "placeholder": "Add Filter",
              "typeOptions": {
                "multipleValues": true
              },
              "options": [
                {
                  "name": "filterValues",
                  "displayName": "Filter",
                  "values": [
                    {
                      "displayName": "Property Name or ID",
                      "name": "propertyName",
                      "type": "options",
                      "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
                      "typeOptions": {
                        "loadOptionsMethod": "getContactPropertiesWithType"
                      },
                      "default": ""
                    },
                    {
                      "displayName": "Type",
                      "name": "type",
                      "type": "hidden",
                      "default": "={{$parameter[\"&propertyName\"].split(\"|\")[1]}}"
                    },
                    {
                      "displayName": "Operator",
                      "name": "operator",
                      "type": "options",
                      "displayOptions": {
                        "hide": {
                          "type": [
                            "number"
                          ]
                        }
                      },
                      "options": [
                        {
                          "name": "Contains Exactly",
                          "value": "CONTAINS_TOKEN"
                        },
                        {
                          "name": "Equal",
                          "value": "EQ"
                        },
                        {
                          "name": "Is Known",
                          "value": "HAS_PROPERTY"
                        },
                        {
                          "name": "Is Unknown",
                          "value": "NOT_HAS_PROPERTY"
                        },
                        {
                          "name": "Not Equal",
                          "value": "NEQ"
                        }
                      ],
                      "default": "EQ"
                    },
                    {
                      "displayName": "Operator",
                      "name": "operator",
                      "type": "options",
                      "displayOptions": {
                        "show": {
                          "type": [
                            "number"
                          ]
                        }
                      },
                      "options": [
                        {
                          "name": "Contains Exactly",
                          "value": "CONTAINS_TOKEN"
                        },
                        {
                          "name": "Equal",
                          "value": "EQ"
                        },
                        {
                          "name": "Greater Than",
                          "value": "GT"
                        },
                        {
                          "name": "Greater Than Or Equal",
                          "value": "GTE"
                        },
                        {
                          "name": "Is Known",
                          "value": "HAS_PROPERTY"
                        },
                        {
                          "name": "Is Unknown",
                          "value": "NOT_HAS_PROPERTY"
                        },
                        {
                          "name": "Less Than",
                          "value": "LT"
                        },
                        {
                          "name": "Less Than Or Equal",
                          "value": "LTE"
                        },
                        {
                          "name": "Not Equal",
                          "value": "NEQ"
                        }
                      ],
                      "default": "EQ"
                    },
                    {
                      "displayName": "Value",
                      "name": "value",
                      "displayOptions": {
                        "hide": {
                          "operator": [
                            "HAS_PROPERTY",
                            "NOT_HAS_PROPERTY"
                          ]
                        }
                      },
                      "required": true,
                      "type": "string",
                      "default": ""
                    }
                  ]
                }
              ],
              "description": "Use filters to limit the results to only CRM objects with matching property values. More info <a href=\"https://developers.hubspot.com/docs/api/crm/search\">here</a>."
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "contact"
          ],
          "operation": [
            "search"
          ]
        }
      },
      "typeOptions": {
        "multipleValues": true
      }
    },
    {
      "displayName": "Options",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Sort Order",
          "name": "direction",
          "type": "options",
          "options": [
            {
              "name": "Ascending",
              "value": "ASCENDING"
            },
            {
              "name": "Descending",
              "value": "DESCENDING"
            }
          ],
          "default": "DESCENDING",
          "description": "Defines the direction in which search results are ordered. Default value is Descending."
        },
        {
          "displayName": "Field Names or IDs",
          "name": "properties",
          "type": "multiOptions",
          "typeOptions": {
            "loadOptionsMethod": "getContactProperties"
          },
          "default": [
            "firstname",
            "lastname",
            "email"
          ],
          "description": "Whether to include specific Contact properties in the returned results. Choose from a list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>. Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        },
        {
          "displayName": "Query",
          "name": "query",
          "type": "string",
          "default": "",
          "description": "Perform a text search against all property values for an object type"
        },
        {
          "displayName": "Sort By",
          "name": "sortBy",
          "type": "options",
          "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
          "typeOptions": {
            "loadOptionsMethod": "getContactProperties"
          },
          "default": "createdate"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "contact"
          ],
          "operation": [
            "search"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "add",
      "options": [
        {
          "name": "Add",
          "value": "add",
          "description": "Add contact to a list",
          "action": "Add a contact to a list"
        },
        {
          "name": "Remove",
          "value": "remove",
          "description": "Remove a contact from a list",
          "action": "Remove a contact from a list"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "contactList"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "By",
      "name": "by",
      "type": "options",
      "default": "email",
      "options": [
        {
          "name": "Contact ID",
          "value": "id"
        },
        {
          "name": "Email",
          "value": "email"
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "contactList"
          ],
          "operation": [
            "add"
          ]
        }
      }
    },
    {
      "displayName": "Email",
      "name": "email",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "contactList"
          ],
          "operation": [
            "add"
          ],
          "by": [
            "email"
          ]
        }
      }
    },
    {
      "displayName": "Contact to Add",
      "name": "id",
      "type": "number",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "contactList"
          ],
          "operation": [
            "add"
          ],
          "by": [
            "id"
          ]
        }
      }
    },
    {
      "displayName": "List to Add To",
      "name": "listId",
      "type": "number",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "contactList"
          ],
          "operation": [
            "add"
          ]
        }
      }
    },
    {
      "displayName": "Contact to Remove",
      "name": "id",
      "type": "number",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "contactList"
          ],
          "operation": [
            "remove"
          ]
        }
      }
    },
    {
      "displayName": "List to Remove From",
      "name": "listId",
      "type": "number",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "contactList"
          ],
          "operation": [
            "remove"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create a company",
          "action": "Create a company"
        },
        {
          "name": "Delete",
          "value": "delete",
          "description": "Delete a company",
          "action": "Delete a company"
        },
        {
          "name": "Get",
          "value": "get",
          "description": "Get a company",
          "action": "Get a company"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get many companies",
          "action": "Get many companies"
        },
        {
          "name": "Get Recently Created/Updated",
          "value": "getRecentlyCreatedUpdated",
          "description": "Get recently created/updated companies",
          "action": "Get recently created/updated companies"
        },
        {
          "name": "Search",
          "value": "searchByDomain",
          "description": "Search companies by their website domain",
          "action": "Search for a company by Domain"
        },
        {
          "name": "Update",
          "value": "update",
          "description": "Update a company",
          "action": "Update a company"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "company"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Name",
      "name": "name",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "company"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Company Properties",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "About Us",
          "name": "aboutUs",
          "type": "string",
          "typeOptions": {
            "alwaysOpenEditWindow": true
          },
          "default": ""
        },
        {
          "displayName": "Annual Revenue",
          "name": "annualRevenue",
          "type": "number",
          "typeOptions": {
            "minValue": 0
          },
          "default": 0,
          "description": "The actual or estimated annual revenue of the company"
        },
        {
          "displayName": "City",
          "name": "city",
          "type": "string",
          "default": "",
          "description": "The city where the company is located"
        },
        {
          "displayName": "Close Date",
          "name": "closeDate",
          "type": "dateTime",
          "default": "",
          "description": "The date the company or organization was closed as a customer. When using expressions, the time should be specified in YYYY-MM-DD hh-mm-ss format."
        },
        {
          "displayName": "Company Domain Name",
          "name": "companyDomainName",
          "type": "string",
          "default": "",
          "description": "The domain name of the company or organization"
        },
        {
          "displayName": "Company Owner Name or ID",
          "name": "companyOwner",
          "type": "options",
          "typeOptions": {
            "loadOptionsMethod": "getOwners"
          },
          "default": "",
          "description": "The owner of the company. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        },
        {
          "displayName": "Country/Region",
          "name": "countryRegion",
          "type": "string",
          "default": "",
          "description": "The country/region in which the company or organization is located"
        },
        {
          "displayName": "Custom Properties",
          "name": "customPropertiesUi",
          "placeholder": "Add Custom Property",
          "type": "fixedCollection",
          "typeOptions": {
            "multipleValues": true
          },
          "default": {},
          "options": [
            {
              "name": "customPropertiesValues",
              "displayName": "Custom Property",
              "values": [
                {
                  "displayName": "Property Name or ID",
                  "name": "property",
                  "type": "options",
                  "typeOptions": {
                    "loadOptionsMethod": "getCompanyCustomProperties"
                  },
                  "default": {},
                  "description": "Name of the property. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
                },
                {
                  "displayName": "Value",
                  "name": "value",
                  "type": "string",
                  "default": "",
                  "required": true,
                  "description": "Value of the property"
                }
              ]
            }
          ]
        },
        {
          "displayName": "Description",
          "name": "description",
          "type": "string",
          "default": "",
          "description": "A short statement about the company's mission and goals"
        },
        {
          "displayName": "Facebook Fans",
          "name": "facebookFans",
          "type": "number",
          "typeOptions": {
            "minValue": 0
          },
          "default": 0,
          "description": "Number of facebook fans"
        },
        {
          "displayName": "Google Plus Page",
          "name": "googlePlusPage",
          "type": "string",
          "default": "",
          "description": "The URL of the Google Plus page for the company or organization"
        },
        {
          "displayName": "Industry Name or ID",
          "name": "industry",
          "type": "options",
          "typeOptions": {
            "loadOptionsMethod": "getCompanyIndustries"
          },
          "default": "",
          "description": "The type of business the company performs. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        },
        {
          "displayName": "Is Public",
          "name": "isPublic",
          "type": "boolean",
          "default": false,
          "description": "Whether that the company is publicly traded"
        },
        {
          "displayName": "Lead Status Name or ID",
          "name": "leadStatus",
          "type": "options",
          "typeOptions": {
            "loadOptionsMethod": "getCompanyleadStatuses"
          },
          "default": "",
          "description": "The company's sales, prospecting or outreach status. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        },
        {
          "displayName": "Lifecycle Stage Name or ID",
          "name": "lifecycleStatus",
          "type": "options",
          "typeOptions": {
            "loadOptionsMethod": "getCompanylifecycleStages"
          },
          "default": "",
          "description": "The most advanced lifecycle stage across all contacts associated with this company or organization. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        },
        {
          "displayName": "LinkedIn Bio",
          "name": "linkedinBio",
          "type": "string",
          "default": "",
          "description": "The LinkedIn bio for the company or organization"
        },
        {
          "displayName": "LinkedIn Company Page",
          "name": "linkedInCompanyPage",
          "type": "string",
          "default": "",
          "description": "The URL of the LinkedIn company page for the company or organization"
        },
        {
          "displayName": "Number Of Employees",
          "name": "numberOfEmployees",
          "type": "number",
          "typeOptions": {
            "minValue": 0
          },
          "default": 0,
          "description": "The total number of employees who work for the company or organization"
        },
        {
          "displayName": "Original Source Type Name or ID",
          "name": "originalSourceType",
          "type": "options",
          "typeOptions": {
            "loadOptionsMethod": "getCompanySourceTypes"
          },
          "default": "",
          "description": "Original source for the contact with the earliest activity for this company or organization. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        },
        {
          "displayName": "Phone Number",
          "name": "phoneNumber",
          "type": "string",
          "default": "",
          "description": "A company's primary phone number. Powered by HubSpot Insights."
        },
        {
          "displayName": "Postal Code",
          "name": "postalCode",
          "type": "string",
          "default": "",
          "description": "The postal or zip code of the company or organization. Powered by HubSpot Insights."
        },
        {
          "displayName": "State/Region",
          "name": "stateRegion",
          "type": "string",
          "default": "",
          "description": "The state or region in which the company or organization is located. Powered by HubSpot Insights."
        },
        {
          "displayName": "Street Address",
          "name": "streetAddress",
          "type": "string",
          "default": "",
          "description": "The street address of the company or organization, including unit number. Powered by HubSpot Insights."
        },
        {
          "displayName": "Street Address 2",
          "name": "streetAddress2",
          "type": "string",
          "default": "",
          "description": "The additional address of the company or organization. Powered by HubSpot Insights."
        },
        {
          "displayName": "Target Account Name or ID",
          "name": "targetAccount",
          "type": "options",
          "typeOptions": {
            "loadOptionsMethod": "getCompanyTargetAccounts"
          },
          "default": "",
          "description": "The Target Account property is a means to flag high priority companies if you are following an account based strategy. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        },
        {
          "displayName": "Timezone",
          "name": "timezone",
          "type": "string",
          "default": "",
          "description": "The time zone where the company or organization is located. Powered by HubSpot Insights."
        },
        {
          "displayName": "Total Money Raised",
          "name": "totalMoneyRaised",
          "type": "number",
          "typeOptions": {
            "minValue": 0
          },
          "default": 0,
          "description": "The total amount of money raised by the company. Powered by HubSpot Insights."
        },
        {
          "displayName": "Twitter Bio",
          "name": "twitterBio",
          "type": "string",
          "typeOptions": {
            "alwaysOpenEditWindow": true
          },
          "default": "",
          "description": "The Twitter bio of the company or organization"
        },
        {
          "displayName": "Twitter Followers",
          "name": "twitterFollowers",
          "type": "number",
          "typeOptions": {
            "minValue": 0
          },
          "default": 0,
          "description": "The number of Twitter followers of the company or organization"
        },
        {
          "displayName": "Twitter Handle",
          "name": "twitterHandle",
          "type": "string",
          "default": "",
          "description": "The main twitter account of the company or organization"
        },
        {
          "displayName": "Type Name or ID",
          "name": "type",
          "type": "options",
          "typeOptions": {
            "loadOptionsMethod": "getCompanyTypes"
          },
          "default": "",
          "description": "The optional classification of this company record - prospect, partner, etc. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        },
        {
          "displayName": "Web Technologies Name or ID",
          "name": "webTechnologies",
          "type": "options",
          "typeOptions": {
            "loadOptionsMethod": "getCompanyWebTechnologies"
          },
          "default": "",
          "description": "The web technologies used by the company or organization. Powered by HubSpot Insights. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        },
        {
          "displayName": "Website URL",
          "name": "websiteUrl",
          "type": "string",
          "default": "",
          "description": "The main website of the company or organization. This property is used to identify unique companies. Powered by HubSpot Insights."
        },
        {
          "displayName": "Year Founded",
          "name": "yearFounded",
          "type": "string",
          "default": "",
          "description": "The year the company was created. Powered by HubSpot Insights."
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "company"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Company to Update",
      "name": "companyId",
      "type": "resourceLocator",
      "default": {
        "mode": "list",
        "value": ""
      },
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "company"
          ],
          "operation": [
            "update"
          ]
        }
      },
      "modes": [
        {
          "displayName": "From List",
          "name": "list",
          "type": "list",
          "placeholder": "Select from the list",
          "typeOptions": {
            "searchListMethod": "searchCompanies"
          }
        },
        {
          "displayName": "By Id",
          "name": "id",
          "type": "string",
          "placeholder": "58539222",
          "validation": [
            {
              "type": "regex",
              "properties": {
                "regex": "[0-9]+",
                "errorMessage": "Not a valid HubSpot Company ID"
              }
            }
          ]
        }
      ]
    },
    {
      "displayName": "Update Fields",
      "name": "updateFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "About Us",
          "name": "aboutUs",
          "type": "string",
          "typeOptions": {
            "alwaysOpenEditWindow": true
          },
          "default": ""
        },
        {
          "displayName": "Annual Revenue",
          "name": "annualRevenue",
          "type": "number",
          "typeOptions": {
            "minValue": 0
          },
          "default": 0,
          "description": "The actual or estimated annual revenue of the company"
        },
        {
          "displayName": "City",
          "name": "city",
          "type": "string",
          "default": "",
          "description": "The city where the company is located"
        },
        {
          "displayName": "Close Date",
          "name": "closeDate",
          "type": "dateTime",
          "default": "",
          "description": "The date the company or organization was closed as a customer. When using expressions, the time should be specified in YYYY-MM-DD hh-mm-ss format."
        },
        {
          "displayName": "Company Domain Name",
          "name": "companyDomainName",
          "type": "string",
          "default": "",
          "description": "The domain name of the company or organization"
        },
        {
          "displayName": "Company Owner Name or ID",
          "name": "companyOwner",
          "type": "options",
          "typeOptions": {
            "loadOptionsMethod": "getOwners"
          },
          "default": "",
          "description": "The owner of the company. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        },
        {
          "displayName": "Country/Region",
          "name": "countryRegion",
          "type": "string",
          "default": "",
          "description": "The country/region in which the company or organization is located"
        },
        {
          "displayName": "Custom Properties",
          "name": "customPropertiesUi",
          "placeholder": "Add Custom Property",
          "type": "fixedCollection",
          "typeOptions": {
            "multipleValues": true
          },
          "default": {},
          "options": [
            {
              "name": "customPropertiesValues",
              "displayName": "Custom Property",
              "values": [
                {
                  "displayName": "Property Name or ID",
                  "name": "property",
                  "type": "options",
                  "typeOptions": {
                    "loadOptionsMethod": "getCompanyCustomProperties"
                  },
                  "default": "",
                  "description": "Name of the property. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
                },
                {
                  "displayName": "Value",
                  "name": "value",
                  "type": "string",
                  "default": "",
                  "required": true,
                  "description": "Value of the property"
                }
              ]
            }
          ]
        },
        {
          "displayName": "Description",
          "name": "description",
          "type": "string",
          "default": "",
          "description": "A short statement about the company's mission and goals"
        },
        {
          "displayName": "Facebook Fans",
          "name": "facebookFans",
          "type": "number",
          "typeOptions": {
            "minValue": 0
          },
          "default": 0,
          "description": "Number of facebook fans"
        },
        {
          "displayName": "Google Plus Page",
          "name": "googlePlusPage",
          "type": "string",
          "default": "",
          "description": "The URL of the Google Plus page for the company or organization"
        },
        {
          "displayName": "Industry Name or ID",
          "name": "industry",
          "type": "options",
          "typeOptions": {
            "loadOptionsMethod": "getCompanyIndustries"
          },
          "default": "",
          "description": "The type of business the company performs. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        },
        {
          "displayName": "Is Public",
          "name": "isPublic",
          "type": "boolean",
          "default": false,
          "description": "Whether that the company is publicly traded"
        },
        {
          "displayName": "Lead Status Name or ID",
          "name": "leadStatus",
          "type": "options",
          "typeOptions": {
            "loadOptionsMethod": "getCompanyleadStatuses"
          },
          "default": "",
          "description": "The company's sales, prospecting or outreach status. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        },
        {
          "displayName": "Lifecycle Stage Name or ID",
          "name": "lifecycleStatus",
          "type": "options",
          "typeOptions": {
            "loadOptionsMethod": "getCompanylifecycleStages"
          },
          "default": "",
          "description": "The most advanced lifecycle stage across all contacts associated with this company or organization. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        },
        {
          "displayName": "Linkedin Bio",
          "name": "linkedinBio",
          "type": "string",
          "default": "",
          "description": "The LinkedIn bio for the company or organization"
        },
        {
          "displayName": "LinkedIn Company Page",
          "name": "linkedInCompanyPage",
          "type": "string",
          "default": "",
          "description": "The URL of the LinkedIn company page for the company or organization"
        },
        {
          "displayName": "Name",
          "name": "name",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Number Of Employees",
          "name": "numberOfEmployees",
          "type": "number",
          "typeOptions": {
            "minValue": 0
          },
          "default": 0,
          "description": "The total number of employees who work for the company or organization"
        },
        {
          "displayName": "Original Source Type Name or ID",
          "name": "originalSourceType",
          "type": "options",
          "typeOptions": {
            "loadOptionsMethod": "getCompanySourceTypes"
          },
          "default": "",
          "description": "Original source for the contact with the earliest activity for this company or organization. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        },
        {
          "displayName": "Phone Number",
          "name": "phoneNumber",
          "type": "string",
          "default": "",
          "description": "A company's primary phone number. Powered by HubSpot Insights."
        },
        {
          "displayName": "Postal Code",
          "name": "postalCode",
          "type": "string",
          "default": "",
          "description": "The postal or zip code of the company or organization. Powered by HubSpot Insights."
        },
        {
          "displayName": "State/Region",
          "name": "stateRegion",
          "type": "string",
          "default": "",
          "description": "The state or region in which the company or organization is located. Powered by HubSpot Insights."
        },
        {
          "displayName": "Street Address",
          "name": "streetAddress",
          "type": "string",
          "default": "",
          "description": "The street address of the company or organization, including unit number. Powered by HubSpot Insights."
        },
        {
          "displayName": "Street Address 2",
          "name": "streetAddress2",
          "type": "string",
          "default": "",
          "description": "The additional address of the company or organization. Powered by HubSpot Insights."
        },
        {
          "displayName": "Target Account Name or ID",
          "name": "targetAccount",
          "type": "options",
          "typeOptions": {
            "loadOptionsMethod": "getCompanyTargetAccounts"
          },
          "default": "",
          "description": "The Target Account property is a means to flag high priority companies if you are following an account based strategy. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        },
        {
          "displayName": "Timezone",
          "name": "timezone",
          "type": "string",
          "default": "",
          "description": "The time zone where the company or organization is located. Powered by HubSpot Insights."
        },
        {
          "displayName": "Total Money Raised",
          "name": "totalMoneyRaised",
          "type": "number",
          "typeOptions": {
            "minValue": 0
          },
          "default": 0,
          "description": "The total amount of money raised by the company. Powered by HubSpot Insights."
        },
        {
          "displayName": "Twitter Bio",
          "name": "twitterBio",
          "type": "string",
          "typeOptions": {
            "alwaysOpenEditWindow": true
          },
          "default": "",
          "description": "The Twitter bio of the company or organization"
        },
        {
          "displayName": "Twitter Followers",
          "name": "twitterFollowers",
          "type": "number",
          "typeOptions": {
            "minValue": 0
          },
          "default": 0,
          "description": "The number of Twitter followers of the company or organization"
        },
        {
          "displayName": "Twitter Handle",
          "name": "twitterHandle",
          "type": "string",
          "default": "",
          "description": "The main twitter account of the company or organization"
        },
        {
          "displayName": "Type Name or ID",
          "name": "type",
          "type": "options",
          "typeOptions": {
            "loadOptionsMethod": "getCompanyTypes"
          },
          "default": "",
          "description": "The optional classification of this company record - prospect, partner, etc. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        },
        {
          "displayName": "Web Technologies Name or ID",
          "name": "webTechnologies",
          "type": "options",
          "typeOptions": {
            "loadOptionsMethod": "getCompanyWebTechnologies"
          },
          "default": "",
          "description": "The web technologies used by the company or organization. Powered by HubSpot Insights. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        },
        {
          "displayName": "Website URL",
          "name": "websiteUrl",
          "type": "string",
          "default": "",
          "description": "The main website of the company or organization. This property is used to identify unique companies. Powered by HubSpot Insights."
        },
        {
          "displayName": "Year Founded",
          "name": "yearFounded",
          "type": "string",
          "default": "",
          "description": "The year the company was created. Powered by HubSpot Insights."
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "company"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Company to Get",
      "name": "companyId",
      "type": "resourceLocator",
      "default": {
        "mode": "list",
        "value": ""
      },
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "company"
          ],
          "operation": [
            "get"
          ]
        }
      },
      "modes": [
        {
          "displayName": "From List",
          "name": "list",
          "type": "list",
          "placeholder": "Select from the list",
          "typeOptions": {
            "searchListMethod": "searchCompanies"
          }
        },
        {
          "displayName": "By Id",
          "name": "id",
          "type": "string",
          "placeholder": "58539222",
          "validation": [
            {
              "type": "regex",
              "properties": {
                "regex": "[0-9]+",
                "errorMessage": "Not a valid HubSpot Company ID"
              }
            }
          ]
        }
      ]
    },
    {
      "displayName": "Options",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Include Merge Audits",
          "name": "includeMergeAudits",
          "type": "boolean",
          "default": false,
          "description": "Whether to return any merge history if the company has been previously merged with another company record. Defaults to false."
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "company"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Return All",
      "name": "returnAll",
      "type": "boolean",
      "default": false,
      "description": "Whether to return all results or only up to a given limit",
      "displayOptions": {
        "show": {
          "resource": [
            "company"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 100,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "company"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 250
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Include Merge Audits",
          "name": "includeMergeAudits",
          "type": "boolean",
          "default": false,
          "description": "Whether to return any merge history if a company has been previously merged with another company record. Defaults to false."
        },
        {
          "displayName": "Company Properties to Include",
          "name": "propertiesCollection",
          "type": "fixedCollection",
          "default": {},
          "options": [
            {
              "name": "propertiesValues",
              "displayName": "Companies Properties to Include",
              "values": [
                {
                  "displayName": "Companies Properties to Include",
                  "name": "properties",
                  "type": "multiOptions",
                  "typeOptions": {
                    "loadOptionsMethod": "getCompanyProperties"
                  },
                  "default": [],
                  "description": "Whether to include specific Company properties in the returned results. Choose from a list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>. Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
                },
                {
                  "displayName": "Include",
                  "name": "propertyMode",
                  "type": "options",
                  "options": [
                    {
                      "name": "Value And History",
                      "value": "valueAndHistory"
                    },
                    {
                      "name": "Value Only",
                      "value": "valueOnly"
                    }
                  ],
                  "default": "valueAndHistory",
                  "description": "Specify if the current value for a property should be fetched, or the value and all the historical values for that property"
                }
              ]
            }
          ],
          "description": "Whether to include specific Company properties in the returned results. Choose from a list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "company"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Company to Delete",
      "name": "companyId",
      "type": "resourceLocator",
      "default": {
        "mode": "list",
        "value": ""
      },
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "company"
          ],
          "operation": [
            "delete"
          ]
        }
      },
      "modes": [
        {
          "displayName": "From List",
          "name": "list",
          "type": "list",
          "placeholder": "Select from the list",
          "typeOptions": {
            "searchListMethod": "searchCompanies"
          }
        },
        {
          "displayName": "By Id",
          "name": "id",
          "type": "string",
          "placeholder": "58539222",
          "validation": [
            {
              "type": "regex",
              "properties": {
                "regex": "[0-9]+",
                "errorMessage": "Not a valid HubSpot Company ID"
              }
            }
          ]
        }
      ]
    },
    {
      "displayName": "Return All",
      "name": "returnAll",
      "type": "boolean",
      "default": false,
      "description": "Whether to return all results or only up to a given limit",
      "displayOptions": {
        "show": {
          "resource": [
            "company"
          ],
          "operation": [
            "getRecentlyCreatedUpdated"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 100,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "company"
          ],
          "operation": [
            "getRecentlyCreatedUpdated"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 250
      }
    },
    {
      "displayName": "Options",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Since",
          "name": "since",
          "type": "dateTime",
          "default": "",
          "description": "Only return companys created after timestamp x. When using expressions, the time should be specified in YYYY-MM-DD hh-mm-ss format."
        },
        {
          "displayName": "Company Properties to Include",
          "name": "propertiesCollection",
          "type": "fixedCollection",
          "default": {},
          "options": [
            {
              "name": "propertiesValues",
              "displayName": "Companies Properties to Include",
              "values": [
                {
                  "displayName": "Companies Properties to Include",
                  "name": "properties",
                  "type": "multiOptions",
                  "typeOptions": {
                    "loadOptionsMethod": "getCompanyProperties"
                  },
                  "default": [],
                  "description": "Whether to include specific Company properties in the returned results. Choose from a list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>. Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
                },
                {
                  "displayName": "Include",
                  "name": "propertyMode",
                  "type": "options",
                  "options": [
                    {
                      "name": "Value And History",
                      "value": "valueAndHistory"
                    },
                    {
                      "name": "Value Only",
                      "value": "valueOnly"
                    }
                  ],
                  "default": "valueAndHistory",
                  "description": "Specify if the current value for a property should be fetched, or the value and all the historical values for that property"
                }
              ]
            }
          ],
          "description": "Whether to include specific Company properties in the returned results. Choose from a list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "company"
          ],
          "operation": [
            "getRecentlyCreatedUpdated"
          ]
        }
      }
    },
    {
      "displayName": "Domain",
      "name": "domain",
      "type": "string",
      "default": "",
      "description": "The company's website domain to search for, like n8n.io",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "company"
          ],
          "operation": [
            "searchByDomain"
          ]
        }
      }
    },
    {
      "displayName": "Return All",
      "name": "returnAll",
      "type": "boolean",
      "default": false,
      "description": "Whether to return all results or only up to a given limit",
      "displayOptions": {
        "show": {
          "resource": [
            "company"
          ],
          "operation": [
            "searchByDomain"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 100,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "company"
          ],
          "operation": [
            "searchByDomain"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 250
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Company Properties to Include",
          "name": "properties",
          "type": "multiOptions",
          "typeOptions": {
            "loadOptionsMethod": "getCompanyProperties"
          },
          "default": [],
          "description": "Whether to include specific Company properties in the returned results. Choose from a list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>. Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "company"
          ],
          "operation": [
            "searchByDomain"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create a deal",
          "action": "Create a deal"
        },
        {
          "name": "Delete",
          "value": "delete",
          "description": "Delete a deal",
          "action": "Delete a deal"
        },
        {
          "name": "Get",
          "value": "get",
          "description": "Get a deal",
          "action": "Get a deal"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get many deals",
          "action": "Get many deals"
        },
        {
          "name": "Get Recently Created/Updated",
          "value": "getRecentlyCreatedUpdated",
          "description": "Get recently created/updated deals",
          "action": "Get recently created/updated deals"
        },
        {
          "name": "Search",
          "value": "search",
          "description": "Search deals",
          "action": "Search for deals"
        },
        {
          "name": "Update",
          "value": "update",
          "description": "Update a deal",
          "action": "Update a deal"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "deal"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Deal Stage Name or ID",
      "name": "stage",
      "type": "options",
      "default": "",
      "description": "The deal stage is required when creating a deal. See the CRM Pipelines API for details on managing pipelines and stages. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
      "options": [],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "deal"
          ],
          "operation": [
            "create"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getDealStages"
      }
    },
    {
      "displayName": "Deal Properties",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Amount",
          "name": "amount",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Associated Company Names or IDs",
          "name": "associatedCompany",
          "type": "multiOptions",
          "description": "Whether to include specific Associated Company properties in the returned results. Choose from a list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>. Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
          "typeOptions": {
            "loadOptionsMethod": "getCompanies"
          },
          "default": []
        },
        {
          "displayName": "Associated Vid Names or IDs",
          "name": "associatedVids",
          "type": "multiOptions",
          "description": "Whether to include specific Associated Vid in the returned results. Choose from a list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>. Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
          "typeOptions": {
            "loadOptionsMethod": "getContacts"
          },
          "default": []
        },
        {
          "displayName": "Close Date",
          "name": "closeDate",
          "type": "dateTime",
          "default": "",
          "description": "When using expressions, the time should be specified in YYYY-MM-DD hh-mm-ss format"
        },
        {
          "displayName": "Custom Properties",
          "name": "customPropertiesUi",
          "placeholder": "Add Custom Property",
          "type": "fixedCollection",
          "typeOptions": {
            "multipleValues": true
          },
          "default": {},
          "options": [
            {
              "name": "customPropertiesValues",
              "displayName": "Custom Property",
              "values": [
                {
                  "displayName": "Property Name or ID",
                  "name": "property",
                  "type": "options",
                  "typeOptions": {
                    "loadOptionsMethod": "getDealCustomProperties"
                  },
                  "default": "",
                  "description": "Name of the property. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
                },
                {
                  "displayName": "Value",
                  "name": "value",
                  "type": "string",
                  "default": "",
                  "required": true,
                  "description": "Value of the property"
                }
              ]
            }
          ]
        },
        {
          "displayName": "Deal Description",
          "name": "description",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Deal Name",
          "name": "dealName",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Deal Owner",
          "name": "dealOwner",
          "type": "resourceLocator",
          "default": {
            "mode": "list",
            "value": ""
          },
          "modes": [
            {
              "displayName": "From List",
              "name": "list",
              "type": "list",
              "placeholder": "Select from the list",
              "typeOptions": {
                "searchListMethod": "searchOwners"
              }
            },
            {
              "displayName": "By Id",
              "name": "id",
              "type": "string",
              "placeholder": "58539222",
              "validation": [
                {
                  "type": "regex",
                  "properties": {
                    "regex": "[0-9]+",
                    "errorMessage": "Not a valid HubSpot Owner ID"
                  }
                }
              ]
            }
          ],
          "description": "The HubSpot user to be assigned to the deal"
        },
        {
          "displayName": "Deal Type Name or ID",
          "name": "dealType",
          "type": "options",
          "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
          "typeOptions": {
            "loadOptionsMethod": "getDealTypes"
          },
          "default": ""
        },
        {
          "displayName": "Pipeline Name or ID",
          "name": "pipeline",
          "type": "options",
          "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
          "typeOptions": {
            "loadOptionsMethod": "getDealPipelines"
          },
          "default": ""
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "deal"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Deal to Update",
      "name": "dealId",
      "type": "resourceLocator",
      "default": {
        "mode": "list",
        "value": ""
      },
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "deal"
          ],
          "operation": [
            "update"
          ]
        }
      },
      "modes": [
        {
          "displayName": "From List",
          "name": "list",
          "type": "list",
          "placeholder": "Select from the list",
          "typeOptions": {
            "searchListMethod": "searchDeals",
            "searchable": true
          }
        },
        {
          "displayName": "By Id",
          "name": "id",
          "type": "string",
          "placeholder": "58539222",
          "validation": [
            {
              "type": "regex",
              "properties": {
                "regex": "[0-9]+",
                "errorMessage": "Not a valid HubSpot Deal ID"
              }
            }
          ]
        }
      ]
    },
    {
      "displayName": "Update Fields",
      "name": "updateFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Amount",
          "name": "amount",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Close Date",
          "name": "closeDate",
          "type": "dateTime",
          "default": "",
          "description": "When using expressions, the time should be specified in YYYY-MM-DD hh-mm-ss format"
        },
        {
          "displayName": "Custom Properties",
          "name": "customPropertiesUi",
          "placeholder": "Add Custom Property",
          "type": "fixedCollection",
          "typeOptions": {
            "multipleValues": true
          },
          "default": {},
          "options": [
            {
              "name": "customPropertiesValues",
              "displayName": "Custom Property",
              "values": [
                {
                  "displayName": "Property Name or ID",
                  "name": "property",
                  "type": "options",
                  "typeOptions": {
                    "loadOptionsMethod": "getDealCustomProperties"
                  },
                  "default": "",
                  "description": "Name of the property. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
                },
                {
                  "displayName": "Value",
                  "name": "value",
                  "type": "string",
                  "default": "",
                  "required": true,
                  "description": "Value of the property"
                }
              ]
            }
          ]
        },
        {
          "displayName": "Deal Description",
          "name": "description",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Deal Name",
          "name": "dealName",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Deal Owner",
          "name": "dealOwner",
          "type": "resourceLocator",
          "default": {
            "mode": "list",
            "value": ""
          },
          "modes": [
            {
              "displayName": "From List",
              "name": "list",
              "type": "list",
              "placeholder": "Select from the list",
              "typeOptions": {
                "searchListMethod": "searchOwners"
              }
            },
            {
              "displayName": "By Id",
              "name": "id",
              "type": "string",
              "placeholder": "58539222",
              "validation": [
                {
                  "type": "regex",
                  "properties": {
                    "regex": "[0-9]+",
                    "errorMessage": "Not a valid HubSpot Owner ID"
                  }
                }
              ]
            }
          ],
          "description": "The HubSpot user to be assigned to the deal"
        },
        {
          "displayName": "Deal Stage Name or ID",
          "name": "stage",
          "type": "options",
          "typeOptions": {
            "loadOptionsMethod": "getDealStages"
          },
          "default": "",
          "description": "The deal stage is required when creating a deal. See the CRM Pipelines API for details on managing pipelines and stages. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        },
        {
          "displayName": "Deal Type Name or ID",
          "name": "dealType",
          "type": "options",
          "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
          "typeOptions": {
            "loadOptionsMethod": "getDealTypes"
          },
          "default": ""
        },
        {
          "displayName": "Pipeline",
          "name": "pipeline",
          "type": "string",
          "default": ""
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "deal"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Deal to Get",
      "name": "dealId",
      "type": "resourceLocator",
      "default": {
        "mode": "list",
        "value": ""
      },
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "deal"
          ],
          "operation": [
            "get"
          ]
        }
      },
      "modes": [
        {
          "displayName": "From List",
          "name": "list",
          "type": "list",
          "placeholder": "Select from the list",
          "typeOptions": {
            "searchListMethod": "searchDeals",
            "searchable": true
          }
        },
        {
          "displayName": "By Id",
          "name": "id",
          "type": "string",
          "placeholder": "58539222",
          "validation": [
            {
              "type": "regex",
              "properties": {
                "regex": "[0-9]+",
                "errorMessage": "Not a valid HubSpot Deal ID"
              }
            }
          ]
        }
      ]
    },
    {
      "displayName": "Filters",
      "name": "filters",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Include Property Versions",
          "name": "includePropertyVersions",
          "type": "boolean",
          "default": false,
          "description": "By default, you will only get data for the most recent version of a property in the \"versions\" data. If you include this parameter, you will get data for all previous versions."
        },
        {
          "displayName": "Deal Properties to Include",
          "name": "propertiesCollection",
          "type": "fixedCollection",
          "default": {},
          "options": [
            {
              "name": "propertiesValues",
              "displayName": "Deal Properties to Include",
              "values": [
                {
                  "displayName": "Deal Properties to Include",
                  "name": "properties",
                  "type": "multiOptions",
                  "typeOptions": {
                    "loadOptionsMethod": "getDealProperties"
                  },
                  "default": [],
                  "description": "Whether to include specific Deal properties in the returned results. Choose from a list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>. Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
                },
                {
                  "displayName": "Include",
                  "name": "propertyMode",
                  "type": "options",
                  "options": [
                    {
                      "name": "Value And History",
                      "value": "valueAndHistory"
                    },
                    {
                      "name": "Value Only",
                      "value": "valueOnly"
                    }
                  ],
                  "default": "valueAndHistory",
                  "description": "Specify if the current value for a property should be fetched, or the value and all the historical values for that property"
                }
              ]
            }
          ],
          "description": "<p>Used to include specific deal properties in the results. By default, the results will only include Deal ID and will not include the values for any properties for your Deals.</p><p>Including this parameter will include the data for the specified property in the results. You can include this parameter multiple times to request multiple properties separated by a comma: <code>,</code>.</p>. Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "deal"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Return All",
      "name": "returnAll",
      "type": "boolean",
      "default": false,
      "description": "Whether to return all results or only up to a given limit",
      "displayOptions": {
        "show": {
          "resource": [
            "deal"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 100,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "deal"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 250
      }
    },
    {
      "displayName": "Options",
      "name": "filters",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Include Associations",
          "name": "includeAssociations",
          "type": "boolean",
          "default": false,
          "description": "Whether to include the IDs of the associated contacts and companies in the results. This will also automatically include the num_associated_contacts property."
        },
        {
          "displayName": "Deal Properties to Include",
          "name": "properties",
          "type": "multiOptions",
          "typeOptions": {
            "loadOptionsMethod": "getDealProperties"
          },
          "default": [],
          "description": "Include specific deal properties in the results. By default, the results will only include Deal ID and will not include the values for any properties for your Deals.",
          "displayOptions": {
            "show": {
              "@version": [
                {
                  "_cnd": {
                    "gt": 2
                  }
                }
              ]
            }
          }
        },
        {
          "displayName": "Deal Properties with History to Include",
          "name": "propertiesWithHistory",
          "type": "multiOptions",
          "typeOptions": {
            "loadOptionsMethod": "getDealProperties"
          },
          "default": [],
          "description": "Works similarly to properties, but this parameter will include the history for the specified property",
          "displayOptions": {
            "show": {
              "@version": [
                {
                  "_cnd": {
                    "gt": 2
                  }
                }
              ]
            }
          }
        },
        {
          "displayName": "Deal Properties to Include",
          "name": "propertiesCollection",
          "type": "fixedCollection",
          "default": {},
          "options": [
            {
              "name": "propertiesValues",
              "displayName": "Deal Properties to Include",
              "values": [
                {
                  "displayName": "Deal Properties to Include",
                  "name": "properties",
                  "type": "multiOptions",
                  "typeOptions": {
                    "loadOptionsMethod": "getDealProperties"
                  },
                  "default": [],
                  "description": "Whether to include specific Deal properties in the returned results. Choose from a list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>. Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
                },
                {
                  "displayName": "Include",
                  "name": "propertyMode",
                  "type": "options",
                  "options": [
                    {
                      "name": "Value And History",
                      "value": "valueAndHistory"
                    },
                    {
                      "name": "Value Only",
                      "value": "valueOnly"
                    }
                  ],
                  "default": "valueAndHistory",
                  "description": "Specify if the current value for a property should be fetched, or the value and all the historical values for that property"
                }
              ]
            }
          ],
          "description": "<p>Used to include specific deal properties in the results. By default, the results will only include Deal ID and will not include the values for any properties for your Deals.</p><p>Including this parameter will include the data for the specified property in the results. You can include this parameter multiple times to request multiple properties separated by a comma: <code>,</code>.</p>. Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
          "displayOptions": {
            "show": {
              "@version": [
                2
              ]
            }
          }
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "deal"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Deal to Delete",
      "name": "dealId",
      "type": "resourceLocator",
      "default": {
        "mode": "list",
        "value": ""
      },
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "deal"
          ],
          "operation": [
            "delete"
          ]
        }
      },
      "modes": [
        {
          "displayName": "From List",
          "name": "list",
          "type": "list",
          "placeholder": "Select from the list",
          "typeOptions": {
            "searchListMethod": "searchDeals",
            "searchable": true
          }
        },
        {
          "displayName": "By Id",
          "name": "id",
          "type": "string",
          "placeholder": "58539222",
          "validation": [
            {
              "type": "regex",
              "properties": {
                "regex": "[0-9]+",
                "errorMessage": "Not a valid HubSpot Deal ID"
              }
            }
          ]
        }
      ]
    },
    {
      "displayName": "Return All",
      "name": "returnAll",
      "type": "boolean",
      "default": false,
      "description": "Whether to return all results or only up to a given limit",
      "displayOptions": {
        "show": {
          "resource": [
            "deal"
          ],
          "operation": [
            "getRecentlyCreatedUpdated"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 100,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "deal"
          ],
          "operation": [
            "getRecentlyCreatedUpdated"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 250
      }
    },
    {
      "displayName": "Options",
      "name": "filters",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Since",
          "name": "since",
          "type": "dateTime",
          "default": "",
          "description": "Only return deals created after timestamp x. When using expressions, the time should be specified in YYYY-MM-DD hh-mm-ss format."
        },
        {
          "displayName": "Include Property Versions",
          "name": "includePropertyVersions",
          "type": "boolean",
          "default": false,
          "description": "By default, you will only get data for the most recent version of a property in the \"versions\" data. If you include this parameter, you will get data for all previous versions."
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "deal"
          ],
          "operation": [
            "getRecentlyCreatedUpdated"
          ]
        }
      }
    },
    {
      "displayName": "Return All",
      "name": "returnAll",
      "type": "boolean",
      "default": false,
      "description": "Whether to return all results or only up to a given limit",
      "displayOptions": {
        "show": {
          "resource": [
            "deal"
          ],
          "operation": [
            "search"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 100,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "deal"
          ],
          "operation": [
            "search"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 250
      }
    },
    {
      "displayName": "Filter Groups",
      "name": "filterGroupsUi",
      "type": "fixedCollection",
      "default": {},
      "description": "When multiple filters are provided within a Filter Group, they will be combined using a logical AND operator. When multiple Filter Groups are provided, they will be combined using a logical OR operator. The system supports a maximum of three Filter Groups with up to three filters each. More info <a href=\"https://developers.hubspot.com/docs/api/crm/search\">here</a>",
      "options": [
        {
          "name": "filterGroupsValues",
          "displayName": "Filter Group",
          "values": [
            {
              "displayName": "Filters",
              "name": "filtersUi",
              "type": "fixedCollection",
              "default": {},
              "placeholder": "Add Filter",
              "typeOptions": {
                "multipleValues": true
              },
              "options": [
                {
                  "name": "filterValues",
                  "displayName": "Filter",
                  "values": [
                    {
                      "displayName": "Property Name or ID",
                      "name": "propertyName",
                      "type": "options",
                      "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
                      "typeOptions": {
                        "loadOptionsMethod": "getDealProperties"
                      },
                      "default": ""
                    },
                    {
                      "displayName": "Type",
                      "name": "type",
                      "type": "hidden",
                      "default": "={{$parameter[\"&propertyName\"].split(\"|\")[1]}}"
                    },
                    {
                      "displayName": "Operator",
                      "name": "operator",
                      "type": "options",
                      "displayOptions": {
                        "hide": {
                          "type": [
                            "number"
                          ]
                        }
                      },
                      "options": [
                        {
                          "name": "Contains Exactly",
                          "value": "CONTAINS_TOKEN"
                        },
                        {
                          "name": "Equal",
                          "value": "EQ"
                        },
                        {
                          "name": "Is Known",
                          "value": "HAS_PROPERTY"
                        },
                        {
                          "name": "Is Unknown",
                          "value": "NOT_HAS_PROPERTY"
                        },
                        {
                          "name": "Not Equal",
                          "value": "NEQ"
                        }
                      ],
                      "default": "EQ"
                    },
                    {
                      "displayName": "Operator",
                      "name": "operator",
                      "type": "options",
                      "displayOptions": {
                        "show": {
                          "type": [
                            "number"
                          ]
                        }
                      },
                      "options": [
                        {
                          "name": "Contains Exactly",
                          "value": "CONTAINS_TOKEN"
                        },
                        {
                          "name": "Equal",
                          "value": "EQ"
                        },
                        {
                          "name": "Greater Than",
                          "value": "GT"
                        },
                        {
                          "name": "Greater Than Or Equal",
                          "value": "GTE"
                        },
                        {
                          "name": "Is Known",
                          "value": "HAS_PROPERTY"
                        },
                        {
                          "name": "Is Unknown",
                          "value": "NOT_HAS_PROPERTY"
                        },
                        {
                          "name": "Less Than",
                          "value": "LT"
                        },
                        {
                          "name": "Less Than Or Equal",
                          "value": "LTE"
                        },
                        {
                          "name": "Not Equal",
                          "value": "NEQ"
                        }
                      ],
                      "default": "EQ"
                    },
                    {
                      "displayName": "Value",
                      "name": "value",
                      "displayOptions": {
                        "hide": {
                          "operator": [
                            "HAS_PROPERTY",
                            "NOT_HAS_PROPERTY"
                          ]
                        }
                      },
                      "required": true,
                      "type": "string",
                      "default": ""
                    }
                  ]
                }
              ],
              "description": "Use filters to limit the results to only CRM objects with matching property values. More info <a href=\"https://developers.hubspot.com/docs/api/crm/search\">here</a>."
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "deal"
          ],
          "operation": [
            "search"
          ]
        }
      },
      "typeOptions": {
        "multipleValues": true
      }
    },
    {
      "displayName": "Options",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Direction",
          "name": "direction",
          "type": "options",
          "options": [
            {
              "name": "Ascending",
              "value": "ASCENDING"
            },
            {
              "name": "Descending",
              "value": "DESCENDING"
            }
          ],
          "default": "DESCENDING",
          "description": "Defines the direction in which search results are ordered. Default value is Descending."
        },
        {
          "displayName": "Field Names or IDs",
          "name": "properties",
          "type": "multiOptions",
          "typeOptions": {
            "loadOptionsMethod": "getDealProperties"
          },
          "default": [],
          "description": "Whether to include specific Deal properties in the returned results. Choose from a list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>. Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        },
        {
          "displayName": "Query",
          "name": "query",
          "type": "string",
          "default": "",
          "description": "Perform a text search against all property values for an object type"
        },
        {
          "displayName": "Sort By",
          "name": "sortBy",
          "type": "options",
          "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
          "typeOptions": {
            "loadOptionsMethod": "getDealProperties"
          },
          "default": "createdate"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "deal"
          ],
          "operation": [
            "search"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create an engagement",
          "action": "Create an engagement"
        },
        {
          "name": "Delete",
          "value": "delete",
          "description": "Delete an engagement",
          "action": "Delete an engagement"
        },
        {
          "name": "Get",
          "value": "get",
          "description": "Get an engagement",
          "action": "Get an engagement"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get many engagements",
          "action": "Get many engagements"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "engagement"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Type",
      "name": "type",
      "type": "options",
      "default": "",
      "options": [
        {
          "name": "Call",
          "value": "call"
        },
        {
          "name": "Email",
          "value": "email"
        },
        {
          "name": "Meeting",
          "value": "meeting"
        },
        {
          "name": "Task",
          "value": "task"
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "engagement"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Due Date",
      "name": "dueDate",
      "type": "dateTime",
      "default": "",
      "description": "The due date for the task",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "engagement"
          ],
          "operation": [
            "create"
          ],
          "type": [
            "task"
          ],
          "@version": [
            {
              "_cnd": {
                "gte": 2.2
              }
            }
          ]
        }
      }
    },
    {
      "displayName": "Metadata",
      "name": "metadata",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Body",
          "name": "body",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "For Object Type",
          "name": "forObjectType",
          "type": "options",
          "options": [
            {
              "name": "Company",
              "value": "COMPANY"
            },
            {
              "name": "Contact",
              "value": "CONTACT"
            }
          ],
          "default": ""
        },
        {
          "displayName": "Status",
          "name": "status",
          "type": "options",
          "options": [
            {
              "name": "Completed",
              "value": "COMPLETED"
            },
            {
              "name": "Deferred",
              "value": "DEFERRED"
            },
            {
              "name": "In Progress",
              "value": "IN_PROGRESS"
            },
            {
              "name": "Not Started",
              "value": "NOT_STARTED"
            },
            {
              "name": "Waiting",
              "value": "WAITING"
            }
          ],
          "default": ""
        },
        {
          "displayName": "Subject",
          "name": "subject",
          "type": "string",
          "default": ""
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "engagement"
          ],
          "operation": [
            "create"
          ],
          "type": [
            "task"
          ]
        }
      }
    },
    {
      "displayName": "Metadata",
      "name": "metadata",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "BCC",
          "name": "bcc",
          "type": "string",
          "typeOptions": {
            "multipleValues": true,
            "multipleValueButtonText": "Add BCC"
          },
          "default": ""
        },
        {
          "displayName": "CC",
          "name": "cc",
          "type": "string",
          "typeOptions": {
            "multipleValues": true,
            "multipleValueButtonText": "Add CC"
          },
          "default": ""
        },
        {
          "displayName": "From Email",
          "name": "fromEmail",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "From First Name",
          "name": "firstName",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "From Last Name",
          "name": "lastName",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "HTML",
          "name": "html",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Subject",
          "name": "subject",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "To Emails",
          "name": "toEmail",
          "type": "string",
          "typeOptions": {
            "multipleValues": true,
            "multipleValueButtonText": "Add Email"
          },
          "default": ""
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "engagement"
          ],
          "operation": [
            "create"
          ],
          "type": [
            "email"
          ]
        }
      }
    },
    {
      "displayName": "Metadata",
      "name": "metadata",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Body",
          "name": "body",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "End Time",
          "name": "endTime",
          "type": "dateTime",
          "default": "",
          "description": "When using expressions, the time should be specified in YYYY-MM-DD hh-mm-ss format"
        },
        {
          "displayName": "Internal Meeting Notes",
          "name": "internalMeetingNotes",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Start Time",
          "name": "startTime",
          "type": "dateTime",
          "default": "",
          "description": "When using expressions, the time should be specified in YYYY-MM-DD hh-mm-ss format"
        },
        {
          "displayName": "Title",
          "name": "title",
          "type": "string",
          "default": ""
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "engagement"
          ],
          "operation": [
            "create"
          ],
          "type": [
            "meeting"
          ]
        }
      }
    },
    {
      "displayName": "Metadata",
      "name": "metadata",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Body",
          "name": "body",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Duration Milliseconds",
          "name": "durationMilliseconds",
          "type": "number",
          "default": 0
        },
        {
          "displayName": "From Number",
          "name": "fromNumber",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Recording URL",
          "name": "recordingUrl",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Status",
          "name": "status",
          "type": "options",
          "options": [
            {
              "name": "Busy",
              "value": "BUSY"
            },
            {
              "name": "Calling CRM User",
              "value": "CALLING_CRM_USER"
            },
            {
              "name": "Canceled",
              "value": "CANCELED"
            },
            {
              "name": "Completed",
              "value": "COMPLETED"
            },
            {
              "name": "Connecting",
              "value": "CONNECTING"
            },
            {
              "name": "Failed",
              "value": "FAILED"
            },
            {
              "name": "In Progress",
              "value": "IN_PROGRESS"
            },
            {
              "name": "No Answer",
              "value": "NO_ANSWER"
            },
            {
              "name": "Queued",
              "value": "QUEUED"
            },
            {
              "name": "Ringing",
              "value": "RINGING"
            }
          ],
          "default": "QUEUED"
        },
        {
          "displayName": "To Number",
          "name": "toNumber",
          "type": "string",
          "default": ""
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "engagement"
          ],
          "operation": [
            "create"
          ],
          "type": [
            "call"
          ]
        }
      }
    },
    {
      "displayName": "Engagement Properties",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Associations",
          "name": "associations",
          "type": "collection",
          "placeholder": "Add Field",
          "default": {},
          "options": [
            {
              "displayName": "Company IDs",
              "name": "companyIds",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "Contact IDs",
              "name": "contactIds",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "Deals IDs",
              "name": "dealIds",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "Owner IDs",
              "name": "ownerIds",
              "type": "string",
              "default": "",
              "displayOptions": {
                "show": {
                  "@version": [
                    {
                      "_cnd": {
                        "lt": 2.2
                      }
                    }
                  ]
                }
              }
            },
            {
              "displayName": "Owner ID",
              "name": "ownerId",
              "type": "number",
              "default": 0,
              "displayOptions": {
                "show": {
                  "@version": [
                    {
                      "_cnd": {
                        "gte": 2.2
                      }
                    }
                  ]
                }
              }
            },
            {
              "displayName": "Ticket IDs",
              "name": "ticketIds",
              "type": "string",
              "default": ""
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "engagement"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Engagement to Get",
      "name": "engagementId",
      "type": "resourceLocator",
      "default": {
        "mode": "list",
        "value": ""
      },
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "engagement"
          ],
          "operation": [
            "get"
          ]
        }
      },
      "modes": [
        {
          "displayName": "From List",
          "name": "list",
          "type": "list",
          "placeholder": "Select from the list",
          "typeOptions": {
            "searchListMethod": "searchEngagements"
          }
        },
        {
          "displayName": "By Id",
          "name": "id",
          "type": "string",
          "placeholder": "58539222",
          "validation": [
            {
              "type": "regex",
              "properties": {
                "regex": "[0-9]+",
                "errorMessage": "Not a valid HubSpot Engagement ID"
              }
            }
          ]
        }
      ]
    },
    {
      "displayName": "Engagement to Delete",
      "name": "engagementId",
      "type": "resourceLocator",
      "default": {
        "mode": "list",
        "value": ""
      },
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "engagement"
          ],
          "operation": [
            "delete"
          ]
        }
      },
      "modes": [
        {
          "displayName": "From List",
          "name": "list",
          "type": "list",
          "placeholder": "Select from the list",
          "typeOptions": {
            "searchListMethod": "searchEngagements"
          }
        },
        {
          "displayName": "By Id",
          "name": "id",
          "type": "string",
          "placeholder": "58539222",
          "validation": [
            {
              "type": "regex",
              "properties": {
                "regex": "[0-9]+",
                "errorMessage": "Not a valid HubSpot Engagement ID"
              }
            }
          ]
        }
      ]
    },
    {
      "displayName": "Return All",
      "name": "returnAll",
      "type": "boolean",
      "default": false,
      "description": "Whether to return all results or only up to a given limit",
      "displayOptions": {
        "show": {
          "resource": [
            "engagement"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 100,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "engagement"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 250
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create a ticket",
          "action": "Create a ticket"
        },
        {
          "name": "Delete",
          "value": "delete",
          "description": "Delete a ticket",
          "action": "Delete a ticket"
        },
        {
          "name": "Get",
          "value": "get",
          "description": "Get a ticket",
          "action": "Get a ticket"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get many tickets",
          "action": "Get many tickets"
        },
        {
          "name": "Update",
          "value": "update",
          "description": "Update a ticket",
          "action": "Update a ticket"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "ticket"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Pipeline Name or ID",
      "name": "pipelineId",
      "type": "options",
      "default": "",
      "description": "The ID of the pipeline the ticket is in. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "ticket"
          ],
          "operation": [
            "create"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getTicketPipelines"
      }
    },
    {
      "displayName": "Stage Name or ID",
      "name": "stageId",
      "type": "options",
      "default": "",
      "description": "The stage ID of the pipeline the ticket is in; depends on Pipeline ID. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "ticket"
          ],
          "operation": [
            "create"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getTicketStages",
        "loadOptionsDependsOn": [
          "pipelineId"
        ]
      }
    },
    {
      "displayName": "Ticket Name",
      "name": "ticketName",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "ticket"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Ticket Properties",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Company Names or IDs",
          "name": "associatedCompanyIds",
          "type": "multiOptions",
          "typeOptions": {
            "loadOptionsMethod": "getCompanies"
          },
          "default": [],
          "description": "Whether to include specific Company properties in the returned results. Choose from a list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>. Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        },
        {
          "displayName": "Contact Names or IDs",
          "name": "associatedContactIds",
          "type": "multiOptions",
          "typeOptions": {
            "loadOptionsMethod": "getContacts"
          },
          "default": [],
          "description": "Whether to include specific Contact properties in the returned results. Choose from a list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>. Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        },
        {
          "displayName": "Category Name or ID",
          "name": "category",
          "type": "options",
          "typeOptions": {
            "loadOptionsMethod": "getTicketCategories"
          },
          "default": "",
          "description": "Main reason customer reached out for help. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        },
        {
          "displayName": "Close Date",
          "name": "closeDate",
          "type": "dateTime",
          "default": "",
          "description": "The date the ticket was closed. When using expressions, the time should be specified in YYYY-MM-DD hh-mm-ss format."
        },
        {
          "displayName": "Create Date",
          "name": "createDate",
          "type": "dateTime",
          "default": "",
          "description": "The date the ticket was created. When using expressions, the time should be specified in YYYY-MM-DD hh-mm-ss format."
        },
        {
          "displayName": "Description",
          "name": "description",
          "type": "string",
          "typeOptions": {
            "alwaysOpenEditWindow": true
          },
          "default": "",
          "description": "Description of the ticket"
        },
        {
          "displayName": "Priority Name or ID",
          "name": "priority",
          "type": "options",
          "typeOptions": {
            "loadOptionsMethod": "getTicketPriorities"
          },
          "default": "",
          "description": "The level of attention needed on the ticket. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        },
        {
          "displayName": "Resolution Name or ID",
          "name": "resolution",
          "type": "options",
          "typeOptions": {
            "loadOptionsMethod": "getTicketResolutions"
          },
          "default": "",
          "description": "The action taken to resolve the ticket. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        },
        {
          "displayName": "Source Name or ID",
          "name": "source",
          "type": "options",
          "typeOptions": {
            "loadOptionsMethod": "getTicketSources"
          },
          "default": "",
          "description": "Channel where ticket was originally submitted. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        },
        {
          "displayName": "Ticket Owner Name or ID",
          "name": "ticketOwnerId",
          "type": "options",
          "typeOptions": {
            "loadOptionsMethod": "getOwners"
          },
          "default": "",
          "description": "The user from your team that the ticket is assigned to. You can assign additional users to a ticket record by creating a custom HubSpot user property. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "ticket"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Ticket to Update",
      "name": "ticketId",
      "type": "resourceLocator",
      "default": {
        "mode": "list",
        "value": ""
      },
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "ticket"
          ],
          "operation": [
            "update"
          ]
        }
      },
      "modes": [
        {
          "displayName": "From List",
          "name": "list",
          "type": "list",
          "placeholder": "Select from the list",
          "typeOptions": {
            "searchListMethod": "searchTickets"
          }
        },
        {
          "displayName": "By Id",
          "name": "id",
          "type": "string",
          "placeholder": "58539222",
          "validation": [
            {
              "type": "regex",
              "properties": {
                "regex": "[0-9]+",
                "errorMessage": "Not a valid HubSpot Ticket ID"
              }
            }
          ]
        }
      ]
    },
    {
      "displayName": "Update Fields",
      "name": "updateFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Company Names or IDs",
          "name": "associatedCompanyIds",
          "type": "multiOptions",
          "typeOptions": {
            "loadOptionsMethod": "getCompanies"
          },
          "default": [],
          "description": "Whether to include specific Company properties in the returned results. Choose from a list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>. Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        },
        {
          "displayName": "Contact Names or IDs",
          "name": "associatedContactIds",
          "type": "multiOptions",
          "typeOptions": {
            "loadOptionsMethod": "getContacts"
          },
          "default": [],
          "description": "Whether to include specific Contact properties in the returned results. Choose from a list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>. Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        },
        {
          "displayName": "Category Name or ID",
          "name": "category",
          "type": "options",
          "typeOptions": {
            "loadOptionsMethod": "getTicketCategories"
          },
          "default": "",
          "description": "Main reason customer reached out for help. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        },
        {
          "displayName": "Close Date",
          "name": "closeDate",
          "type": "dateTime",
          "default": "",
          "description": "The date the ticket was closed. When using expressions, the time should be specified in YYYY-MM-DD hh-mm-ss format."
        },
        {
          "displayName": "Create Date",
          "name": "createDate",
          "type": "dateTime",
          "default": "",
          "description": "The date the ticket was created. When using expressions, the time should be specified in YYYY-MM-DD hh-mm-ss format."
        },
        {
          "displayName": "Description",
          "name": "description",
          "type": "string",
          "typeOptions": {
            "alwaysOpenEditWindow": true
          },
          "default": "",
          "description": "Description of the ticket"
        },
        {
          "displayName": "Pipeline Name or ID",
          "name": "pipelineId",
          "type": "options",
          "typeOptions": {
            "loadOptionsMethod": "getTicketPipelines"
          },
          "default": "",
          "description": "The ID of the pipeline the ticket is in. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        },
        {
          "displayName": "Priority Name or ID",
          "name": "priority",
          "type": "options",
          "typeOptions": {
            "loadOptionsMethod": "getTicketPriorities"
          },
          "default": "",
          "description": "The level of attention needed on the ticket. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        },
        {
          "displayName": "Resolution Name or ID",
          "name": "resolution",
          "type": "options",
          "typeOptions": {
            "loadOptionsMethod": "getTicketResolutions"
          },
          "default": "",
          "description": "The action taken to resolve the ticket. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        },
        {
          "displayName": "Source Name or ID",
          "name": "source",
          "type": "options",
          "typeOptions": {
            "loadOptionsMethod": "getTicketSources"
          },
          "default": "",
          "description": "Channel where ticket was originally submitted. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        },
        {
          "displayName": "Stage Name or ID",
          "name": "stageId",
          "type": "options",
          "typeOptions": {
            "loadOptionsMethod": "getTicketStages",
            "loadOptionsDependsOn": [
              "updateFields.pipelineId"
            ]
          },
          "default": "",
          "description": "The stage ID of the pipeline the ticket is in; depends on Pipeline ID. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        },
        {
          "displayName": "Ticket Name",
          "name": "ticketName",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Ticket Owner Name or ID",
          "name": "ticketOwnerId",
          "type": "options",
          "typeOptions": {
            "loadOptionsMethod": "getOwners"
          },
          "default": "",
          "description": "The user from your team that the ticket is assigned to. You can assign additional users to a ticket record by creating a custom HubSpot user property. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "ticket"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Ticket to Get",
      "name": "ticketId",
      "type": "resourceLocator",
      "default": {
        "mode": "list",
        "value": ""
      },
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "ticket"
          ],
          "operation": [
            "get"
          ]
        }
      },
      "modes": [
        {
          "displayName": "From List",
          "name": "list",
          "type": "list",
          "placeholder": "Select from the list",
          "typeOptions": {
            "searchListMethod": "searchTickets"
          }
        },
        {
          "displayName": "By Id",
          "name": "id",
          "type": "string",
          "placeholder": "58539222",
          "validation": [
            {
              "type": "regex",
              "properties": {
                "regex": "[0-9]+",
                "errorMessage": "Not a valid HubSpot Ticket ID"
              }
            }
          ]
        }
      ]
    },
    {
      "displayName": "Options",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Include Deleted",
          "name": "includeDeleted",
          "type": "boolean",
          "default": false
        },
        {
          "displayName": "Ticket Properties to Include",
          "name": "properties",
          "type": "multiOptions",
          "typeOptions": {
            "loadOptionsMethod": "getTicketProperties"
          },
          "default": [],
          "description": "Whether to include specific Ticket properties in the returned results. Choose from a list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>. Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        },
        {
          "displayName": "Properties With History",
          "name": "propertiesWithHistory",
          "type": "string",
          "default": "",
          "description": "Works similarly to properties=, but this parameter will include the history for the specified property, instead of just including the current value. Use this parameter when you need the full history of changes to a property's value."
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "ticket"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Return All",
      "name": "returnAll",
      "type": "boolean",
      "default": false,
      "description": "Whether to return all results or only up to a given limit",
      "displayOptions": {
        "show": {
          "resource": [
            "ticket"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 100,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "ticket"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 250
      }
    },
    {
      "displayName": "Options",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Ticket Properties to Include",
          "name": "properties",
          "type": "multiOptions",
          "typeOptions": {
            "loadOptionsMethod": "getTicketProperties"
          },
          "default": [],
          "description": "Whether to include specific Ticket properties in the returned results. Choose from a list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>. Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        },
        {
          "displayName": "Properties With History",
          "name": "propertiesWithHistory",
          "type": "string",
          "default": "",
          "description": "Works similarly to properties=, but this parameter will include the history for the specified property, instead of just including the current value. Use this parameter when you need the full history of changes to a property's value."
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "ticket"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Ticket to Delete",
      "name": "ticketId",
      "type": "resourceLocator",
      "default": {
        "mode": "list",
        "value": ""
      },
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "ticket"
          ],
          "operation": [
            "delete"
          ]
        }
      },
      "modes": [
        {
          "displayName": "From List",
          "name": "list",
          "type": "list",
          "placeholder": "Select from the list",
          "typeOptions": {
            "searchListMethod": "searchTickets"
          }
        },
        {
          "displayName": "By Id",
          "name": "id",
          "type": "string",
          "placeholder": "58539222",
          "validation": [
            {
              "type": "regex",
              "properties": {
                "regex": "[0-9]+",
                "errorMessage": "Not a valid HubSpot Ticket ID"
              }
            }
          ]
        }
      ]
    }
  ]

operations:
  [
    {
      "operation": "upsert",
      "name": "Create or Update",
      "description": "Create a new contact, or update the current one if it already exists (upsert)"
    },
    {
      "operation": "delete",
      "name": "Delete",
      "description": "Delete a contact"
    },
    {
      "operation": "get",
      "name": "Get",
      "description": "Get a contact"
    },
    {
      "operation": "getAll",
      "name": "Get Many",
      "description": "Get many contacts"
    },
    {
      "operation": "getRecentlyCreatedUpdated",
      "name": "Get Recently Created/Updated",
      "description": "Get recently created/updated contacts"
    },
    {
      "operation": "search",
      "name": "Search",
      "description": "Search contacts"
    }
  ]

credentials_required:
  [
    {
      "name": "hubspotApi",
      "required": true,
      "testedBy": "hubspotApiTest",
      "displayOptions": {
        "show": {
          "authentication": [
            "apiKey"
          ]
        }
      }
    },
    {
      "name": "hubspotAppToken",
      "required": true,
      "testedBy": "hubspotApiTest",
      "displayOptions": {
        "show": {
          "authentication": [
            "appToken"
          ]
        }
      }
    },
    {
      "name": "hubspotOAuth2Api",
      "required": true,
      "displayOptions": {
        "show": {
          "authentication": [
            "oAuth2"
          ]
        }
      }
    }
  ]


