# nodes

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

outputs:
  [
  "main"
  ]

updated_at: 2025-12-11 23:50:26
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: HubSpot Trigger node documentation
  description: Learn how to use the HubSpot Trigger node in n8n. Follow technical documentation to integrate HubSpot Trigger node into your workflows.
  contentType: [integration, reference]
  priority: medium
  ---

  # HubSpot Trigger node

  [HubSpot](https://www.hubspot.com/){:target=_blank .external-link} provides tools for social media marketing, content management, web analytics, landing pages, customer support, and search engine optimization.

  /// warning | Webhooks
  If you activate a second trigger, the previous trigger stops working. This is because the trigger registers a new webhook with HubSpot when activated. HubSpot only allows one webhook at a time. 
  ///

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

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

  ## Events

  * Company
  	* Created
  	* Deleted
  	* Property changed
  * Contact
  	* Created
  	* Deleted
  	* Privacy deleted
  	* Property changed
  * Conversation
  	* Created
  	* Deleted
  	* New message
  	* Privacy deletion
  	* Property changed
  * Deal
  	* Created
  	* Deleted
  	* Property changed
  * Ticket
  	* Created
  	* Deleted
  	* Property changed 

  ## Related resources

  n8n provides an app node for HubSpot. You can find the node docs [here](/integrations/builtin/app-nodes/n8n-nodes-base.hubspot.md).

  View [example workflows and related content](https://n8n.io/integrations/hubspot-trigger/){:target=_blank .external-link} on n8n's website.

  Refer to [HubSpot's documentation](https://developers.hubspot.com/docs/api/overview){:target=_blank .external-link} for details about their API.

properties_schema:
  [
    {
      "displayName": "Events",
      "name": "eventsUi",
      "type": "fixedCollection",
      "default": {},
      "options": [
        {
          "displayName": "Event",
          "name": "eventValues",
          "values": [
            {
              "displayName": "Name",
              "name": "name",
              "type": "options",
              "options": [
                {
                  "name": "Company Created",
                  "value": "company.creation",
                  "description": "To get notified if any company is created in a customer's account"
                },
                {
                  "name": "Company Deleted",
                  "value": "company.deletion",
                  "description": "To get notified if any company is deleted in a customer's account"
                },
                {
                  "name": "Company Property Changed",
                  "value": "company.propertyChange",
                  "description": "To get notified if a specified property is changed for any company in a customer's account"
                },
                {
                  "name": "Contact Created",
                  "value": "contact.creation",
                  "description": "To get notified if any contact is created in a customer's account"
                },
                {
                  "name": "Contact Deleted",
                  "value": "contact.deletion",
                  "description": "To get notified if any contact is deleted in a customer's account"
                },
                {
                  "name": "Contact Privacy Deleted",
                  "value": "contact.privacyDeletion",
                  "description": "To get notified if a contact is deleted for privacy compliance reasons"
                },
                {
                  "name": "Contact Property Changed",
                  "value": "contact.propertyChange",
                  "description": "To get notified if a specified property is changed for any contact in a customer's account"
                },
                {
                  "name": "Conversation Creation",
                  "value": "conversation.creation",
                  "description": "To get notified if a new thread is created in an account"
                },
                {
                  "name": "Conversation Deletion",
                  "value": "conversation.deletion",
                  "description": "To get notified if a thread is archived or soft-deleted in an account"
                },
                {
                  "name": "Conversation New Message",
                  "value": "conversation.newMessage",
                  "description": "To get notified if a new message on a thread has been received"
                },
                {
                  "name": "Conversation Privacy Deletion",
                  "value": "conversation.privacyDeletion",
                  "description": "To get notified if a thread is permanently deleted in an account"
                },
                {
                  "name": "Conversation Property Change",
                  "value": "conversation.propertyChange",
                  "description": "To get notified if a property on a thread has been changed"
                },
                {
                  "name": "Deal Created",
                  "value": "deal.creation",
                  "description": "To get notified if any deal is created in a customer's account"
                },
                {
                  "name": "Deal Deleted",
                  "value": "deal.deletion",
                  "description": "To get notified if any deal is deleted in a customer's account"
                },
                {
                  "name": "Deal Property Changed",
                  "value": "deal.propertyChange",
                  "description": "To get notified if a specified property is changed for any deal in a customer's account"
                },
                {
                  "name": "Ticket Created",
                  "value": "ticket.creation",
                  "description": "To get notified if a ticket is created in a customer's account"
                },
                {
                  "name": "Ticket Deleted",
                  "value": "ticket.deletion",
                  "description": "To get notified if any ticket is deleted in a customer's account"
                },
                {
                  "name": "Ticket Property Changed",
                  "value": "ticket.propertyChange",
                  "description": "To get notified if a specified property is changed for any ticket in a customer's account"
                }
              ],
              "default": "contact.creation",
              "required": true
            },
            {
              "displayName": "Property Name or ID",
              "name": "property",
              "type": "options",
              "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
              "typeOptions": {
                "loadOptionsDependsOn": [
                  "contact.propertyChange"
                ],
                "loadOptionsMethod": "getContactProperties"
              },
              "displayOptions": {
                "show": {
                  "name": [
                    "contact.propertyChange"
                  ]
                }
              },
              "default": "",
              "required": true
            },
            {
              "displayName": "Property Name or ID",
              "name": "property",
              "type": "options",
              "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
              "typeOptions": {
                "loadOptionsDependsOn": [
                  "company.propertyChange"
                ],
                "loadOptionsMethod": "getCompanyProperties"
              },
              "displayOptions": {
                "show": {
                  "name": [
                    "company.propertyChange"
                  ]
                }
              },
              "default": "",
              "required": true
            },
            {
              "displayName": "Property Name or ID",
              "name": "property",
              "type": "options",
              "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
              "typeOptions": {
                "loadOptionsDependsOn": [
                  "deal.propertyChange"
                ],
                "loadOptionsMethod": "getDealProperties"
              },
              "displayOptions": {
                "show": {
                  "name": [
                    "deal.propertyChange"
                  ]
                }
              },
              "default": "",
              "required": true
            }
          ]
        }
      ],
      "typeOptions": {
        "multipleValues": true
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Max Concurrent Requests",
          "name": "maxConcurrentRequests",
          "type": "number",
          "typeOptions": {
            "minValue": 5
          },
          "default": 5
        }
      ]
    }
  ]


node_type: nodes-base.humanticAiTool
package_name: n8n-nodes-base
display_name: Humantic AI Tool
description: Consume Humantic AI API (AI Tool variant for use with AI Agents)
category: output
development_style: programmatic
tool_variant_of: nodes-base.humanticAi
version: 1
credentials_required:
  [
  {
  "name": "humanticAiApi",
  "required": true
  }
  ]

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

output_names:
  [
  "Tool"
  ]

updated_at: 2025-12-11 23:50:26
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: Humantic AI node documentation
  description: Learn how to use the Humantic AI node in n8n. Follow technical documentation to integrate Humantic AI node into your workflows.
  contentType: [integration, reference]
  ---

  # Humantic AI node

  Use the Humantic AI node to automate work in Humantic AI, and integrate Humantic AI with other applications. n8n has built-in support for a wide range of Humantic AI features, including creating, retrieving, and updating profiles. 

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

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

  ## Operations

  * Profile
      * Create a profile
      * Retrieve a profile
      * Update a profile

  ## Templates and examples

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

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 Humantic AI"
    },
    {
      "displayName": "Resource",
      "name": "resource",
      "type": "options",
      "default": "profile",
      "options": [
        {
          "name": "Profile",
          "value": "profile"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create a profile",
          "action": "Create a profile"
        },
        {
          "name": "Get",
          "value": "get",
          "description": "Retrieve a profile",
          "action": "Get a profile"
        },
        {
          "name": "Update",
          "value": "update",
          "description": "Update a profile",
          "action": "Update a profile"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "profile"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "User ID",
      "name": "userId",
      "type": "string",
      "default": "",
      "description": "The LinkedIn profile URL or email ID for creating a Humantic profile. If you are sending the resume, this should be a unique string.",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "create"
          ],
          "resource": [
            "profile"
          ]
        }
      }
    },
    {
      "displayName": "Send Resume",
      "name": "sendResume",
      "type": "boolean",
      "default": false,
      "description": "Whether to send a resume for a resume based analysis",
      "displayOptions": {
        "show": {
          "operation": [
            "create"
          ],
          "resource": [
            "profile"
          ]
        }
      }
    },
    {
      "displayName": "Input Binary Field",
      "name": "binaryPropertyName",
      "type": "string",
      "default": "data",
      "displayOptions": {
        "show": {
          "operation": [
            "create"
          ],
          "resource": [
            "profile"
          ],
          "sendResume": [
            true
          ]
        }
      }
    },
    {
      "displayName": "User ID",
      "name": "userId",
      "type": "string",
      "default": "",
      "description": "This value is the same as the User ID that was provided when the analysis was created. This could be a LinkedIn URL, email ID, or a unique string in case of resume based analysis.",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "get"
          ],
          "resource": [
            "profile"
          ]
        }
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Persona",
          "name": "persona",
          "type": "multiOptions",
          "options": [
            {
              "name": "Sales",
              "value": "sales"
            },
            {
              "name": "Hiring",
              "value": "hiring"
            }
          ],
          "default": [],
          "description": "Fetch the Humantic profile of the user for a particular persona type. Multiple persona values can be supported using comma as a delimiter."
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "get"
          ],
          "resource": [
            "profile"
          ]
        }
      }
    },
    {
      "displayName": "User ID",
      "name": "userId",
      "type": "string",
      "default": "",
      "description": "This value is the same as the User ID that was provided when the analysis was created. Currently only supported for profiles created using LinkedIn URL.",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "update"
          ],
          "resource": [
            "profile"
          ]
        }
      }
    },
    {
      "displayName": "Send Resume",
      "name": "sendResume",
      "type": "boolean",
      "default": false,
      "description": "Whether to send a resume for a resume of the user",
      "displayOptions": {
        "show": {
          "operation": [
            "update"
          ],
          "resource": [
            "profile"
          ]
        }
      }
    },
    {
      "displayName": "Text",
      "name": "text",
      "type": "string",
      "default": "",
      "description": "Additional text written by the user",
      "displayOptions": {
        "show": {
          "operation": [
            "update"
          ],
          "resource": [
            "profile"
          ],
          "sendResume": [
            false
          ]
        }
      }
    },
    {
      "displayName": "Input Binary Field",
      "name": "binaryPropertyName",
      "type": "string",
      "default": "data",
      "displayOptions": {
        "show": {
          "operation": [
            "update"
          ],
          "resource": [
            "profile"
          ],
          "sendResume": [
            true
          ]
        }
      }
    }
  ]

operations:
  [
    {
      "operation": "create",
      "name": "Create",
      "description": "Create a profile"
    },
    {
      "operation": "get",
      "name": "Get",
      "description": "Retrieve a profile"
    },
    {
      "operation": "update",
      "name": "Update",
      "description": "Update a profile"
    }
  ]


node_type: nodes-base.humanticAi
package_name: n8n-nodes-base
display_name: Humantic AI
description: Consume Humantic AI API
category: output
development_style: programmatic
version: 1
credentials_required:
  [
  {
  "name": "humanticAiApi",
  "required": true
  }
  ]

outputs:
  [
  "main"
  ]

updated_at: 2025-12-11 23:50:26
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: Humantic AI node documentation
  description: Learn how to use the Humantic AI node in n8n. Follow technical documentation to integrate Humantic AI node into your workflows.
  contentType: [integration, reference]
  ---

  # Humantic AI node

  Use the Humantic AI node to automate work in Humantic AI, and integrate Humantic AI with other applications. n8n has built-in support for a wide range of Humantic AI features, including creating, retrieving, and updating profiles. 

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

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

  ## Operations

  * Profile
      * Create a profile
      * Retrieve a profile
      * Update a profile

  ## Templates and examples

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

properties_schema:
  [
    {
      "displayName": "Resource",
      "name": "resource",
      "type": "options",
      "default": "profile",
      "options": [
        {
          "name": "Profile",
          "value": "profile"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create a profile",
          "action": "Create a profile"
        },
        {
          "name": "Get",
          "value": "get",
          "description": "Retrieve a profile",
          "action": "Get a profile"
        },
        {
          "name": "Update",
          "value": "update",
          "description": "Update a profile",
          "action": "Update a profile"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "profile"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "User ID",
      "name": "userId",
      "type": "string",
      "default": "",
      "description": "The LinkedIn profile URL or email ID for creating a Humantic profile. If you are sending the resume, this should be a unique string.",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "create"
          ],
          "resource": [
            "profile"
          ]
        }
      }
    },
    {
      "displayName": "Send Resume",
      "name": "sendResume",
      "type": "boolean",
      "default": false,
      "description": "Whether to send a resume for a resume based analysis",
      "displayOptions": {
        "show": {
          "operation": [
            "create"
          ],
          "resource": [
            "profile"
          ]
        }
      }
    },
    {
      "displayName": "Input Binary Field",
      "name": "binaryPropertyName",
      "type": "string",
      "default": "data",
      "displayOptions": {
        "show": {
          "operation": [
            "create"
          ],
          "resource": [
            "profile"
          ],
          "sendResume": [
            true
          ]
        }
      }
    },
    {
      "displayName": "User ID",
      "name": "userId",
      "type": "string",
      "default": "",
      "description": "This value is the same as the User ID that was provided when the analysis was created. This could be a LinkedIn URL, email ID, or a unique string in case of resume based analysis.",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "get"
          ],
          "resource": [
            "profile"
          ]
        }
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Persona",
          "name": "persona",
          "type": "multiOptions",
          "options": [
            {
              "name": "Sales",
              "value": "sales"
            },
            {
              "name": "Hiring",
              "value": "hiring"
            }
          ],
          "default": [],
          "description": "Fetch the Humantic profile of the user for a particular persona type. Multiple persona values can be supported using comma as a delimiter."
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "get"
          ],
          "resource": [
            "profile"
          ]
        }
      }
    },
    {
      "displayName": "User ID",
      "name": "userId",
      "type": "string",
      "default": "",
      "description": "This value is the same as the User ID that was provided when the analysis was created. Currently only supported for profiles created using LinkedIn URL.",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "update"
          ],
          "resource": [
            "profile"
          ]
        }
      }
    },
    {
      "displayName": "Send Resume",
      "name": "sendResume",
      "type": "boolean",
      "default": false,
      "description": "Whether to send a resume for a resume of the user",
      "displayOptions": {
        "show": {
          "operation": [
            "update"
          ],
          "resource": [
            "profile"
          ]
        }
      }
    },
    {
      "displayName": "Text",
      "name": "text",
      "type": "string",
      "default": "",
      "description": "Additional text written by the user",
      "displayOptions": {
        "show": {
          "operation": [
            "update"
          ],
          "resource": [
            "profile"
          ],
          "sendResume": [
            false
          ]
        }
      }
    },
    {
      "displayName": "Input Binary Field",
      "name": "binaryPropertyName",
      "type": "string",
      "default": "data",
      "displayOptions": {
        "show": {
          "operation": [
            "update"
          ],
          "resource": [
            "profile"
          ],
          "sendResume": [
            true
          ]
        }
      }
    }
  ]

operations:
  [
    {
      "operation": "create",
      "name": "Create",
      "description": "Create a profile"
    },
    {
      "operation": "get",
      "name": "Get",
      "description": "Retrieve a profile"
    },
    {
      "operation": "update",
      "name": "Update",
      "description": "Update a profile"
    }
  ]


node_type: nodes-base.hunterTool
package_name: n8n-nodes-base
display_name: Hunter Tool
description: Consume Hunter API (AI Tool variant for use with AI Agents)
category: output
development_style: programmatic
tool_variant_of: nodes-base.hunter
version: 1
credentials_required:
  [
  {
  "name": "hunterApi",
  "required": true
  }
  ]

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

output_names:
  [
  "Tool"
  ]

updated_at: 2025-12-11 23:50:26
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: Hunter node documentation
  description: Learn how to use the Hunter node in n8n. Follow technical documentation to integrate Hunter node into your workflows.
  contentType: [integration, reference]
  ---

  # Hunter node

  Use the Hunter node to automate work in Hunter, and integrate Hunter with other applications. n8n has built-in support for a wide range of Hunter features, including getting, generating, and verifying email addresses. 

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

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

  ## Operations

  * Get every email address found on the internet using a given domain name, with sources
  * Generate or retrieve the most likely email address from a domain name, a first name and a last name
  * Verify the deliverability of an email address

  ## Templates and examples

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

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 Hunter"
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "domainSearch",
      "description": "Operation to consume",
      "options": [
        {
          "name": "Domain Search",
          "value": "domainSearch",
          "description": "Get every email address found on the internet using a given domain name, with sources",
          "action": "Get every email address found on the internet using a given domain name, with sources"
        },
        {
          "name": "Email Finder",
          "value": "emailFinder",
          "description": "Generate or retrieve the most likely email address from a domain name, a first name and a last name",
          "action": "Generate or retrieve the most likely email address from a domain name, a first name and a last name"
        },
        {
          "name": "Email Verifier",
          "value": "emailVerifier",
          "description": "Verify the deliverability of an email address",
          "action": "Verify the deliverability of an email address"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "Domain",
      "name": "domain",
      "type": "string",
      "default": "",
      "description": "Domain name from which you want to find the email addresses. For example, \"stripe.com\".",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "domainSearch"
          ]
        }
      }
    },
    {
      "displayName": "Only Emails",
      "name": "onlyEmails",
      "type": "boolean",
      "default": true,
      "description": "Whether to return only the found emails",
      "displayOptions": {
        "show": {
          "operation": [
            "domainSearch"
          ]
        }
      }
    },
    {
      "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": [
            "domainSearch"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 100,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "operation": [
            "domainSearch"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 100
      }
    },
    {
      "displayName": "Filters",
      "name": "filters",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Type",
          "name": "type",
          "type": "options",
          "default": "",
          "options": [
            {
              "name": "Personal",
              "value": "personal"
            },
            {
              "name": "Generic",
              "value": "generic"
            }
          ]
        },
        {
          "displayName": "Seniority",
          "name": "seniority",
          "type": "multiOptions",
          "default": [],
          "options": [
            {
              "name": "Junior",
              "value": "junior"
            },
            {
              "name": "Senior",
              "value": "senior"
            },
            {
              "name": "Executive",
              "value": "executive"
            }
          ]
        },
        {
          "displayName": "Department",
          "name": "department",
          "type": "multiOptions",
          "default": [],
          "options": [
            {
              "name": "Communication",
              "value": "communication"
            },
            {
              "name": "Executive",
              "value": "executive"
            },
            {
              "name": "Finance",
              "value": "finance"
            },
            {
              "name": "HR",
              "value": "hr"
            },
            {
              "name": "IT",
              "value": "it"
            },
            {
              "name": "Legal",
              "value": "legal"
            },
            {
              "name": "Management",
              "value": "management"
            },
            {
              "name": "Marketing",
              "value": "marketing"
            },
            {
              "name": "Sales",
              "value": "sales"
            },
            {
              "name": "Support",
              "value": "support"
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "domainSearch"
          ]
        }
      }
    },
    {
      "displayName": "Domain",
      "name": "domain",
      "type": "string",
      "default": "",
      "description": "Domain name from which you want to find the email addresses. For example, \"stripe.com\".",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "emailFinder"
          ]
        }
      }
    },
    {
      "displayName": "First Name",
      "name": "firstname",
      "type": "string",
      "default": "",
      "description": "The person's first name. It doesn't need to be in lowercase.",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "emailFinder"
          ]
        }
      }
    },
    {
      "displayName": "Last Name",
      "name": "lastname",
      "type": "string",
      "default": "",
      "description": "The person's last name. It doesn't need to be in lowercase.",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "emailFinder"
          ]
        }
      }
    },
    {
      "displayName": "Email",
      "name": "email",
      "type": "string",
      "default": "",
      "description": "The email address you want to verify",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "emailVerifier"
          ]
        }
      }
    }
  ]

operations:
  [
    {
      "operation": "domainSearch",
      "name": "Domain Search",
      "description": "Get every email address found on the internet using a given domain name, with sources"
    },
    {
      "operation": "emailFinder",
      "name": "Email Finder",
      "description": "Generate or retrieve the most likely email address from a domain name, a first name and a last name"
    },
    {
      "operation": "emailVerifier",
      "name": "Email Verifier",
      "description": "Verify the deliverability of an email address"
    }
  ]


node_type: nodes-base.hunter
package_name: n8n-nodes-base
display_name: Hunter
description: Consume Hunter API
category: output
development_style: programmatic
version: 1
credentials_required:
  [
  {
  "name": "hunterApi",
  "required": true
  }
  ]

outputs:
  [
  "main"
  ]

updated_at: 2025-12-11 23:50:26
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: Hunter node documentation
  description: Learn how to use the Hunter node in n8n. Follow technical documentation to integrate Hunter node into your workflows.
  contentType: [integration, reference]
  ---

  # Hunter node

  Use the Hunter node to automate work in Hunter, and integrate Hunter with other applications. n8n has built-in support for a wide range of Hunter features, including getting, generating, and verifying email addresses. 

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

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

  ## Operations

  * Get every email address found on the internet using a given domain name, with sources
  * Generate or retrieve the most likely email address from a domain name, a first name and a last name
  * Verify the deliverability of an email address

  ## Templates and examples

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

properties_schema:
  [
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "domainSearch",
      "description": "Operation to consume",
      "options": [
        {
          "name": "Domain Search",
          "value": "domainSearch",
          "description": "Get every email address found on the internet using a given domain name, with sources",
          "action": "Get every email address found on the internet using a given domain name, with sources"
        },
        {
          "name": "Email Finder",
          "value": "emailFinder",
          "description": "Generate or retrieve the most likely email address from a domain name, a first name and a last name",
          "action": "Generate or retrieve the most likely email address from a domain name, a first name and a last name"
        },
        {
          "name": "Email Verifier",
          "value": "emailVerifier",
          "description": "Verify the deliverability of an email address",
          "action": "Verify the deliverability of an email address"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "Domain",
      "name": "domain",
      "type": "string",
      "default": "",
      "description": "Domain name from which you want to find the email addresses. For example, \"stripe.com\".",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "domainSearch"
          ]
        }
      }
    },
    {
      "displayName": "Only Emails",
      "name": "onlyEmails",
      "type": "boolean",
      "default": true,
      "description": "Whether to return only the found emails",
      "displayOptions": {
        "show": {
          "operation": [
            "domainSearch"
          ]
        }
      }
    },
    {
      "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": [
            "domainSearch"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 100,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "operation": [
            "domainSearch"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 100
      }
    },
    {
      "displayName": "Filters",
      "name": "filters",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Type",
          "name": "type",
          "type": "options",
          "default": "",
          "options": [
            {
              "name": "Personal",
              "value": "personal"
            },
            {
              "name": "Generic",
              "value": "generic"
            }
          ]
        },
        {
          "displayName": "Seniority",
          "name": "seniority",
          "type": "multiOptions",
          "default": [],
          "options": [
            {
              "name": "Junior",
              "value": "junior"
            },
            {
              "name": "Senior",
              "value": "senior"
            },
            {
              "name": "Executive",
              "value": "executive"
            }
          ]
        },
        {
          "displayName": "Department",
          "name": "department",
          "type": "multiOptions",
          "default": [],
          "options": [
            {
              "name": "Communication",
              "value": "communication"
            },
            {
              "name": "Executive",
              "value": "executive"
            },
            {
              "name": "Finance",
              "value": "finance"
            },
            {
              "name": "HR",
              "value": "hr"
            },
            {
              "name": "IT",
              "value": "it"
            },
            {
              "name": "Legal",
              "value": "legal"
            },
            {
              "name": "Management",
              "value": "management"
            },
            {
              "name": "Marketing",
              "value": "marketing"
            },
            {
              "name": "Sales",
              "value": "sales"
            },
            {
              "name": "Support",
              "value": "support"
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "domainSearch"
          ]
        }
      }
    },
    {
      "displayName": "Domain",
      "name": "domain",
      "type": "string",
      "default": "",
      "description": "Domain name from which you want to find the email addresses. For example, \"stripe.com\".",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "emailFinder"
          ]
        }
      }
    },
    {
      "displayName": "First Name",
      "name": "firstname",
      "type": "string",
      "default": "",
      "description": "The person's first name. It doesn't need to be in lowercase.",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "emailFinder"
          ]
        }
      }
    },
    {
      "displayName": "Last Name",
      "name": "lastname",
      "type": "string",
      "default": "",
      "description": "The person's last name. It doesn't need to be in lowercase.",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "emailFinder"
          ]
        }
      }
    },
    {
      "displayName": "Email",
      "name": "email",
      "type": "string",
      "default": "",
      "description": "The email address you want to verify",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "emailVerifier"
          ]
        }
      }
    }
  ]

operations:
  [
    {
      "operation": "domainSearch",
      "name": "Domain Search",
      "description": "Get every email address found on the internet using a given domain name, with sources"
    },
    {
      "operation": "emailFinder",
      "name": "Email Finder",
      "description": "Generate or retrieve the most likely email address from a domain name, a first name and a last name"
    },
    {
      "operation": "emailVerifier",
      "name": "Email Verifier",
      "description": "Verify the deliverability of an email address"
    }
  ]


node_type: nodes-base.iCal
package_name: n8n-nodes-base
display_name: iCalendar
description: Create iCalendar file
category: input
development_style: programmatic
version: 1
operations:
  [
  {
  "operation": "createEventFile",
  "name": "Create Event File"
  }
  ]

credentials_required: []
outputs:
  [
  "main"
  ]

updated_at: 2025-12-11 23:50:26
properties_schema:
  [
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "createEventFile",
      "options": [
        {
          "name": "Create Event File",
          "value": "createEventFile"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "Event Title",
      "name": "title",
      "type": "string",
      "default": ""
    },
    {
      "displayName": "Start",
      "name": "start",
      "type": "dateTime",
      "default": "",
      "description": "Date and time at which the event begins. (For all-day events, the time will be ignored.).",
      "required": true
    },
    {
      "displayName": "End",
      "name": "end",
      "type": "dateTime",
      "default": "",
      "description": "Date and time at which the event ends. (For all-day events, the time will be ignored.).",
      "required": true
    },
    {
      "displayName": "All Day",
      "name": "allDay",
      "type": "boolean",
      "default": false,
      "description": "Whether the event lasts all day or not"
    },
    {
      "displayName": "Put Output File in Field",
      "name": "binaryPropertyName",
      "type": "string",
      "default": "data",
      "description": "The field that your iCalendar file will be available under in the output",
      "required": true
    },
    {
      "displayName": "Options",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Attendees",
          "name": "attendeesUi",
          "type": "fixedCollection",
          "typeOptions": {
            "multipleValues": true
          },
          "placeholder": "Add Attendee",
          "default": {},
          "options": [
            {
              "displayName": "Attendees",
              "name": "attendeeValues",
              "values": [
                {
                  "displayName": "Name",
                  "name": "name",
                  "type": "string",
                  "required": true,
                  "default": ""
                },
                {
                  "displayName": "Email",
                  "name": "email",
                  "type": "string",
                  "placeholder": "e.g. name@email.com",
                  "required": true,
                  "default": ""
                },
                {
                  "displayName": "RSVP",
                  "name": "rsvp",
                  "type": "boolean",
                  "default": false,
                  "description": "Whether the attendee has to confirm attendance or not"
                }
              ]
            }
          ]
        },
        {
          "displayName": "Busy Status",
          "name": "busyStatus",
          "type": "options",
          "options": [
            {
              "name": "Busy",
              "value": "BUSY"
            },
            {
              "name": "Tentative",
              "value": "TENTATIVE"
            }
          ],
          "default": "",
          "description": "Used to specify busy status for Microsoft applications, like Outlook"
        },
        {
          "displayName": "Calendar Name",
          "name": "calName",
          "type": "string",
          "default": "",
          "description": "Specifies the calendar (not event) name. Used by Apple iCal and Microsoft Outlook. <a href=\"https://docs.microsoft.com/en-us/openspecs/exchange_server_protocols/ms-oxcical/1da58449-b97e-46bd-b018-a1ce576f3e6d\">More info</a>."
        },
        {
          "displayName": "Description",
          "name": "description",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "File Name",
          "name": "fileName",
          "type": "string",
          "default": "",
          "placeholder": "e.g. event.ics",
          "description": "The name of the file to be generated. Default name is event.ics."
        },
        {
          "displayName": "Geolocation",
          "name": "geolocationUi",
          "type": "fixedCollection",
          "typeOptions": {
            "multipleValues": false
          },
          "placeholder": "Add Geolocation",
          "default": {},
          "options": [
            {
              "displayName": "Geolocation",
              "name": "geolocationValues",
              "values": [
                {
                  "displayName": "Latitude",
                  "name": "lat",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Longitude",
                  "name": "lon",
                  "type": "string",
                  "default": ""
                }
              ]
            }
          ]
        },
        {
          "displayName": "Location",
          "name": "location",
          "type": "string",
          "default": "",
          "description": "The intended venue"
        },
        {
          "displayName": "Recurrence Rule",
          "name": "recurrenceRule",
          "type": "string",
          "default": "",
          "description": "A rule to define the repeat pattern of the event (RRULE). (<a href=\"https://icalendar.org/rrule-tool.html\">Rule generator</a>)."
        },
        {
          "displayName": "Organizer",
          "name": "organizerUi",
          "type": "fixedCollection",
          "typeOptions": {
            "multipleValues": false
          },
          "placeholder": "Add Organizer",
          "default": {},
          "options": [
            {
              "displayName": "Organizer",
              "name": "organizerValues",
              "values": [
                {
                  "displayName": "Name",
                  "name": "name",
                  "type": "string",
                  "default": "",
                  "required": true
                },
                {
                  "displayName": "Email",
                  "name": "email",
                  "type": "string",
                  "placeholder": "e.g. name@email.com",
                  "default": "",
                  "required": true
                }
              ]
            }
          ]
        },
        {
          "displayName": "Sequence",
          "name": "sequence",
          "type": "number",
          "default": 0,
          "description": "When sending an update for an event (with the same uid), defines the revision sequence number"
        },
        {
          "displayName": "Status",
          "name": "status",
          "type": "options",
          "options": [
            {
              "name": "Confirmed",
              "value": "CONFIRMED"
            },
            {
              "name": "Cancelled",
              "value": "CANCELLED"
            },
            {
              "name": "Tentative",
              "value": "TENTATIVE"
            }
          ],
          "default": "CONFIRMED"
        },
        {
          "displayName": "UID",
          "name": "uid",
          "type": "string",
          "default": "",
          "description": "Universally unique ID for the event (will be auto-generated if not specified here). Should be globally unique."
        },
        {
          "displayName": "URL",
          "name": "url",
          "type": "string",
          "default": "",
          "description": "URL associated with event"
        },
        {
          "displayName": "Use Workflow Timezone",
          "name": "useWorkflowTimezone",
          "type": "boolean",
          "default": false,
          "description": "Whether to use the workflow timezone set in node's settings rather than UTC"
        }
      ]
    }
  ]


node_type: nodes-base.if
package_name: n8n-nodes-base
display_name: If
description: Route items to different branches (true/false)
category: transform
development_style: programmatic
version: 2.3
operations: []
credentials_required: []
outputs:
  [
  "main",
  "main"
  ]

output_names:
  [
  "true",
  "false"
  ]

updated_at: 2025-12-11 23:50:26
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: If
  description: Documentation for the If node in n8n, a workflow automation platform. Includes guidance on usage, and links to examples.
  contentType: [integration, reference]
  priority: critical
  tags:
    - if
    - if node
    - If
    - If node
  hide:
    - tags
  ---

  # If

  Use the If node to split a workflow conditionally based on comparison operations.

  ## Add conditions

  Create comparison **Conditions** for your If node.

  - Use the data type dropdown to select the data type and comparison operation type for your condition. For example, to filter for dates after a particular date, select **Date & Time > is after**.
  - The fields and values to enter into the condition change based on the data type and comparison you select. Refer to [Available data type comparisons](#available-data-type-comparisons) for a full list of all comparisons by data type.

  Select **Add condition** to create more conditions.

  ### Combining conditions

  You can choose to keep data:

  * When it meets all conditions: Create two or more conditions and select **AND** in the dropdown between them.
  * When it meets any of the conditions: Create two or more conditions and select **OR** in the dropdown between them.

  ## Templates and examples

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

  ## Branch execution with If and Merge nodes

  --8<-- "_snippets/integrations/builtin/core-nodes/merge/if-merge-branch-execution.md"

  ## Related resources

  Refer to [Splitting with conditionals](/flow-logic/splitting.md) for more information on using conditionals to create complex logic in n8n.

  If you need more than two conditional outputs, use the [Switch node](/integrations/builtin/core-nodes/n8n-nodes-base.switch.md).

  --8<-- "_snippets/integrations/builtin/core-nodes/data-types.md"

properties_schema:
  [
    {
      "displayName": "Conditions",
      "name": "conditions",
      "type": "filter",
      "default": {},
      "typeOptions": {
        "filter": {
          "caseSensitive": "={{!$parameter.options.ignoreCase}}",
          "typeValidation": "={{ ($nodeVersion < 2.1 ? $parameter.options.looseTypeValidation :  $parameter.looseTypeValidation) ? \"loose\" : \"strict\" }}",
          "version": "={{ $nodeVersion >= 2.3 ? 3 : $nodeVersion >= 2.2 ? 2 : 1 }}"
        }
      }
    },
    {
      "displayName": "Convert types where required",
      "name": "looseTypeValidation",
      "type": "boolean",
      "default": false,
      "description": "If the type of an expression doesn't match the type of the comparison, n8n will try to cast the expression to the required type. E.g. for booleans <code>\"false\"</code> or <code>0</code> will be cast to <code>false</code>",
      "displayOptions": {
        "show": {
          "@version": [
            {
              "_cnd": {
                "gte": 2.1
              }
            }
          ]
        }
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Ignore Case",
          "description": "Whether to ignore letter case when evaluating conditions",
          "name": "ignoreCase",
          "type": "boolean",
          "default": true
        },
        {
          "displayName": "Convert types where required",
          "description": "If the type of an expression doesn't match the type of the comparison, n8n will try to cast the expression to the required type. E.g. for booleans <code>\"false\"</code> or <code>0</code> will be cast to <code>false</code>",
          "name": "looseTypeValidation",
          "type": "boolean",
          "default": true,
          "displayOptions": {
            "show": {
              "@version": [
                {
                  "_cnd": {
                    "lt": 2.1
                  }
                }
              ]
            }
          }
        }
      ]
    }
  ]


node_type: nodes-base.intercomTool
package_name: n8n-nodes-base
display_name: Intercom Tool
description: Consume Intercom API (AI Tool variant for use with AI Agents)
category: output
development_style: programmatic
tool_variant_of: nodes-base.intercom
version: 1
credentials_required:
  [
  {
  "name": "intercomApi",
  "required": true
  }
  ]

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

output_names:
  [
  "Tool"
  ]

updated_at: 2025-12-11 23:50:26
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: Intercom node documentation
  description: Learn how to use the Intercom node in n8n. Follow technical documentation to integrate Intercom node into your workflows.
  contentType: [integration, reference]
  ---

  # Intercom node

  Use the Intercom node to automate work in Intercom, and integrate Intercom with other applications. n8n has built-in support for a wide range of Intercom features, including creating, updating, deleting, and getting companies, leads, and users. 

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

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

  ## Operations

  * Company
      * Create a new company
      * Get data of a company
      * Get data of all companies
      * Update a company
      * List company's users
  * Lead
      * Create a new lead
      * Delete a lead
      * Get data of a lead
      * Get data of all leads
      * Update new lead
  * User
      * Create a new user
      * Delete a user
      * Get data of a user
      * Get data of all users
      * Update a user

  ## Templates and examples

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

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 Intercom"
    },
    {
      "displayName": "Resource",
      "name": "resource",
      "type": "options",
      "default": "user",
      "options": [
        {
          "name": "Company",
          "value": "company",
          "description": "Companies allow you to represent commercial organizations using your product"
        },
        {
          "name": "Lead",
          "value": "lead",
          "description": "Leads are useful for representing logged-out users of your application"
        },
        {
          "name": "User",
          "value": "user",
          "description": "The Users resource is the primary way of interacting with Intercom"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create a new lead",
          "action": "Create a lead"
        },
        {
          "name": "Delete",
          "value": "delete",
          "description": "Delete a lead",
          "action": "Delete a lead"
        },
        {
          "name": "Get",
          "value": "get",
          "description": "Get data of a lead",
          "action": "Get a lead"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get data of many leads",
          "action": "Get many leads"
        },
        {
          "name": "Update",
          "value": "update",
          "description": "Update new lead",
          "action": "Update a lead"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "lead"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create a new user",
          "action": "Create a user"
        },
        {
          "name": "Delete",
          "value": "delete",
          "description": "Delete a user",
          "action": "Delete a user"
        },
        {
          "name": "Get",
          "value": "get",
          "description": "Get data of a user",
          "action": "Get a user"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get data of many users",
          "action": "Get many users"
        },
        {
          "name": "Update",
          "value": "update",
          "description": "Update a user",
          "action": "Update a user"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create a new company",
          "action": "Create a company"
        },
        {
          "name": "Get",
          "value": "get",
          "description": "Get data of a company",
          "action": "Get a company"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get data of many companies",
          "action": "Get many companies"
        },
        {
          "name": "Update",
          "value": "update",
          "description": "Update a company",
          "action": "Update a company"
        },
        {
          "name": "Users",
          "value": "users",
          "description": "List company's users",
          "action": "List users of a company"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "company"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "ID",
      "name": "id",
      "type": "string",
      "default": "",
      "description": "The Intercom defined ID representing the Lead",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "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": {
          "resource": [
            "user"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 50,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 60
      }
    },
    {
      "displayName": "Filters",
      "name": "filters",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Company ID",
          "name": "company_id",
          "type": "string",
          "default": "",
          "description": "Company ID representing the user"
        },
        {
          "displayName": "Email",
          "name": "email",
          "type": "string",
          "placeholder": "name@email.com",
          "default": "",
          "description": "The email address of the user"
        },
        {
          "displayName": "Segment ID",
          "name": "segment_id",
          "type": "string",
          "default": "",
          "description": "Segment representing the user"
        },
        {
          "displayName": "Tag ID",
          "name": "tag_id",
          "type": "string",
          "default": "",
          "description": "Tag representing the user"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Select By",
      "name": "selectBy",
      "type": "options",
      "default": "",
      "description": "The property to select the user by",
      "options": [
        {
          "name": "ID",
          "value": "id",
          "default": "",
          "description": "The Intercom defined ID representing the Lead"
        },
        {
          "name": "User ID",
          "value": "userId",
          "default": "",
          "description": "Automatically generated identifier for the Lead"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Value",
      "name": "value",
      "type": "string",
      "default": "",
      "description": "View by value",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Update By",
      "name": "updateBy",
      "type": "options",
      "default": "id",
      "description": "The property via which to query the user",
      "options": [
        {
          "name": "ID",
          "value": "id",
          "description": "The Intercom defined ID representing the user"
        },
        {
          "name": "Email",
          "value": "email",
          "description": "The email address of user"
        },
        {
          "name": "User ID",
          "value": "userId",
          "description": "Automatically generated identifier for the user"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Value",
      "name": "value",
      "type": "string",
      "default": "",
      "description": "Value of the property to identify the user to update",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Identifier Type",
      "name": "identifierType",
      "type": "options",
      "default": "",
      "description": "Unique string identifier",
      "options": [
        {
          "name": "User ID",
          "value": "userId",
          "description": "A unique string identifier for the user. It is required on creation if an email is not supplied."
        },
        {
          "name": "Email",
          "value": "email",
          "description": "The user's email address. It is required on creation if a user_id is not supplied."
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Value",
      "name": "idValue",
      "type": "string",
      "default": "",
      "description": "Unique string identifier value",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "JSON Parameters",
      "name": "jsonParameters",
      "type": "boolean",
      "default": false,
      "displayOptions": {
        "show": {
          "operation": [
            "create",
            "update"
          ],
          "resource": [
            "user"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Avatar",
          "name": "avatar",
          "type": "string",
          "default": "",
          "description": "An avatar image URL. note: the image URL needs to be https."
        },
        {
          "displayName": "Company Names or IDs",
          "name": "companies",
          "type": "multiOptions",
          "typeOptions": {
            "loadOptionsMethod": "getCompanies"
          },
          "default": [],
          "description": "Identifies the companies this user belongs to. Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        },
        {
          "displayName": "Email",
          "name": "email",
          "displayOptions": {
            "show": {
              "/operation": [
                "update"
              ],
              "/resource": [
                "user"
              ]
            },
            "hide": {
              "/updateBy": [
                "email"
              ]
            }
          },
          "type": "string",
          "placeholder": "name@email.com",
          "default": "",
          "description": "Email of the user"
        },
        {
          "displayName": "Name",
          "name": "name",
          "type": "string",
          "default": "",
          "placeholder": "",
          "description": "Name of the user"
        },
        {
          "displayName": "Phone",
          "name": "phone",
          "type": "string",
          "default": "",
          "description": "The phone number of the user"
        },
        {
          "displayName": "Session Count",
          "name": "sessionCount",
          "type": "number",
          "default": false,
          "options": [],
          "description": "How many sessions the user has recorded"
        },
        {
          "displayName": "User ID",
          "name": "userId",
          "displayOptions": {
            "show": {
              "/operation": [
                "update"
              ],
              "/resource": [
                "user"
              ]
            },
            "hide": {
              "/updateBy": [
                "email",
                "userId"
              ]
            }
          },
          "type": "string",
          "default": "",
          "description": "Email of the user"
        },
        {
          "displayName": "Unsubscribed From Emails",
          "name": "unsubscribedFromEmails",
          "type": "boolean",
          "default": false,
          "placeholder": "",
          "description": "Whether the user is unsubscribed from emails"
        },
        {
          "displayName": "Update Last Request At",
          "name": "updateLastRequestAt",
          "type": "boolean",
          "default": false,
          "options": [],
          "description": "Whether to instruct Intercom to update the users last_request_at value to the current API service time in UTC"
        },
        {
          "displayName": "UTM Campaign",
          "name": "utmCampaign",
          "type": "string",
          "default": "",
          "description": "Identifies a specific product promotion or strategic campaign"
        },
        {
          "displayName": "UTM Content",
          "name": "utmContent",
          "type": "string",
          "default": "",
          "description": "Identifies what specifically was clicked to bring the user to the site"
        },
        {
          "displayName": "UTM Medium",
          "name": "utmMedium",
          "type": "string",
          "default": "",
          "description": "Identifies what type of link was used"
        },
        {
          "displayName": "UTM Source",
          "name": "utmSource",
          "type": "string",
          "default": "",
          "description": "An avatar image URL. note: the image URL needs to be https."
        },
        {
          "displayName": "UTM Term",
          "name": "utmTerm",
          "type": "string",
          "default": "",
          "description": "Identifies search terms"
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "create",
            "update"
          ],
          "resource": [
            "user"
          ]
        }
      }
    },
    {
      "displayName": "Custom Attributes",
      "name": "customAttributesJson",
      "type": "json",
      "default": "",
      "description": "A hash of key/value pairs to represent custom data you want to attribute to a user",
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "create",
            "update"
          ],
          "jsonParameters": [
            true
          ]
        }
      },
      "typeOptions": {
        "alwaysOpenEditWindow": true
      }
    },
    {
      "displayName": "Custom Attributes",
      "name": "customAttributesUi",
      "type": "fixedCollection",
      "default": {},
      "description": "A hash of key/value pairs to represent custom data you want to attribute to a user",
      "options": [
        {
          "name": "customAttributesValues",
          "displayName": "Attributes",
          "values": [
            {
              "displayName": "Name",
              "name": "name",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "Value",
              "name": "value",
              "type": "string",
              "default": ""
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "create",
            "update"
          ],
          "jsonParameters": [
            false
          ]
        }
      },
      "typeOptions": {
        "multipleValues": true
      }
    },
    {
      "displayName": "Delete By",
      "name": "deleteBy",
      "type": "options",
      "default": "",
      "options": [
        {
          "name": "ID",
          "value": "id",
          "description": "The Intercom defined ID representing the Lead"
        },
        {
          "name": "User ID",
          "value": "userId",
          "description": "Automatically generated identifier for the Lead"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "lead"
          ],
          "operation": [
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "Value",
      "name": "value",
      "type": "string",
      "default": "",
      "description": "Delete by value",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "lead"
          ],
          "operation": [
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "Select By",
      "name": "selectBy",
      "type": "options",
      "default": "",
      "description": "The property to select the lead by",
      "options": [
        {
          "name": "Email",
          "value": "email",
          "description": "Email representing the Lead"
        },
        {
          "name": "ID",
          "value": "id",
          "description": "The Intercom defined ID representing the Lead"
        },
        {
          "name": "User ID",
          "value": "userId",
          "description": "Automatically generated identifier for the Lead"
        },
        {
          "name": "Phone",
          "value": "phone",
          "description": "Phone representing the Lead"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "lead"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Value",
      "name": "value",
      "type": "string",
      "default": "",
      "description": "View by value",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "lead"
          ],
          "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": [
            "lead"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 50,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "lead"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 60
      }
    },
    {
      "displayName": "Filters",
      "name": "filters",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Email",
          "name": "email",
          "type": "string",
          "placeholder": "name@email.com",
          "default": "",
          "description": "The email address of the lead"
        },
        {
          "displayName": "Phone",
          "name": "phone",
          "type": "string",
          "default": "",
          "description": "The phone number of the lead"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "lead"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Update By",
      "name": "updateBy",
      "type": "options",
      "default": "id",
      "description": "The property via which to query the lead",
      "options": [
        {
          "name": "User ID",
          "value": "userId",
          "description": "Automatically generated identifier for the Lead"
        },
        {
          "name": "ID",
          "value": "id",
          "description": "The Intercom defined ID representing the Lead"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "lead"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Value",
      "name": "value",
      "type": "string",
      "default": "",
      "description": "Value of the property to identify the lead to update",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "lead"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Email",
      "name": "email",
      "type": "string",
      "default": "",
      "description": "The email of the user",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "lead"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "JSON Parameters",
      "name": "jsonParameters",
      "type": "boolean",
      "default": false,
      "displayOptions": {
        "show": {
          "operation": [
            "create",
            "update"
          ],
          "resource": [
            "lead"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Avatar",
          "name": "avatar",
          "type": "string",
          "default": "",
          "description": "An avatar image URL. note: the image URL needs to be https."
        },
        {
          "displayName": "Company Names or IDs",
          "name": "companies",
          "type": "multiOptions",
          "typeOptions": {
            "loadOptionsMethod": "getCompanies"
          },
          "default": [],
          "description": "Identifies the companies this user belongs to. Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        },
        {
          "displayName": "Email",
          "name": "email",
          "type": "string",
          "placeholder": "name@email.com",
          "default": "",
          "displayOptions": {
            "show": {
              "/resource": [
                "lead"
              ],
              "/operation": [
                "update"
              ]
            }
          },
          "description": "The email of the user"
        },
        {
          "displayName": "Name",
          "name": "name",
          "type": "string",
          "default": "",
          "description": "Name of the user"
        },
        {
          "displayName": "Phone",
          "name": "phone",
          "type": "string",
          "default": "",
          "description": "The phone number of the user"
        },
        {
          "displayName": "Unsubscribed From Emails",
          "name": "unsubscribedFromEmails",
          "type": "boolean",
          "default": false,
          "description": "Whether the Lead is unsubscribed from emails"
        },
        {
          "displayName": "Update Last Request At",
          "name": "updateLastRequestAt",
          "type": "boolean",
          "default": false,
          "description": "Whether to instruct Intercom to update the users last_request_at value to the current API service time in UTC. default value if not sent is false."
        },
        {
          "displayName": "UTM Campaign",
          "name": "utmCampaign",
          "type": "string",
          "default": "",
          "description": "Identifies a specific product promotion or strategic campaign"
        },
        {
          "displayName": "UTM Content",
          "name": "utmContent",
          "type": "string",
          "default": "",
          "description": "Identifies what specifically was clicked to bring the user to the site"
        },
        {
          "displayName": "UTM Medium",
          "name": "utmMedium",
          "type": "string",
          "default": "",
          "description": "Identifies what type of link was used"
        },
        {
          "displayName": "UTM Source",
          "name": "utmSource",
          "type": "string",
          "default": "",
          "description": "An avatar image URL. note: the image URL needs to be https."
        },
        {
          "displayName": "UTM Term",
          "name": "utmTerm",
          "type": "string",
          "default": "",
          "description": "Identifies search terms"
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "create",
            "update"
          ],
          "resource": [
            "lead"
          ]
        }
      }
    },
    {
      "displayName": "Custom Attributes",
      "name": "customAttributesJson",
      "type": "json",
      "default": "",
      "description": "A hash of key/value pairs to represent custom data you want to attribute to a user",
      "displayOptions": {
        "show": {
          "resource": [
            "lead"
          ],
          "operation": [
            "create",
            "update"
          ],
          "jsonParameters": [
            true
          ]
        }
      },
      "typeOptions": {
        "alwaysOpenEditWindow": true
      }
    },
    {
      "displayName": "Custom Attributes",
      "name": "customAttributesUi",
      "type": "fixedCollection",
      "default": {},
      "description": "A hash of key/value pairs to represent custom data you want to attribute to a user",
      "options": [
        {
          "name": "customAttributesValues",
          "displayName": "Attributes",
          "values": [
            {
              "displayName": "Name",
              "name": "name",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "Value",
              "name": "value",
              "type": "string",
              "default": ""
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "lead"
          ],
          "operation": [
            "create",
            "update"
          ],
          "jsonParameters": [
            false
          ]
        }
      },
      "typeOptions": {
        "multipleValues": true
      }
    },
    {
      "displayName": "List By",
      "name": "listBy",
      "type": "options",
      "default": "",
      "options": [
        {
          "name": "ID",
          "value": "id",
          "description": "The Intercom defined ID representing the company"
        },
        {
          "name": "Company ID",
          "value": "companyId",
          "description": "The company_id you have given to the company"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "company"
          ],
          "operation": [
            "users"
          ]
        }
      }
    },
    {
      "displayName": "Value",
      "name": "value",
      "type": "string",
      "default": "",
      "description": "View by value",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "company"
          ],
          "operation": [
            "users"
          ]
        }
      }
    },
    {
      "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": [
            "users"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 50,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "company"
          ],
          "operation": [
            "users"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 60
      }
    },
    {
      "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": 50,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "company"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 60
      }
    },
    {
      "displayName": "Filters",
      "name": "filters",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Segment ID",
          "name": "segment_id",
          "type": "string",
          "default": "",
          "description": "Segment representing the Lead"
        },
        {
          "displayName": "Tag ID",
          "name": "tag_id",
          "type": "string",
          "default": "",
          "description": "Tag representing the Lead"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "company"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Select By",
      "name": "selectBy",
      "type": "options",
      "default": "",
      "description": "What property to use to query the company",
      "options": [
        {
          "name": "Company ID",
          "value": "companyId",
          "description": "The company_id you have given to the company"
        },
        {
          "name": "ID",
          "value": "id",
          "description": "The Intercom defined ID representing the company"
        },
        {
          "name": "Name",
          "value": "name",
          "description": "The name of the company"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "company"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Value",
      "name": "value",
      "type": "string",
      "default": "",
      "description": "View by value",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "company"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Company ID",
      "name": "companyId",
      "type": "string",
      "default": "",
      "description": "The company ID you have defined for the company",
      "displayOptions": {
        "show": {
          "resource": [
            "company"
          ],
          "operation": [
            "create",
            "update"
          ]
        }
      }
    },
    {
      "displayName": "JSON Parameters",
      "name": "jsonParameters",
      "type": "boolean",
      "default": false,
      "displayOptions": {
        "show": {
          "operation": [
            "create",
            "update"
          ],
          "resource": [
            "company"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Industry",
          "name": "industry",
          "type": "string",
          "default": "",
          "description": "The industry that this company operates in"
        },
        {
          "displayName": "Monthly Spend",
          "name": "monthlySpend",
          "type": "string",
          "default": "",
          "description": "The phone number of the user"
        },
        {
          "displayName": "Name",
          "name": "name",
          "type": "string",
          "default": "",
          "placeholder": "",
          "description": "Name of the user"
        },
        {
          "displayName": "Plan",
          "name": "plan",
          "type": "string",
          "default": "",
          "placeholder": "",
          "description": "The name of the plan you have associated with the company"
        },
        {
          "displayName": "Size",
          "name": "size",
          "type": "number",
          "default": "",
          "description": "The number of employees in this company"
        },
        {
          "displayName": "Website",
          "name": "website",
          "type": "string",
          "default": "",
          "description": "The URL for this company's website. Please note that the value specified here is not validated. Accepts any string."
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "create",
            "update"
          ],
          "resource": [
            "company"
          ]
        }
      }
    },
    {
      "displayName": "Custom Attributes",
      "name": "customAttributesJson",
      "type": "json",
      "default": "",
      "description": "A hash of key/value pairs to represent custom data you want to attribute to a user",
      "displayOptions": {
        "show": {
          "resource": [
            "company"
          ],
          "operation": [
            "create",
            "update"
          ],
          "jsonParameters": [
            true
          ]
        }
      },
      "typeOptions": {
        "alwaysOpenEditWindow": true
      }
    },
    {
      "displayName": "Custom Attributes",
      "name": "customAttributesUi",
      "type": "fixedCollection",
      "default": {},
      "description": "A hash of key/value pairs to represent custom data you want to attribute to a user",
      "options": [
        {
          "name": "customAttributesValues",
          "displayName": "Attributes",
          "values": [
            {
              "displayName": "Name",
              "name": "name",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "Value",
              "name": "value",
              "type": "string",
              "default": ""
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "company"
          ],
          "operation": [
            "create",
            "update"
          ],
          "jsonParameters": [
            false
          ]
        }
      },
      "typeOptions": {
        "multipleValues": true
      }
    }
  ]

operations:
  [
    {
      "operation": "create",
      "name": "Create",
      "description": "Create a new lead"
    },
    {
      "operation": "delete",
      "name": "Delete",
      "description": "Delete a lead"
    },
    {
      "operation": "get",
      "name": "Get",
      "description": "Get data of a lead"
    },
    {
      "operation": "getAll",
      "name": "Get Many",
      "description": "Get data of many leads"
    },
    {
      "operation": "update",
      "name": "Update",
      "description": "Update new lead"
    }
  ]


node_type: nodes-base.intercom
package_name: n8n-nodes-base
display_name: Intercom
description: Consume Intercom API
category: output
development_style: programmatic
version: 1
credentials_required:
  [
  {
  "name": "intercomApi",
  "required": true
  }
  ]

outputs:
  [
  "main"
  ]

updated_at: 2025-12-11 23:50:26
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: Intercom node documentation
  description: Learn how to use the Intercom node in n8n. Follow technical documentation to integrate Intercom node into your workflows.
  contentType: [integration, reference]
  ---

  # Intercom node

  Use the Intercom node to automate work in Intercom, and integrate Intercom with other applications. n8n has built-in support for a wide range of Intercom features, including creating, updating, deleting, and getting companies, leads, and users. 

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

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

  ## Operations

  * Company
      * Create a new company
      * Get data of a company
      * Get data of all companies
      * Update a company
      * List company's users
  * Lead
      * Create a new lead
      * Delete a lead
      * Get data of a lead
      * Get data of all leads
      * Update new lead
  * User
      * Create a new user
      * Delete a user
      * Get data of a user
      * Get data of all users
      * Update a user

  ## Templates and examples

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

properties_schema:
  [
    {
      "displayName": "Resource",
      "name": "resource",
      "type": "options",
      "default": "user",
      "options": [
        {
          "name": "Company",
          "value": "company",
          "description": "Companies allow you to represent commercial organizations using your product"
        },
        {
          "name": "Lead",
          "value": "lead",
          "description": "Leads are useful for representing logged-out users of your application"
        },
        {
          "name": "User",
          "value": "user",
          "description": "The Users resource is the primary way of interacting with Intercom"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create a new lead",
          "action": "Create a lead"
        },
        {
          "name": "Delete",
          "value": "delete",
          "description": "Delete a lead",
          "action": "Delete a lead"
        },
        {
          "name": "Get",
          "value": "get",
          "description": "Get data of a lead",
          "action": "Get a lead"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get data of many leads",
          "action": "Get many leads"
        },
        {
          "name": "Update",
          "value": "update",
          "description": "Update new lead",
          "action": "Update a lead"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "lead"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create a new user",
          "action": "Create a user"
        },
        {
          "name": "Delete",
          "value": "delete",
          "description": "Delete a user",
          "action": "Delete a user"
        },
        {
          "name": "Get",
          "value": "get",
          "description": "Get data of a user",
          "action": "Get a user"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get data of many users",
          "action": "Get many users"
        },
        {
          "name": "Update",
          "value": "update",
          "description": "Update a user",
          "action": "Update a user"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create a new company",
          "action": "Create a company"
        },
        {
          "name": "Get",
          "value": "get",
          "description": "Get data of a company",
          "action": "Get a company"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get data of many companies",
          "action": "Get many companies"
        },
        {
          "name": "Update",
          "value": "update",
          "description": "Update a company",
          "action": "Update a company"
        },
        {
          "name": "Users",
          "value": "users",
          "description": "List company's users",
          "action": "List users of a company"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "company"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "ID",
      "name": "id",
      "type": "string",
      "default": "",
      "description": "The Intercom defined ID representing the Lead",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "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": {
          "resource": [
            "user"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 50,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 60
      }
    },
    {
      "displayName": "Filters",
      "name": "filters",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Company ID",
          "name": "company_id",
          "type": "string",
          "default": "",
          "description": "Company ID representing the user"
        },
        {
          "displayName": "Email",
          "name": "email",
          "type": "string",
          "placeholder": "name@email.com",
          "default": "",
          "description": "The email address of the user"
        },
        {
          "displayName": "Segment ID",
          "name": "segment_id",
          "type": "string",
          "default": "",
          "description": "Segment representing the user"
        },
        {
          "displayName": "Tag ID",
          "name": "tag_id",
          "type": "string",
          "default": "",
          "description": "Tag representing the user"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Select By",
      "name": "selectBy",
      "type": "options",
      "default": "",
      "description": "The property to select the user by",
      "options": [
        {
          "name": "ID",
          "value": "id",
          "default": "",
          "description": "The Intercom defined ID representing the Lead"
        },
        {
          "name": "User ID",
          "value": "userId",
          "default": "",
          "description": "Automatically generated identifier for the Lead"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Value",
      "name": "value",
      "type": "string",
      "default": "",
      "description": "View by value",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Update By",
      "name": "updateBy",
      "type": "options",
      "default": "id",
      "description": "The property via which to query the user",
      "options": [
        {
          "name": "ID",
          "value": "id",
          "description": "The Intercom defined ID representing the user"
        },
        {
          "name": "Email",
          "value": "email",
          "description": "The email address of user"
        },
        {
          "name": "User ID",
          "value": "userId",
          "description": "Automatically generated identifier for the user"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Value",
      "name": "value",
      "type": "string",
      "default": "",
      "description": "Value of the property to identify the user to update",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Identifier Type",
      "name": "identifierType",
      "type": "options",
      "default": "",
      "description": "Unique string identifier",
      "options": [
        {
          "name": "User ID",
          "value": "userId",
          "description": "A unique string identifier for the user. It is required on creation if an email is not supplied."
        },
        {
          "name": "Email",
          "value": "email",
          "description": "The user's email address. It is required on creation if a user_id is not supplied."
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Value",
      "name": "idValue",
      "type": "string",
      "default": "",
      "description": "Unique string identifier value",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "JSON Parameters",
      "name": "jsonParameters",
      "type": "boolean",
      "default": false,
      "displayOptions": {
        "show": {
          "operation": [
            "create",
            "update"
          ],
          "resource": [
            "user"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Avatar",
          "name": "avatar",
          "type": "string",
          "default": "",
          "description": "An avatar image URL. note: the image URL needs to be https."
        },
        {
          "displayName": "Company Names or IDs",
          "name": "companies",
          "type": "multiOptions",
          "typeOptions": {
            "loadOptionsMethod": "getCompanies"
          },
          "default": [],
          "description": "Identifies the companies this user belongs to. Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        },
        {
          "displayName": "Email",
          "name": "email",
          "displayOptions": {
            "show": {
              "/operation": [
                "update"
              ],
              "/resource": [
                "user"
              ]
            },
            "hide": {
              "/updateBy": [
                "email"
              ]
            }
          },
          "type": "string",
          "placeholder": "name@email.com",
          "default": "",
          "description": "Email of the user"
        },
        {
          "displayName": "Name",
          "name": "name",
          "type": "string",
          "default": "",
          "placeholder": "",
          "description": "Name of the user"
        },
        {
          "displayName": "Phone",
          "name": "phone",
          "type": "string",
          "default": "",
          "description": "The phone number of the user"
        },
        {
          "displayName": "Session Count",
          "name": "sessionCount",
          "type": "number",
          "default": false,
          "options": [],
          "description": "How many sessions the user has recorded"
        },
        {
          "displayName": "User ID",
          "name": "userId",
          "displayOptions": {
            "show": {
              "/operation": [
                "update"
              ],
              "/resource": [
                "user"
              ]
            },
            "hide": {
              "/updateBy": [
                "email",
                "userId"
              ]
            }
          },
          "type": "string",
          "default": "",
          "description": "Email of the user"
        },
        {
          "displayName": "Unsubscribed From Emails",
          "name": "unsubscribedFromEmails",
          "type": "boolean",
          "default": false,
          "placeholder": "",
          "description": "Whether the user is unsubscribed from emails"
        },
        {
          "displayName": "Update Last Request At",
          "name": "updateLastRequestAt",
          "type": "boolean",
          "default": false,
          "options": [],
          "description": "Whether to instruct Intercom to update the users last_request_at value to the current API service time in UTC"
        },
        {
          "displayName": "UTM Campaign",
          "name": "utmCampaign",
          "type": "string",
          "default": "",
          "description": "Identifies a specific product promotion or strategic campaign"
        },
        {
          "displayName": "UTM Content",
          "name": "utmContent",
          "type": "string",
          "default": "",
          "description": "Identifies what specifically was clicked to bring the user to the site"
        },
        {
          "displayName": "UTM Medium",
          "name": "utmMedium",
          "type": "string",
          "default": "",
          "description": "Identifies what type of link was used"
        },
        {
          "displayName": "UTM Source",
          "name": "utmSource",
          "type": "string",
          "default": "",
          "description": "An avatar image URL. note: the image URL needs to be https."
        },
        {
          "displayName": "UTM Term",
          "name": "utmTerm",
          "type": "string",
          "default": "",
          "description": "Identifies search terms"
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "create",
            "update"
          ],
          "resource": [
            "user"
          ]
        }
      }
    },
    {
      "displayName": "Custom Attributes",
      "name": "customAttributesJson",
      "type": "json",
      "default": "",
      "description": "A hash of key/value pairs to represent custom data you want to attribute to a user",
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "create",
            "update"
          ],
          "jsonParameters": [
            true
          ]
        }
      },
      "typeOptions": {
        "alwaysOpenEditWindow": true
      }
    },
    {
      "displayName": "Custom Attributes",
      "name": "customAttributesUi",
      "type": "fixedCollection",
      "default": {},
      "description": "A hash of key/value pairs to represent custom data you want to attribute to a user",
      "options": [
        {
          "name": "customAttributesValues",
          "displayName": "Attributes",
          "values": [
            {
              "displayName": "Name",
              "name": "name",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "Value",
              "name": "value",
              "type": "string",
              "default": ""
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "create",
            "update"
          ],
          "jsonParameters": [
            false
          ]
        }
      },
      "typeOptions": {
        "multipleValues": true
      }
    },
    {
      "displayName": "Delete By",
      "name": "deleteBy",
      "type": "options",
      "default": "",
      "options": [
        {
          "name": "ID",
          "value": "id",
          "description": "The Intercom defined ID representing the Lead"
        },
        {
          "name": "User ID",
          "value": "userId",
          "description": "Automatically generated identifier for the Lead"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "lead"
          ],
          "operation": [
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "Value",
      "name": "value",
      "type": "string",
      "default": "",
      "description": "Delete by value",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "lead"
          ],
          "operation": [
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "Select By",
      "name": "selectBy",
      "type": "options",
      "default": "",
      "description": "The property to select the lead by",
      "options": [
        {
          "name": "Email",
          "value": "email",
          "description": "Email representing the Lead"
        },
        {
          "name": "ID",
          "value": "id",
          "description": "The Intercom defined ID representing the Lead"
        },
        {
          "name": "User ID",
          "value": "userId",
          "description": "Automatically generated identifier for the Lead"
        },
        {
          "name": "Phone",
          "value": "phone",
          "description": "Phone representing the Lead"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "lead"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Value",
      "name": "value",
      "type": "string",
      "default": "",
      "description": "View by value",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "lead"
          ],
          "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": [
            "lead"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 50,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "lead"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 60
      }
    },
    {
      "displayName": "Filters",
      "name": "filters",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Email",
          "name": "email",
          "type": "string",
          "placeholder": "name@email.com",
          "default": "",
          "description": "The email address of the lead"
        },
        {
          "displayName": "Phone",
          "name": "phone",
          "type": "string",
          "default": "",
          "description": "The phone number of the lead"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "lead"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Update By",
      "name": "updateBy",
      "type": "options",
      "default": "id",
      "description": "The property via which to query the lead",
      "options": [
        {
          "name": "User ID",
          "value": "userId",
          "description": "Automatically generated identifier for the Lead"
        },
        {
          "name": "ID",
          "value": "id",
          "description": "The Intercom defined ID representing the Lead"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "lead"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Value",
      "name": "value",
      "type": "string",
      "default": "",
      "description": "Value of the property to identify the lead to update",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "lead"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Email",
      "name": "email",
      "type": "string",
      "default": "",
      "description": "The email of the user",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "lead"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "JSON Parameters",
      "name": "jsonParameters",
      "type": "boolean",
      "default": false,
      "displayOptions": {
        "show": {
          "operation": [
            "create",
            "update"
          ],
          "resource": [
            "lead"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Avatar",
          "name": "avatar",
          "type": "string",
          "default": "",
          "description": "An avatar image URL. note: the image URL needs to be https."
        },
        {
          "displayName": "Company Names or IDs",
          "name": "companies",
          "type": "multiOptions",
          "typeOptions": {
            "loadOptionsMethod": "getCompanies"
          },
          "default": [],
          "description": "Identifies the companies this user belongs to. Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        },
        {
          "displayName": "Email",
          "name": "email",
          "type": "string",
          "placeholder": "name@email.com",
          "default": "",
          "displayOptions": {
            "show": {
              "/resource": [
                "lead"
              ],
              "/operation": [
                "update"
              ]
            }
          },
          "description": "The email of the user"
        },
        {
          "displayName": "Name",
          "name": "name",
          "type": "string",
          "default": "",
          "description": "Name of the user"
        },
        {
          "displayName": "Phone",
          "name": "phone",
          "type": "string",
          "default": "",
          "description": "The phone number of the user"
        },
        {
          "displayName": "Unsubscribed From Emails",
          "name": "unsubscribedFromEmails",
          "type": "boolean",
          "default": false,
          "description": "Whether the Lead is unsubscribed from emails"
        },
        {
          "displayName": "Update Last Request At",
          "name": "updateLastRequestAt",
          "type": "boolean",
          "default": false,
          "description": "Whether to instruct Intercom to update the users last_request_at value to the current API service time in UTC. default value if not sent is false."
        },
        {
          "displayName": "UTM Campaign",
          "name": "utmCampaign",
          "type": "string",
          "default": "",
          "description": "Identifies a specific product promotion or strategic campaign"
        },
        {
          "displayName": "UTM Content",
          "name": "utmContent",
          "type": "string",
          "default": "",
          "description": "Identifies what specifically was clicked to bring the user to the site"
        },
        {
          "displayName": "UTM Medium",
          "name": "utmMedium",
          "type": "string",
          "default": "",
          "description": "Identifies what type of link was used"
        },
        {
          "displayName": "UTM Source",
          "name": "utmSource",
          "type": "string",
          "default": "",
          "description": "An avatar image URL. note: the image URL needs to be https."
        },
        {
          "displayName": "UTM Term",
          "name": "utmTerm",
          "type": "string",
          "default": "",
          "description": "Identifies search terms"
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "create",
            "update"
          ],
          "resource": [
            "lead"
          ]
        }
      }
    },
    {
      "displayName": "Custom Attributes",
      "name": "customAttributesJson",
      "type": "json",
      "default": "",
      "description": "A hash of key/value pairs to represent custom data you want to attribute to a user",
      "displayOptions": {
        "show": {
          "resource": [
            "lead"
          ],
          "operation": [
            "create",
            "update"
          ],
          "jsonParameters": [
            true
          ]
        }
      },
      "typeOptions": {
        "alwaysOpenEditWindow": true
      }
    },
    {
      "displayName": "Custom Attributes",
      "name": "customAttributesUi",
      "type": "fixedCollection",
      "default": {},
      "description": "A hash of key/value pairs to represent custom data you want to attribute to a user",
      "options": [
        {
          "name": "customAttributesValues",
          "displayName": "Attributes",
          "values": [
            {
              "displayName": "Name",
              "name": "name",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "Value",
              "name": "value",
              "type": "string",
              "default": ""
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "lead"
          ],
          "operation": [
            "create",
            "update"
          ],
          "jsonParameters": [
            false
          ]
        }
      },
      "typeOptions": {
        "multipleValues": true
      }
    },
    {
      "displayName": "List By",
      "name": "listBy",
      "type": "options",
      "default": "",
      "options": [
        {
          "name": "ID",
          "value": "id",
          "description": "The Intercom defined ID representing the company"
        },
        {
          "name": "Company ID",
          "value": "companyId",
          "description": "The company_id you have given to the company"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "company"
          ],
          "operation": [
            "users"
          ]
        }
      }
    },
    {
      "displayName": "Value",
      "name": "value",
      "type": "string",
      "default": "",
      "description": "View by value",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "company"
          ],
          "operation": [
            "users"
          ]
        }
      }
    },
    {
      "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": [
            "users"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 50,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "company"
          ],
          "operation": [
            "users"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 60
      }
    },
    {
      "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": 50,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "company"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 60
      }
    },
    {
      "displayName": "Filters",
      "name": "filters",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Segment ID",
          "name": "segment_id",
          "type": "string",
          "default": "",
          "description": "Segment representing the Lead"
        },
        {
          "displayName": "Tag ID",
          "name": "tag_id",
          "type": "string",
          "default": "",
          "description": "Tag representing the Lead"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "company"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Select By",
      "name": "selectBy",
      "type": "options",
      "default": "",
      "description": "What property to use to query the company",
      "options": [
        {
          "name": "Company ID",
          "value": "companyId",
          "description": "The company_id you have given to the company"
        },
        {
          "name": "ID",
          "value": "id",
          "description": "The Intercom defined ID representing the company"
        },
        {
          "name": "Name",
          "value": "name",
          "description": "The name of the company"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "company"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Value",
      "name": "value",
      "type": "string",
      "default": "",
      "description": "View by value",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "company"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Company ID",
      "name": "companyId",
      "type": "string",
      "default": "",
      "description": "The company ID you have defined for the company",
      "displayOptions": {
        "show": {
          "resource": [
            "company"
          ],
          "operation": [
            "create",
            "update"
          ]
        }
      }
    },
    {
      "displayName": "JSON Parameters",
      "name": "jsonParameters",
      "type": "boolean",
      "default": false,
      "displayOptions": {
        "show": {
          "operation": [
            "create",
            "update"
          ],
          "resource": [
            "company"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Industry",
          "name": "industry",
          "type": "string",
          "default": "",
          "description": "The industry that this company operates in"
        },
        {
          "displayName": "Monthly Spend",
          "name": "monthlySpend",
          "type": "string",
          "default": "",
          "description": "The phone number of the user"
        },
        {
          "displayName": "Name",
          "name": "name",
          "type": "string",
          "default": "",
          "placeholder": "",
          "description": "Name of the user"
        },
        {
          "displayName": "Plan",
          "name": "plan",
          "type": "string",
          "default": "",
          "placeholder": "",
          "description": "The name of the plan you have associated with the company"
        },
        {
          "displayName": "Size",
          "name": "size",
          "type": "number",
          "default": "",
          "description": "The number of employees in this company"
        },
        {
          "displayName": "Website",
          "name": "website",
          "type": "string",
          "default": "",
          "description": "The URL for this company's website. Please note that the value specified here is not validated. Accepts any string."
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "create",
            "update"
          ],
          "resource": [
            "company"
          ]
        }
      }
    },
    {
      "displayName": "Custom Attributes",
      "name": "customAttributesJson",
      "type": "json",
      "default": "",
      "description": "A hash of key/value pairs to represent custom data you want to attribute to a user",
      "displayOptions": {
        "show": {
          "resource": [
            "company"
          ],
          "operation": [
            "create",
            "update"
          ],
          "jsonParameters": [
            true
          ]
        }
      },
      "typeOptions": {
        "alwaysOpenEditWindow": true
      }
    },
    {
      "displayName": "Custom Attributes",
      "name": "customAttributesUi",
      "type": "fixedCollection",
      "default": {},
      "description": "A hash of key/value pairs to represent custom data you want to attribute to a user",
      "options": [
        {
          "name": "customAttributesValues",
          "displayName": "Attributes",
          "values": [
            {
              "displayName": "Name",
              "name": "name",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "Value",
              "name": "value",
              "type": "string",
              "default": ""
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "company"
          ],
          "operation": [
            "create",
            "update"
          ],
          "jsonParameters": [
            false
          ]
        }
      },
      "typeOptions": {
        "multipleValues": true
      }
    }
  ]

operations:
  [
    {
      "operation": "create",
      "name": "Create",
      "description": "Create a new lead"
    },
    {
      "operation": "delete",
      "name": "Delete",
      "description": "Delete a lead"
    },
    {
      "operation": "get",
      "name": "Get",
      "description": "Get data of a lead"
    },
    {
      "operation": "getAll",
      "name": "Get Many",
      "description": "Get data of many leads"
    },
    {
      "operation": "update",
      "name": "Update",
      "description": "Update new lead"
    }
  ]


node_type: nodes-base.interval
package_name: n8n-nodes-base
display_name: Interval
description: Triggers the workflow in a given interval
category: trigger
development_style: programmatic
version: 1
operations: []
credentials_required: []
outputs:
  [
  "main"
  ]

updated_at: 2025-12-11 23:50:26
properties_schema:
  [
    {
      "displayName": "This workflow will run on the schedule you define here once you <a data-key=\"activate\">activate</a> it.<br><br>For testing, you can also trigger it manually: by going back to the canvas and clicking 'execute workflow'",
      "name": "notice",
      "type": "notice",
      "default": ""
    },
    {
      "displayName": "Interval",
      "name": "interval",
      "type": "number",
      "default": 1,
      "description": "Interval value",
      "typeOptions": {
        "minValue": 1
      }
    },
    {
      "displayName": "Unit",
      "name": "unit",
      "type": "options",
      "default": "seconds",
      "description": "Unit of the interval value",
      "options": [
        {
          "name": "Seconds",
          "value": "seconds"
        },
        {
          "name": "Minutes",
          "value": "minutes"
        },
        {
          "name": "Hours",
          "value": "hours"
        }
      ]
    }
  ]


node_type: nodes-base.invoiceNinjaTool
package_name: n8n-nodes-base
display_name: Invoice Ninja Tool
description: Consume Invoice Ninja API (AI Tool variant for use with AI Agents)
category: output
development_style: programmatic
tool_variant_of: nodes-base.invoiceNinja
version: 2
credentials_required:
  [
  {
  "name": "invoiceNinjaApi",
  "required": true
  }
  ]

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

output_names:
  [
  "Tool"
  ]

updated_at: 2025-12-11 23:50:26
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: Invoice Ninja node documentation
  description: Learn how to use the Invoice Ninja node in n8n. Follow technical documentation to integrate Invoice Ninja node into your workflows.
  contentType: [integration, reference]
  ---

  # Invoice Ninja node

  Use the Invoice Ninja node to automate work in Invoice Ninja, and integrate Invoice Ninja with other applications. n8n has built-in support for a wide range of Invoice Ninja features, including creating, updating, deleting, and getting clients, expense, invoice, payments and quotes. 

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

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

  ## Operations

  * Client
      * Create a new client
      * Delete a client
      * Get data of a client
      * Get data of all clients
  * Expense
      * Create a new expense
      * Delete an expense
      * Get data of an expense
      * Get data of all expenses
  * Invoice
      * Create a new invoice
      * Delete a invoice
      * Email an invoice
      * Get data of a invoice
      * Get data of all invoices
  * Payment
      * Create a new payment
      * Delete a payment
      * Get data of a payment
      * Get data of all payments
  * Quote
      * Create a new quote
      * Delete a quote
      * Email an quote
      * Get data of a quote
      * Get data of all quotes
  * Task
      * Create a new task
      * Delete a task
      * Get data of a task
      * Get data of all tasks

  ## Templates and examples

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

  --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 Invoice Ninja"
    },
    {
      "displayName": "API Version",
      "name": "apiVersion",
      "type": "options",
      "default": "v4",
      "options": [
        {
          "name": "Version 4",
          "value": "v4"
        },
        {
          "name": "Version 5",
          "value": "v5"
        }
      ],
      "displayOptions": {
        "show": {
          "@version": [
            1
          ]
        }
      }
    },
    {
      "displayName": "API Version",
      "name": "apiVersion",
      "type": "options",
      "default": "v5",
      "options": [
        {
          "name": "Version 4",
          "value": "v4"
        },
        {
          "name": "Version 5",
          "value": "v5"
        }
      ],
      "displayOptions": {
        "show": {
          "@version": [
            2
          ]
        }
      }
    },
    {
      "displayName": "Resource",
      "name": "resource",
      "type": "options",
      "default": "client",
      "options": [
        {
          "name": "Bank Transaction",
          "value": "bank_transaction",
          "displayOptions": {
            "show": {
              "apiVersion": [
                "v5"
              ]
            }
          }
        },
        {
          "name": "Client",
          "value": "client"
        },
        {
          "name": "Expense",
          "value": "expense"
        },
        {
          "name": "Invoice",
          "value": "invoice"
        },
        {
          "name": "Payment",
          "value": "payment"
        },
        {
          "name": "Quote",
          "value": "quote"
        },
        {
          "name": "Task",
          "value": "task"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create a new client",
          "action": "Create a client"
        },
        {
          "name": "Delete",
          "value": "delete",
          "description": "Delete a client",
          "action": "Delete a client"
        },
        {
          "name": "Get",
          "value": "get",
          "description": "Get data of a client",
          "action": "Get a client"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get data of many clients",
          "action": "Get many clients"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "client"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Client Name",
          "name": "clientName",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "ID Number",
          "name": "idNumber",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Private Notes",
          "name": "privateNotes",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "VAT Number",
          "name": "vatNumber",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Work Phone",
          "name": "workPhone",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Website",
          "name": "website",
          "type": "string",
          "default": ""
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "create"
          ],
          "resource": [
            "client"
          ]
        }
      }
    },
    {
      "displayName": "Billing Address",
      "name": "billingAddressUi",
      "type": "fixedCollection",
      "default": {},
      "options": [
        {
          "name": "billingAddressValue",
          "displayName": "Billing Address",
          "values": [
            {
              "displayName": "Street Address",
              "name": "streetAddress",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "Apt/Suite",
              "name": "aptSuite",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "City",
              "name": "city",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "State",
              "name": "state",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "Postal Code",
              "name": "postalCode",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "Country Code Name or ID",
              "name": "countryCode",
              "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": "getCountryCodes"
              },
              "default": ""
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "client"
          ],
          "operation": [
            "create"
          ]
        }
      },
      "typeOptions": {
        "multipleValues": false
      }
    },
    {
      "displayName": "Contacts",
      "name": "contactsUi",
      "type": "fixedCollection",
      "default": {},
      "options": [
        {
          "name": "contacstValues",
          "displayName": "Contact",
          "values": [
            {
              "displayName": "First Name",
              "name": "firstName",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "Last Name",
              "name": "lastName",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "Email",
              "name": "email",
              "type": "string",
              "placeholder": "name@email.com",
              "default": ""
            },
            {
              "displayName": "Phone",
              "name": "phone",
              "type": "string",
              "default": ""
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "client"
          ],
          "operation": [
            "create"
          ]
        }
      },
      "typeOptions": {
        "multipleValues": true
      }
    },
    {
      "displayName": "Shipping Address",
      "name": "shippingAddressUi",
      "type": "fixedCollection",
      "default": {},
      "options": [
        {
          "name": "shippingAddressValue",
          "displayName": "Shipping Address",
          "values": [
            {
              "displayName": "Street Address",
              "name": "streetAddress",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "Apt/Suite",
              "name": "aptSuite",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "City",
              "name": "city",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "State",
              "name": "state",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "Postal Code",
              "name": "postalCode",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "Country Code Name or ID",
              "name": "countryCode",
              "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": "getCountryCodes"
              },
              "default": ""
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "client"
          ],
          "operation": [
            "create"
          ]
        }
      },
      "typeOptions": {
        "multipleValues": false
      }
    },
    {
      "displayName": "Client ID",
      "name": "clientId",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "client"
          ],
          "operation": [
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "Client ID",
      "name": "clientId",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "client"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Include",
          "name": "include",
          "type": "options",
          "options": [
            {
              "name": "Invoices",
              "value": "invoices"
            }
          ],
          "default": "invoices"
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "get"
          ],
          "resource": [
            "client"
          ]
        }
      }
    },
    {
      "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": [
            "client"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 50,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "client"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 60
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Include",
          "name": "include",
          "type": "options",
          "options": [
            {
              "name": "Invoices",
              "value": "invoices"
            }
          ],
          "default": "invoices"
        },
        {
          "displayName": "Status",
          "name": "status",
          "type": "options",
          "options": [
            {
              "name": "Active",
              "value": "active"
            },
            {
              "name": "Archived",
              "value": "archived"
            },
            {
              "name": "Deleted",
              "value": "deleted"
            }
          ],
          "default": "active"
        },
        {
          "displayName": "Created At",
          "name": "createdAt",
          "type": "dateTime",
          "default": ""
        },
        {
          "displayName": "Updated At",
          "name": "updatedAt",
          "type": "dateTime",
          "default": ""
        },
        {
          "displayName": "Is Deleted",
          "name": "isDeleted",
          "type": "boolean",
          "default": false
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "client"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create a new invoice",
          "action": "Create an invoice"
        },
        {
          "name": "Delete",
          "value": "delete",
          "description": "Delete a invoice",
          "action": "Delete an invoice"
        },
        {
          "name": "Email",
          "value": "email",
          "description": "Email an invoice",
          "action": "Email an invoice"
        },
        {
          "name": "Get",
          "value": "get",
          "description": "Get data of a invoice",
          "action": "Get an invoice"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get data of many invoices",
          "action": "Get many invoices"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "invoice"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Client Name or ID",
          "name": "client",
          "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": "getClients"
          },
          "default": ""
        },
        {
          "displayName": "Auto Bill",
          "name": "autoBill",
          "type": "boolean",
          "default": false
        },
        {
          "displayName": "Custom Value 1",
          "name": "customValue1",
          "type": "number",
          "typeOptions": {
            "minValue": 0
          },
          "default": 0
        },
        {
          "displayName": "Custom Value 2",
          "name": "customValue2",
          "type": "number",
          "typeOptions": {
            "minValue": 0
          },
          "default": 0
        },
        {
          "displayName": "Discount",
          "name": "discount",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Due Date",
          "name": "dueDate",
          "type": "dateTime",
          "default": ""
        },
        {
          "displayName": "Email",
          "name": "email",
          "type": "string",
          "placeholder": "name@email.com",
          "default": ""
        },
        {
          "displayName": "Email Invoice",
          "name": "emailInvoice",
          "type": "boolean",
          "default": false
        },
        {
          "displayName": "Invoice Date",
          "name": "invoiceDate",
          "type": "dateTime",
          "default": ""
        },
        {
          "displayName": "Invoice Number",
          "name": "invoiceNumber",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Invoice Status",
          "name": "invoiceStatus",
          "type": "options",
          "options": [
            {
              "name": "Draft",
              "value": 1
            },
            {
              "name": "Sent",
              "value": 2
            }
          ],
          "default": 1
        },
        {
          "displayName": "Is Amount Discount",
          "name": "isAmountDiscount",
          "type": "boolean",
          "default": false
        },
        {
          "displayName": "Mark Sent",
          "name": "markSent",
          "type": "boolean",
          "default": false
        },
        {
          "displayName": "Paid",
          "name": "paid",
          "type": "number",
          "default": 0
        },
        {
          "displayName": "Partial",
          "name": "partial",
          "type": "number",
          "default": 0
        },
        {
          "displayName": "Partial Due Date",
          "name": "partialDueDate",
          "type": "dateTime",
          "default": ""
        },
        {
          "displayName": "PO Number",
          "name": "poNumber",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Private Notes",
          "name": "privateNotes",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Public Notes",
          "name": "publicNotes",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Tax Name 1",
          "name": "taxName1",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Tax Name 2",
          "name": "taxName2",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Tax Rate 1",
          "name": "taxRate1",
          "type": "number",
          "default": 0
        },
        {
          "displayName": "Tax Rate 2",
          "name": "taxRate2",
          "type": "number",
          "default": 0
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "create"
          ],
          "resource": [
            "invoice"
          ]
        }
      }
    },
    {
      "displayName": "Invoice Items",
      "name": "invoiceItemsUi",
      "type": "fixedCollection",
      "default": {},
      "options": [
        {
          "name": "invoiceItemsValues",
          "displayName": "Invoice Item",
          "values": [
            {
              "displayName": "Cost",
              "name": "cost",
              "type": "number",
              "default": 0
            },
            {
              "displayName": "Description",
              "name": "description",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "Service",
              "name": "service",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "Hours",
              "name": "hours",
              "type": "number",
              "typeOptions": {
                "minValue": 0
              },
              "default": 0
            },
            {
              "displayName": "Tax Name 1",
              "name": "taxName1",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "Tax Name 2",
              "name": "taxName2",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "Tax Rate 1",
              "name": "taxRate1",
              "type": "number",
              "default": 0
            },
            {
              "displayName": "Tax Rate 2",
              "name": "taxRate2",
              "type": "number",
              "default": 0
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "invoice"
          ],
          "operation": [
            "create"
          ]
        }
      },
      "typeOptions": {
        "multipleValues": true
      }
    },
    {
      "displayName": "Invoice ID",
      "name": "invoiceId",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "invoice"
          ],
          "operation": [
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "Invoice ID",
      "name": "invoiceId",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "invoice"
          ],
          "operation": [
            "email"
          ]
        }
      }
    },
    {
      "displayName": "Invoice ID",
      "name": "invoiceId",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "invoice"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Include",
          "name": "include",
          "type": "options",
          "options": [
            {
              "name": "Client",
              "value": "client"
            }
          ],
          "default": "client"
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "get"
          ],
          "resource": [
            "invoice"
          ]
        }
      }
    },
    {
      "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": [
            "invoice"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 50,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "invoice"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 60
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Invoice Number",
          "name": "invoiceNumber",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Include",
          "name": "include",
          "type": "options",
          "options": [
            {
              "name": "Client",
              "value": "client"
            }
          ],
          "default": "client"
        },
        {
          "displayName": "Status",
          "name": "status",
          "type": "options",
          "options": [
            {
              "name": "Active",
              "value": "active"
            },
            {
              "name": "Archived",
              "value": "archived"
            },
            {
              "name": "Deleted",
              "value": "deleted"
            }
          ],
          "default": "active"
        },
        {
          "displayName": "Created At",
          "name": "createdAt",
          "type": "dateTime",
          "default": ""
        },
        {
          "displayName": "Updated At",
          "name": "updatedAt",
          "type": "dateTime",
          "default": ""
        },
        {
          "displayName": "Is Deleted",
          "name": "isDeleted",
          "type": "boolean",
          "default": false
        },
        {
          "displayName": "Client Status",
          "name": "clientStatus",
          "type": "options",
          "options": [
            {
              "name": "All",
              "value": "all"
            },
            {
              "name": "Paid",
              "value": "paid"
            },
            {
              "name": "Unpaid",
              "value": "unpaid"
            },
            {
              "name": "Overdue",
              "value": "overdue"
            }
          ],
          "default": "all"
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "invoice"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create a new task",
          "action": "Create a task"
        },
        {
          "name": "Delete",
          "value": "delete",
          "description": "Delete a task",
          "action": "Delete a task"
        },
        {
          "name": "Get",
          "value": "get",
          "description": "Get data of a task",
          "action": "Get a task"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get data of many tasks",
          "action": "Get many tasks"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "task"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Client Name or ID",
          "name": "client",
          "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": "getClients"
          },
          "default": ""
        },
        {
          "displayName": "Custom Value 1",
          "name": "customValue1",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Custom Value 2",
          "name": "customValue2",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Description",
          "name": "description",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Project Name or ID",
          "name": "project",
          "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": "getProjects"
          },
          "default": ""
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "create"
          ],
          "resource": [
            "task"
          ]
        }
      }
    },
    {
      "displayName": "Time Logs",
      "name": "timeLogsUi",
      "type": "fixedCollection",
      "default": {},
      "options": [
        {
          "name": "timeLogsValues",
          "displayName": "Time Log",
          "values": [
            {
              "displayName": "Start Date",
              "name": "startDate",
              "type": "dateTime",
              "default": ""
            },
            {
              "displayName": "End Date",
              "name": "endDate",
              "type": "dateTime",
              "default": ""
            },
            {
              "displayName": "Duration (Hours)",
              "name": "duration",
              "type": "number",
              "typeOptions": {
                "minValue": 0
              },
              "default": 0
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "task"
          ],
          "operation": [
            "create"
          ]
        }
      },
      "typeOptions": {
        "multipleValues": true
      }
    },
    {
      "displayName": "Task ID",
      "name": "taskId",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "task"
          ],
          "operation": [
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "Task ID",
      "name": "taskId",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "task"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Include",
          "name": "include",
          "type": "options",
          "options": [
            {
              "name": "Client",
              "value": "client"
            }
          ],
          "default": "client"
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "get"
          ],
          "resource": [
            "task"
          ]
        }
      }
    },
    {
      "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": 50,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "task"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 60
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Include",
          "name": "include",
          "type": "options",
          "options": [
            {
              "name": "Client",
              "value": "client"
            }
          ],
          "default": "client"
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "task"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create a new payment",
          "action": "Create a payment"
        },
        {
          "name": "Delete",
          "value": "delete",
          "description": "Delete a payment",
          "action": "Delete a payment"
        },
        {
          "name": "Get",
          "value": "get",
          "description": "Get data of a payment",
          "action": "Get a payment"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get data of many payments",
          "action": "Get many payments"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "payment"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Invoice Name or ID",
      "name": "invoice",
      "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": {
          "operation": [
            "create"
          ],
          "resource": [
            "payment"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getInvoices"
      }
    },
    {
      "displayName": "Amount",
      "name": "amount",
      "type": "number",
      "default": 0,
      "displayOptions": {
        "show": {
          "operation": [
            "create"
          ],
          "resource": [
            "payment"
          ]
        }
      },
      "typeOptions": {
        "minValue": 0
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Payment Type",
          "name": "paymentType",
          "type": "options",
          "options": [
            {
              "name": "ACH",
              "value": 5
            },
            {
              "name": "Alipay",
              "value": 28
            },
            {
              "name": "American Express",
              "value": 8
            },
            {
              "name": "Apply Credit",
              "value": 1
            },
            {
              "name": "Bank Transfer",
              "value": 2
            },
            {
              "name": "Bitcoin",
              "value": 32
            },
            {
              "name": "Carte Blanche",
              "value": 17
            },
            {
              "name": "Cash",
              "value": 3
            },
            {
              "name": "Check",
              "value": 16
            },
            {
              "name": "Credit Card Other",
              "value": 13
            },
            {
              "name": "Debit",
              "value": 4
            },
            {
              "name": "Diners Card",
              "value": 10
            },
            {
              "name": "Discover Card",
              "value": 9
            },
            {
              "name": "EuroCard",
              "value": 11
            },
            {
              "name": "GoCardless",
              "value": 31
            },
            {
              "name": "Google Wallet",
              "value": 15
            },
            {
              "name": "iZettle",
              "value": 24
            },
            {
              "name": "JCB",
              "value": 19
            },
            {
              "name": "Laser",
              "value": 20
            },
            {
              "name": "Maestro",
              "value": 21
            },
            {
              "name": "MasterCard",
              "value": 7
            },
            {
              "name": "Money Order",
              "value": 27
            },
            {
              "name": "Nova",
              "value": 12
            },
            {
              "name": "Paypal",
              "value": 14
            },
            {
              "name": "SEPA",
              "value": 30
            },
            {
              "name": "Sofort",
              "value": 29
            },
            {
              "name": "Solo",
              "value": 22
            },
            {
              "name": "Swich",
              "value": 23
            },
            {
              "name": "Swish",
              "value": 25
            },
            {
              "name": "UnionPay",
              "value": 18
            },
            {
              "name": "Venmo",
              "value": 26
            },
            {
              "name": "Visa Card",
              "value": 6
            }
          ],
          "default": 1
        },
        {
          "displayName": "Transfer Reference",
          "name": "transferReference",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Private Notes",
          "name": "privateNotes",
          "type": "string",
          "default": ""
        }
      ],
      "displayOptions": {
        "show": {
          "apiVersion": [
            "v4"
          ],
          "operation": [
            "create"
          ],
          "resource": [
            "payment"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Payment Type",
          "name": "paymentType",
          "type": "options",
          "options": [
            {
              "name": "Bank Transfer",
              "value": 1
            },
            {
              "name": "Cash",
              "value": 2
            },
            {
              "name": "ACH",
              "value": 4
            },
            {
              "name": "Visa",
              "value": 5
            },
            {
              "name": "Mastercard",
              "value": 6
            },
            {
              "name": "American Express",
              "value": 7
            },
            {
              "name": "Discover",
              "value": 8
            },
            {
              "name": "Diners",
              "value": 9
            },
            {
              "name": "Eurocard",
              "value": 10
            },
            {
              "name": "Nova",
              "value": 11
            },
            {
              "name": "Credit Card Other",
              "value": 12
            },
            {
              "name": "PayPal",
              "value": 13
            },
            {
              "name": "Check",
              "value": 15
            },
            {
              "name": "Carte Blanche",
              "value": 16
            },
            {
              "name": "UnionPay",
              "value": 17
            },
            {
              "name": "JCB",
              "value": 18
            },
            {
              "name": "Laser",
              "value": 19
            },
            {
              "name": "Maestro",
              "value": 20
            },
            {
              "name": "Solo",
              "value": 21
            },
            {
              "name": "Switch",
              "value": 22
            },
            {
              "name": "Venmo",
              "value": 24
            },
            {
              "name": "Alipay",
              "value": 27
            },
            {
              "name": "Sofort",
              "value": 28
            },
            {
              "name": "SEPA",
              "value": 29
            },
            {
              "name": "GoCardless",
              "value": 30
            },
            {
              "name": "Crypto",
              "value": 31
            },
            {
              "name": "Credit",
              "value": 32
            },
            {
              "name": "Zelle",
              "value": 33
            },
            {
              "name": "Mollie Bank Transfer",
              "value": 34
            },
            {
              "name": "KBC",
              "value": 35
            },
            {
              "name": "Bancontact",
              "value": 36
            },
            {
              "name": "iDEAL",
              "value": 37
            },
            {
              "name": "Hosted Page",
              "value": 38
            },
            {
              "name": "Giropay",
              "value": 39
            },
            {
              "name": "Przelewy24",
              "value": 40
            },
            {
              "name": "EPS",
              "value": 41
            },
            {
              "name": "Direct Debit",
              "value": 42
            },
            {
              "name": "BECS",
              "value": 43
            },
            {
              "name": "ACSS",
              "value": 44
            },
            {
              "name": "Instant Bank Pay",
              "value": 45
            },
            {
              "name": "FPX",
              "value": 46
            },
            {
              "name": "Klarna",
              "value": 47
            },
            {
              "name": "Interac E-Transfer",
              "value": 48
            },
            {
              "name": "BACS",
              "value": 49
            },
            {
              "name": "Stripe Bank Transfer",
              "value": 50
            },
            {
              "name": "Cash App",
              "value": 51
            },
            {
              "name": "Pay Later",
              "value": 52
            }
          ],
          "default": 1
        },
        {
          "displayName": "Transfer Reference",
          "name": "transferReference",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Private Notes",
          "name": "privateNotes",
          "type": "string",
          "default": ""
        }
      ],
      "displayOptions": {
        "show": {
          "apiVersion": [
            "v5"
          ],
          "operation": [
            "create"
          ],
          "resource": [
            "payment"
          ]
        }
      }
    },
    {
      "displayName": "Payment ID",
      "name": "paymentId",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "payment"
          ],
          "operation": [
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "Payment ID",
      "name": "paymentId",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "payment"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Include",
          "name": "include",
          "type": "options",
          "options": [
            {
              "name": "Client",
              "value": "client"
            }
          ],
          "default": "client"
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "get"
          ],
          "resource": [
            "payment"
          ]
        }
      }
    },
    {
      "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": [
            "payment"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 50,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "payment"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 60
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Include",
          "name": "include",
          "type": "options",
          "options": [
            {
              "name": "Client",
              "value": "client"
            }
          ],
          "default": "client"
        },
        {
          "displayName": "Status",
          "name": "status",
          "type": "options",
          "options": [
            {
              "name": "Active",
              "value": "active"
            },
            {
              "name": "Archived",
              "value": "archived"
            },
            {
              "name": "Deleted",
              "value": "deleted"
            }
          ],
          "default": "active"
        },
        {
          "displayName": "Created At",
          "name": "createdAt",
          "type": "dateTime",
          "default": ""
        },
        {
          "displayName": "Updated At",
          "name": "updatedAt",
          "type": "dateTime",
          "default": ""
        },
        {
          "displayName": "Is Deleted",
          "name": "isDeleted",
          "type": "boolean",
          "default": false
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "payment"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create a new expense",
          "action": "Create an expense"
        },
        {
          "name": "Delete",
          "value": "delete",
          "description": "Delete an expense",
          "action": "Delete an expense"
        },
        {
          "name": "Get",
          "value": "get",
          "description": "Get data of an expense",
          "action": "Get an expense"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get data of many expenses",
          "action": "Get many expenses"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "expense"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Amount",
          "name": "amount",
          "type": "number",
          "default": 0
        },
        {
          "displayName": "Billable",
          "name": "billable",
          "type": "boolean",
          "default": false
        },
        {
          "displayName": "Client Name or ID",
          "name": "client",
          "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": "getClients"
          },
          "default": ""
        },
        {
          "displayName": "Custom Value 1",
          "name": "customValue1",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Custom Value 2",
          "name": "customValue2",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Category Name or ID",
          "name": "category",
          "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": "getExpenseCategories"
          },
          "default": ""
        },
        {
          "displayName": "Expense Date",
          "name": "expenseDate",
          "type": "dateTime",
          "default": ""
        },
        {
          "displayName": "Payment Date",
          "name": "paymentDate",
          "type": "dateTime",
          "default": ""
        },
        {
          "displayName": "Payment Type",
          "name": "paymentType",
          "type": "options",
          "options": [
            {
              "name": "ACH",
              "value": 5
            },
            {
              "name": "Alipay",
              "value": 28
            },
            {
              "name": "American Express",
              "value": 8
            },
            {
              "name": "Apply Credit",
              "value": 1
            },
            {
              "name": "Bank Transfer",
              "value": 2
            },
            {
              "name": "Bitcoin",
              "value": 32
            },
            {
              "name": "Carte Blanche",
              "value": 17
            },
            {
              "name": "Cash",
              "value": 3
            },
            {
              "name": "Check",
              "value": 16
            },
            {
              "name": "Credit Card Other",
              "value": 13
            },
            {
              "name": "Debit",
              "value": 4
            },
            {
              "name": "Diners Card",
              "value": 10
            },
            {
              "name": "Discover Card",
              "value": 9
            },
            {
              "name": "EuroCard",
              "value": 11
            },
            {
              "name": "GoCardless",
              "value": 31
            },
            {
              "name": "Google Wallet",
              "value": 15
            },
            {
              "name": "iZettle",
              "value": 24
            },
            {
              "name": "JCB",
              "value": 19
            },
            {
              "name": "Laser",
              "value": 20
            },
            {
              "name": "Maestro",
              "value": 21
            },
            {
              "name": "MasterCard",
              "value": 7
            },
            {
              "name": "Money Order",
              "value": 27
            },
            {
              "name": "Nova",
              "value": 12
            },
            {
              "name": "Paypal",
              "value": 14
            },
            {
              "name": "SEPA",
              "value": 30
            },
            {
              "name": "Sofort",
              "value": 29
            },
            {
              "name": "Solo",
              "value": 22
            },
            {
              "name": "Swich",
              "value": 23
            },
            {
              "name": "Swish",
              "value": 25
            },
            {
              "name": "UnionPay",
              "value": 18
            },
            {
              "name": "Venmo",
              "value": 26
            },
            {
              "name": "Visa Card",
              "value": 6
            }
          ],
          "default": 1
        },
        {
          "displayName": "Private Notes",
          "name": "privateNotes",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Public Notes",
          "name": "publicNotes",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Tax Name 1",
          "name": "taxName1",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Tax Name 2",
          "name": "taxName2",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Tax Rate 1",
          "name": "taxRate1",
          "type": "number",
          "default": 0
        },
        {
          "displayName": "Tax Rate 2",
          "name": "taxRate2",
          "type": "number",
          "default": 0
        },
        {
          "displayName": "Transaction Reference",
          "name": "transactionReference",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Vendor Name or ID",
          "name": "vendor",
          "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": "getVendors"
          },
          "default": ""
        }
      ],
      "displayOptions": {
        "show": {
          "apiVersion": [
            "v4"
          ],
          "operation": [
            "create"
          ],
          "resource": [
            "expense"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Amount",
          "name": "amount",
          "type": "number",
          "default": 0
        },
        {
          "displayName": "Billable",
          "name": "billable",
          "type": "boolean",
          "default": false
        },
        {
          "displayName": "Client Name or ID",
          "name": "client",
          "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": "getClients"
          },
          "default": ""
        },
        {
          "displayName": "Custom Value 1",
          "name": "customValue1",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Custom Value 2",
          "name": "customValue2",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Category Name or ID",
          "name": "category",
          "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": "getExpenseCategories"
          },
          "default": ""
        },
        {
          "displayName": "Expense Date",
          "name": "expenseDate",
          "type": "dateTime",
          "default": ""
        },
        {
          "displayName": "Payment Date",
          "name": "paymentDate",
          "type": "dateTime",
          "default": ""
        },
        {
          "displayName": "Payment Type",
          "name": "paymentType",
          "type": "options",
          "options": [
            {
              "name": "Bank Transfer",
              "value": 1
            },
            {
              "name": "Cash",
              "value": 2
            },
            {
              "name": "ACH",
              "value": 4
            },
            {
              "name": "Visa",
              "value": 5
            },
            {
              "name": "Mastercard",
              "value": 6
            },
            {
              "name": "American Express",
              "value": 7
            },
            {
              "name": "Discover",
              "value": 8
            },
            {
              "name": "Diners",
              "value": 9
            },
            {
              "name": "Eurocard",
              "value": 10
            },
            {
              "name": "Nova",
              "value": 11
            },
            {
              "name": "Credit Card Other",
              "value": 12
            },
            {
              "name": "PayPal",
              "value": 13
            },
            {
              "name": "Check",
              "value": 15
            },
            {
              "name": "Carte Blanche",
              "value": 16
            },
            {
              "name": "UnionPay",
              "value": 17
            },
            {
              "name": "JCB",
              "value": 18
            },
            {
              "name": "Laser",
              "value": 19
            },
            {
              "name": "Maestro",
              "value": 20
            },
            {
              "name": "Solo",
              "value": 21
            },
            {
              "name": "Switch",
              "value": 22
            },
            {
              "name": "Venmo",
              "value": 24
            },
            {
              "name": "Alipay",
              "value": 27
            },
            {
              "name": "Sofort",
              "value": 28
            },
            {
              "name": "SEPA",
              "value": 29
            },
            {
              "name": "GoCardless",
              "value": 30
            },
            {
              "name": "Crypto",
              "value": 31
            },
            {
              "name": "Credit",
              "value": 32
            },
            {
              "name": "Zelle",
              "value": 33
            },
            {
              "name": "Mollie Bank Transfer",
              "value": 34
            },
            {
              "name": "KBC",
              "value": 35
            },
            {
              "name": "Bancontact",
              "value": 36
            },
            {
              "name": "iDEAL",
              "value": 37
            },
            {
              "name": "Hosted Page",
              "value": 38
            },
            {
              "name": "Giropay",
              "value": 39
            },
            {
              "name": "Przelewy24",
              "value": 40
            },
            {
              "name": "EPS",
              "value": 41
            },
            {
              "name": "Direct Debit",
              "value": 42
            },
            {
              "name": "BECS",
              "value": 43
            },
            {
              "name": "ACSS",
              "value": 44
            },
            {
              "name": "Instant Bank Pay",
              "value": 45
            },
            {
              "name": "FPX",
              "value": 46
            },
            {
              "name": "Klarna",
              "value": 47
            },
            {
              "name": "Interac E-Transfer",
              "value": 48
            },
            {
              "name": "BACS",
              "value": 49
            },
            {
              "name": "Stripe Bank Transfer",
              "value": 50
            },
            {
              "name": "Cash App",
              "value": 51
            },
            {
              "name": "Pay Later",
              "value": 52
            }
          ],
          "default": 1
        },
        {
          "displayName": "Private Notes",
          "name": "privateNotes",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Public Notes",
          "name": "publicNotes",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Tax Name 1",
          "name": "taxName1",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Tax Name 2",
          "name": "taxName2",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Tax Rate 1",
          "name": "taxRate1",
          "type": "number",
          "default": 0
        },
        {
          "displayName": "Tax Rate 2",
          "name": "taxRate2",
          "type": "number",
          "default": 0
        },
        {
          "displayName": "Transaction Reference",
          "name": "transactionReference",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Vendor Name or ID",
          "name": "vendor",
          "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": "getVendors"
          },
          "default": ""
        }
      ],
      "displayOptions": {
        "show": {
          "apiVersion": [
            "v5"
          ],
          "operation": [
            "create"
          ],
          "resource": [
            "expense"
          ]
        }
      }
    },
    {
      "displayName": "Expense ID",
      "name": "expenseId",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "expense"
          ],
          "operation": [
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "Expense ID",
      "name": "expenseId",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "expense"
          ],
          "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": [
            "expense"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 50,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "expense"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 60
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create a new quote",
          "action": "Create a quote"
        },
        {
          "name": "Delete",
          "value": "delete",
          "description": "Delete a quote",
          "action": "Delete a quote"
        },
        {
          "name": "Email",
          "value": "email",
          "description": "Email a quote",
          "action": "Email a quote"
        },
        {
          "name": "Get",
          "value": "get",
          "description": "Get data of a quote",
          "action": "Get a quote"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get data of many quotes",
          "action": "Get many quotes"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "quote"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Client Name or ID",
          "name": "client",
          "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": "getClients"
          },
          "default": ""
        },
        {
          "displayName": "Auto Bill",
          "name": "autoBill",
          "type": "boolean",
          "default": false
        },
        {
          "displayName": "Custom Value 1",
          "name": "customValue1",
          "type": "number",
          "typeOptions": {
            "minValue": 0
          },
          "default": 0
        },
        {
          "displayName": "Custom Value 2",
          "name": "customValue2",
          "type": "number",
          "typeOptions": {
            "minValue": 0
          },
          "default": 0
        },
        {
          "displayName": "Discount",
          "name": "discount",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Due Date",
          "name": "dueDate",
          "type": "dateTime",
          "default": ""
        },
        {
          "displayName": "Email",
          "name": "email",
          "type": "string",
          "placeholder": "name@email.com",
          "default": ""
        },
        {
          "displayName": "Email Quote",
          "name": "emailQuote",
          "type": "boolean",
          "default": false
        },
        {
          "displayName": "Quote Date",
          "name": "quoteDate",
          "type": "dateTime",
          "default": ""
        },
        {
          "displayName": "Quote Number",
          "name": "quoteNumber",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Quote Status",
          "name": "quoteStatus",
          "type": "options",
          "options": [
            {
              "name": "Draft",
              "value": 1
            },
            {
              "name": "Sent",
              "value": 2
            }
          ],
          "default": 1
        },
        {
          "displayName": "Is Amount Discount",
          "name": "isAmountDiscount",
          "type": "boolean",
          "default": false
        },
        {
          "displayName": "Paid",
          "name": "paid",
          "type": "number",
          "default": 0
        },
        {
          "displayName": "Partial",
          "name": "partial",
          "type": "number",
          "default": 0
        },
        {
          "displayName": "Partial Due Date",
          "name": "partialDueDate",
          "type": "dateTime",
          "default": ""
        },
        {
          "displayName": "Po Number",
          "name": "poNumber",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Private Notes",
          "name": "privateNotes",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Public Notes",
          "name": "publicNotes",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Tax Name 1",
          "name": "taxName1",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Tax Name 2",
          "name": "taxName2",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Tax Rate 1",
          "name": "taxRate1",
          "type": "number",
          "default": 0
        },
        {
          "displayName": "Tax Rate 2",
          "name": "taxRate2",
          "type": "number",
          "default": 0
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "create"
          ],
          "resource": [
            "quote"
          ]
        }
      }
    },
    {
      "displayName": "Invoice Items",
      "name": "invoiceItemsUi",
      "type": "fixedCollection",
      "default": {},
      "options": [
        {
          "name": "invoiceItemsValues",
          "displayName": "Invoice Item",
          "values": [
            {
              "displayName": "Cost",
              "name": "cost",
              "type": "number",
              "default": 0
            },
            {
              "displayName": "Description",
              "name": "description",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "Service",
              "name": "service",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "Hours",
              "name": "hours",
              "type": "number",
              "typeOptions": {
                "minValue": 0
              },
              "default": 0
            },
            {
              "displayName": "Tax Name 1",
              "name": "taxName1",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "Tax Name 2",
              "name": "taxName2",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "Tax Rate 1",
              "name": "taxRate1",
              "type": "number",
              "default": 0
            },
            {
              "displayName": "Tax Rate 2",
              "name": "taxRate2",
              "type": "number",
              "default": 0
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "quote"
          ],
          "operation": [
            "create"
          ]
        }
      },
      "typeOptions": {
        "multipleValues": true
      }
    },
    {
      "displayName": "Quote ID",
      "name": "quoteId",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "quote"
          ],
          "operation": [
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "Quote ID",
      "name": "quoteId",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "quote"
          ],
          "operation": [
            "email"
          ]
        }
      }
    },
    {
      "displayName": "Quote ID",
      "name": "quoteId",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "quote"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Include",
          "name": "include",
          "type": "options",
          "options": [
            {
              "name": "Client",
              "value": "client"
            }
          ],
          "default": "client"
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "get"
          ],
          "resource": [
            "quote"
          ]
        }
      }
    },
    {
      "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": [
            "quote"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 50,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "quote"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 60
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Quote Number",
          "name": "quoteNumber",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Include",
          "name": "include",
          "type": "options",
          "options": [
            {
              "name": "Client",
              "value": "client"
            }
          ],
          "default": "client"
        },
        {
          "displayName": "Status",
          "name": "status",
          "type": "options",
          "options": [
            {
              "name": "Active",
              "value": "active"
            },
            {
              "name": "Archived",
              "value": "archived"
            },
            {
              "name": "Deleted",
              "value": "deleted"
            }
          ],
          "default": "active"
        },
        {
          "displayName": "Created At",
          "name": "createdAt",
          "type": "dateTime",
          "default": ""
        },
        {
          "displayName": "Updated At",
          "name": "updatedAt",
          "type": "dateTime",
          "default": ""
        },
        {
          "displayName": "Is Deleted",
          "name": "isDeleted",
          "type": "boolean",
          "default": false
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "quote"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create a new bank transaction",
          "action": "Create a bank transaction"
        },
        {
          "name": "Delete",
          "value": "delete",
          "description": "Delete a bank transaction",
          "action": "Delete a bank transaction"
        },
        {
          "name": "Get",
          "value": "get",
          "description": "Get data of a bank transaction",
          "action": "Get a bank transaction"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get data of many bank transactions",
          "action": "Get many bank transactions"
        },
        {
          "name": "Match Payment",
          "value": "matchPayment",
          "description": "Match payment to a bank transaction",
          "action": "Match payment to a bank transaction"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "bank_transaction"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Amount",
          "name": "amount",
          "type": "number",
          "default": 0
        },
        {
          "displayName": "Bank Integration Name or ID",
          "name": "bankIntegrationId",
          "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": "getBankIntegrations"
          },
          "default": ""
        },
        {
          "displayName": "Base Type",
          "name": "baseType",
          "type": "options",
          "options": [
            {
              "name": "Deposit",
              "value": "CREDIT"
            },
            {
              "name": "Withdrawal",
              "value": "DEBIT"
            }
          ],
          "default": ""
        },
        {
          "displayName": "Currency Name or ID",
          "name": "currencyId",
          "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": "getCurrencies"
          },
          "default": ""
        },
        {
          "displayName": "Date",
          "name": "date",
          "type": "dateTime",
          "default": ""
        },
        {
          "displayName": "Description",
          "name": "description",
          "type": "string",
          "default": ""
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "create"
          ],
          "resource": [
            "bank_transaction"
          ]
        }
      }
    },
    {
      "displayName": "Bank Transaction ID",
      "name": "bankTransactionId",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "bank_transaction"
          ],
          "operation": [
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "Bank Transaction ID",
      "name": "bankTransactionId",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "bank_transaction"
          ],
          "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": [
            "bank_transaction"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 50,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "bank_transaction"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 60
      }
    },
    {
      "displayName": "Bank Transaction ID",
      "name": "bankTransactionId",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "bank_transaction"
          ],
          "operation": [
            "matchPayment"
          ]
        }
      }
    },
    {
      "displayName": "Payment Name or ID",
      "name": "paymentId",
      "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": [
            "bank_transaction"
          ],
          "operation": [
            "matchPayment"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getPayments"
      }
    }
  ]

operations:
  [
    {
      "operation": "create",
      "name": "Create",
      "description": "Create a new client"
    },
    {
      "operation": "delete",
      "name": "Delete",
      "description": "Delete a client"
    },
    {
      "operation": "get",
      "name": "Get",
      "description": "Get data of a client"
    },
    {
      "operation": "getAll",
      "name": "Get Many",
      "description": "Get data of many clients"
    }
  ]


node_type: nodes-base.invoiceNinja
package_name: n8n-nodes-base
display_name: Invoice Ninja
description: Consume Invoice Ninja API
category: output
development_style: programmatic
version: 2
credentials_required:
  [
  {
  "name": "invoiceNinjaApi",
  "required": true
  }
  ]

outputs:
  [
  "main"
  ]

updated_at: 2025-12-11 23:50:26
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: Invoice Ninja node documentation
  description: Learn how to use the Invoice Ninja node in n8n. Follow technical documentation to integrate Invoice Ninja node into your workflows.
  contentType: [integration, reference]
  ---

  # Invoice Ninja node

  Use the Invoice Ninja node to automate work in Invoice Ninja, and integrate Invoice Ninja with other applications. n8n has built-in support for a wide range of Invoice Ninja features, including creating, updating, deleting, and getting clients, expense, invoice, payments and quotes. 

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

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

  ## Operations

  * Client
      * Create a new client
      * Delete a client
      * Get data of a client
      * Get data of all clients
  * Expense
      * Create a new expense
      * Delete an expense
      * Get data of an expense
      * Get data of all expenses
  * Invoice
      * Create a new invoice
      * Delete a invoice
      * Email an invoice
      * Get data of a invoice
      * Get data of all invoices
  * Payment
      * Create a new payment
      * Delete a payment
      * Get data of a payment
      * Get data of all payments
  * Quote
      * Create a new quote
      * Delete a quote
      * Email an quote
      * Get data of a quote
      * Get data of all quotes
  * Task
      * Create a new task
      * Delete a task
      * Get data of a task
      * Get data of all tasks

  ## Templates and examples

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

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

properties_schema:
  [
    {
      "displayName": "API Version",
      "name": "apiVersion",
      "type": "options",
      "default": "v4",
      "options": [
        {
          "name": "Version 4",
          "value": "v4"
        },
        {
          "name": "Version 5",
          "value": "v5"
        }
      ],
      "displayOptions": {
        "show": {
          "@version": [
            1
          ]
        }
      }
    },
    {
      "displayName": "API Version",
      "name": "apiVersion",
      "type": "options",
      "default": "v5",
      "options": [
        {
          "name": "Version 4",
          "value": "v4"
        },
        {
          "name": "Version 5",
          "value": "v5"
        }
      ],
      "displayOptions": {
        "show": {
          "@version": [
            2
          ]
        }
      }
    },
    {
      "displayName": "Resource",
      "name": "resource",
      "type": "options",
      "default": "client",
      "options": [
        {
          "name": "Bank Transaction",
          "value": "bank_transaction",
          "displayOptions": {
            "show": {
              "apiVersion": [
                "v5"
              ]
            }
          }
        },
        {
          "name": "Client",
          "value": "client"
        },
        {
          "name": "Expense",
          "value": "expense"
        },
        {
          "name": "Invoice",
          "value": "invoice"
        },
        {
          "name": "Payment",
          "value": "payment"
        },
        {
          "name": "Quote",
          "value": "quote"
        },
        {
          "name": "Task",
          "value": "task"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create a new client",
          "action": "Create a client"
        },
        {
          "name": "Delete",
          "value": "delete",
          "description": "Delete a client",
          "action": "Delete a client"
        },
        {
          "name": "Get",
          "value": "get",
          "description": "Get data of a client",
          "action": "Get a client"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get data of many clients",
          "action": "Get many clients"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "client"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Client Name",
          "name": "clientName",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "ID Number",
          "name": "idNumber",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Private Notes",
          "name": "privateNotes",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "VAT Number",
          "name": "vatNumber",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Work Phone",
          "name": "workPhone",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Website",
          "name": "website",
          "type": "string",
          "default": ""
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "create"
          ],
          "resource": [
            "client"
          ]
        }
      }
    },
    {
      "displayName": "Billing Address",
      "name": "billingAddressUi",
      "type": "fixedCollection",
      "default": {},
      "options": [
        {
          "name": "billingAddressValue",
          "displayName": "Billing Address",
          "values": [
            {
              "displayName": "Street Address",
              "name": "streetAddress",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "Apt/Suite",
              "name": "aptSuite",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "City",
              "name": "city",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "State",
              "name": "state",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "Postal Code",
              "name": "postalCode",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "Country Code Name or ID",
              "name": "countryCode",
              "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": "getCountryCodes"
              },
              "default": ""
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "client"
          ],
          "operation": [
            "create"
          ]
        }
      },
      "typeOptions": {
        "multipleValues": false
      }
    },
    {
      "displayName": "Contacts",
      "name": "contactsUi",
      "type": "fixedCollection",
      "default": {},
      "options": [
        {
          "name": "contacstValues",
          "displayName": "Contact",
          "values": [
            {
              "displayName": "First Name",
              "name": "firstName",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "Last Name",
              "name": "lastName",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "Email",
              "name": "email",
              "type": "string",
              "placeholder": "name@email.com",
              "default": ""
            },
            {
              "displayName": "Phone",
              "name": "phone",
              "type": "string",
              "default": ""
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "client"
          ],
          "operation": [
            "create"
          ]
        }
      },
      "typeOptions": {
        "multipleValues": true
      }
    },
    {
      "displayName": "Shipping Address",
      "name": "shippingAddressUi",
      "type": "fixedCollection",
      "default": {},
      "options": [
        {
          "name": "shippingAddressValue",
          "displayName": "Shipping Address",
          "values": [
            {
              "displayName": "Street Address",
              "name": "streetAddress",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "Apt/Suite",
              "name": "aptSuite",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "City",
              "name": "city",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "State",
              "name": "state",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "Postal Code",
              "name": "postalCode",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "Country Code Name or ID",
              "name": "countryCode",
              "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": "getCountryCodes"
              },
              "default": ""
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "client"
          ],
          "operation": [
            "create"
          ]
        }
      },
      "typeOptions": {
        "multipleValues": false
      }
    },
    {
      "displayName": "Client ID",
      "name": "clientId",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "client"
          ],
          "operation": [
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "Client ID",
      "name": "clientId",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "client"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Include",
          "name": "include",
          "type": "options",
          "options": [
            {
              "name": "Invoices",
              "value": "invoices"
            }
          ],
          "default": "invoices"
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "get"
          ],
          "resource": [
            "client"
          ]
        }
      }
    },
    {
      "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": [
            "client"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 50,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "client"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 60
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Include",
          "name": "include",
          "type": "options",
          "options": [
            {
              "name": "Invoices",
              "value": "invoices"
            }
          ],
          "default": "invoices"
        },
        {
          "displayName": "Status",
          "name": "status",
          "type": "options",
          "options": [
            {
              "name": "Active",
              "value": "active"
            },
            {
              "name": "Archived",
              "value": "archived"
            },
            {
              "name": "Deleted",
              "value": "deleted"
            }
          ],
          "default": "active"
        },
        {
          "displayName": "Created At",
          "name": "createdAt",
          "type": "dateTime",
          "default": ""
        },
        {
          "displayName": "Updated At",
          "name": "updatedAt",
          "type": "dateTime",
          "default": ""
        },
        {
          "displayName": "Is Deleted",
          "name": "isDeleted",
          "type": "boolean",
          "default": false
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "client"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create a new invoice",
          "action": "Create an invoice"
        },
        {
          "name": "Delete",
          "value": "delete",
          "description": "Delete a invoice",
          "action": "Delete an invoice"
        },
        {
          "name": "Email",
          "value": "email",
          "description": "Email an invoice",
          "action": "Email an invoice"
        },
        {
          "name": "Get",
          "value": "get",
          "description": "Get data of a invoice",
          "action": "Get an invoice"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get data of many invoices",
          "action": "Get many invoices"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "invoice"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Client Name or ID",
          "name": "client",
          "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": "getClients"
          },
          "default": ""
        },
        {
          "displayName": "Auto Bill",
          "name": "autoBill",
          "type": "boolean",
          "default": false
        },
        {
          "displayName": "Custom Value 1",
          "name": "customValue1",
          "type": "number",
          "typeOptions": {
            "minValue": 0
          },
          "default": 0
        },
        {
          "displayName": "Custom Value 2",
          "name": "customValue2",
          "type": "number",
          "typeOptions": {
            "minValue": 0
          },
          "default": 0
        },
        {
          "displayName": "Discount",
          "name": "discount",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Due Date",
          "name": "dueDate",
          "type": "dateTime",
          "default": ""
        },
        {
          "displayName": "Email",
          "name": "email",
          "type": "string",
          "placeholder": "name@email.com",
          "default": ""
        },
        {
          "displayName": "Email Invoice",
          "name": "emailInvoice",
          "type": "boolean",
          "default": false
        },
        {
          "displayName": "Invoice Date",
          "name": "invoiceDate",
          "type": "dateTime",
          "default": ""
        },
        {
          "displayName": "Invoice Number",
          "name": "invoiceNumber",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Invoice Status",
          "name": "invoiceStatus",
          "type": "options",
          "options": [
            {
              "name": "Draft",
              "value": 1
            },
            {
              "name": "Sent",
              "value": 2
            }
          ],
          "default": 1
        },
        {
          "displayName": "Is Amount Discount",
          "name": "isAmountDiscount",
          "type": "boolean",
          "default": false
        },
        {
          "displayName": "Mark Sent",
          "name": "markSent",
          "type": "boolean",
          "default": false
        },
        {
          "displayName": "Paid",
          "name": "paid",
          "type": "number",
          "default": 0
        },
        {
          "displayName": "Partial",
          "name": "partial",
          "type": "number",
          "default": 0
        },
        {
          "displayName": "Partial Due Date",
          "name": "partialDueDate",
          "type": "dateTime",
          "default": ""
        },
        {
          "displayName": "PO Number",
          "name": "poNumber",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Private Notes",
          "name": "privateNotes",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Public Notes",
          "name": "publicNotes",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Tax Name 1",
          "name": "taxName1",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Tax Name 2",
          "name": "taxName2",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Tax Rate 1",
          "name": "taxRate1",
          "type": "number",
          "default": 0
        },
        {
          "displayName": "Tax Rate 2",
          "name": "taxRate2",
          "type": "number",
          "default": 0
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "create"
          ],
          "resource": [
            "invoice"
          ]
        }
      }
    },
    {
      "displayName": "Invoice Items",
      "name": "invoiceItemsUi",
      "type": "fixedCollection",
      "default": {},
      "options": [
        {
          "name": "invoiceItemsValues",
          "displayName": "Invoice Item",
          "values": [
            {
              "displayName": "Cost",
              "name": "cost",
              "type": "number",
              "default": 0
            },
            {
              "displayName": "Description",
              "name": "description",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "Service",
              "name": "service",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "Hours",
              "name": "hours",
              "type": "number",
              "typeOptions": {
                "minValue": 0
              },
              "default": 0
            },
            {
              "displayName": "Tax Name 1",
              "name": "taxName1",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "Tax Name 2",
              "name": "taxName2",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "Tax Rate 1",
              "name": "taxRate1",
              "type": "number",
              "default": 0
            },
            {
              "displayName": "Tax Rate 2",
              "name": "taxRate2",
              "type": "number",
              "default": 0
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "invoice"
          ],
          "operation": [
            "create"
          ]
        }
      },
      "typeOptions": {
        "multipleValues": true
      }
    },
    {
      "displayName": "Invoice ID",
      "name": "invoiceId",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "invoice"
          ],
          "operation": [
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "Invoice ID",
      "name": "invoiceId",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "invoice"
          ],
          "operation": [
            "email"
          ]
        }
      }
    },
    {
      "displayName": "Invoice ID",
      "name": "invoiceId",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "invoice"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Include",
          "name": "include",
          "type": "options",
          "options": [
            {
              "name": "Client",
              "value": "client"
            }
          ],
          "default": "client"
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "get"
          ],
          "resource": [
            "invoice"
          ]
        }
      }
    },
    {
      "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": [
            "invoice"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 50,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "invoice"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 60
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Invoice Number",
          "name": "invoiceNumber",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Include",
          "name": "include",
          "type": "options",
          "options": [
            {
              "name": "Client",
              "value": "client"
            }
          ],
          "default": "client"
        },
        {
          "displayName": "Status",
          "name": "status",
          "type": "options",
          "options": [
            {
              "name": "Active",
              "value": "active"
            },
            {
              "name": "Archived",
              "value": "archived"
            },
            {
              "name": "Deleted",
              "value": "deleted"
            }
          ],
          "default": "active"
        },
        {
          "displayName": "Created At",
          "name": "createdAt",
          "type": "dateTime",
          "default": ""
        },
        {
          "displayName": "Updated At",
          "name": "updatedAt",
          "type": "dateTime",
          "default": ""
        },
        {
          "displayName": "Is Deleted",
          "name": "isDeleted",
          "type": "boolean",
          "default": false
        },
        {
          "displayName": "Client Status",
          "name": "clientStatus",
          "type": "options",
          "options": [
            {
              "name": "All",
              "value": "all"
            },
            {
              "name": "Paid",
              "value": "paid"
            },
            {
              "name": "Unpaid",
              "value": "unpaid"
            },
            {
              "name": "Overdue",
              "value": "overdue"
            }
          ],
          "default": "all"
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "invoice"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create a new task",
          "action": "Create a task"
        },
        {
          "name": "Delete",
          "value": "delete",
          "description": "Delete a task",
          "action": "Delete a task"
        },
        {
          "name": "Get",
          "value": "get",
          "description": "Get data of a task",
          "action": "Get a task"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get data of many tasks",
          "action": "Get many tasks"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "task"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Client Name or ID",
          "name": "client",
          "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": "getClients"
          },
          "default": ""
        },
        {
          "displayName": "Custom Value 1",
          "name": "customValue1",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Custom Value 2",
          "name": "customValue2",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Description",
          "name": "description",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Project Name or ID",
          "name": "project",
          "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": "getProjects"
          },
          "default": ""
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "create"
          ],
          "resource": [
            "task"
          ]
        }
      }
    },
    {
      "displayName": "Time Logs",
      "name": "timeLogsUi",
      "type": "fixedCollection",
      "default": {},
      "options": [
        {
          "name": "timeLogsValues",
          "displayName": "Time Log",
          "values": [
            {
              "displayName": "Start Date",
              "name": "startDate",
              "type": "dateTime",
              "default": ""
            },
            {
              "displayName": "End Date",
              "name": "endDate",
              "type": "dateTime",
              "default": ""
            },
            {
              "displayName": "Duration (Hours)",
              "name": "duration",
              "type": "number",
              "typeOptions": {
                "minValue": 0
              },
              "default": 0
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "task"
          ],
          "operation": [
            "create"
          ]
        }
      },
      "typeOptions": {
        "multipleValues": true
      }
    },
    {
      "displayName": "Task ID",
      "name": "taskId",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "task"
          ],
          "operation": [
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "Task ID",
      "name": "taskId",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "task"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Include",
          "name": "include",
          "type": "options",
          "options": [
            {
              "name": "Client",
              "value": "client"
            }
          ],
          "default": "client"
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "get"
          ],
          "resource": [
            "task"
          ]
        }
      }
    },
    {
      "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": 50,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "task"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 60
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Include",
          "name": "include",
          "type": "options",
          "options": [
            {
              "name": "Client",
              "value": "client"
            }
          ],
          "default": "client"
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "task"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create a new payment",
          "action": "Create a payment"
        },
        {
          "name": "Delete",
          "value": "delete",
          "description": "Delete a payment",
          "action": "Delete a payment"
        },
        {
          "name": "Get",
          "value": "get",
          "description": "Get data of a payment",
          "action": "Get a payment"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get data of many payments",
          "action": "Get many payments"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "payment"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Invoice Name or ID",
      "name": "invoice",
      "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": {
          "operation": [
            "create"
          ],
          "resource": [
            "payment"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getInvoices"
      }
    },
    {
      "displayName": "Amount",
      "name": "amount",
      "type": "number",
      "default": 0,
      "displayOptions": {
        "show": {
          "operation": [
            "create"
          ],
          "resource": [
            "payment"
          ]
        }
      },
      "typeOptions": {
        "minValue": 0
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Payment Type",
          "name": "paymentType",
          "type": "options",
          "options": [
            {
              "name": "ACH",
              "value": 5
            },
            {
              "name": "Alipay",
              "value": 28
            },
            {
              "name": "American Express",
              "value": 8
            },
            {
              "name": "Apply Credit",
              "value": 1
            },
            {
              "name": "Bank Transfer",
              "value": 2
            },
            {
              "name": "Bitcoin",
              "value": 32
            },
            {
              "name": "Carte Blanche",
              "value": 17
            },
            {
              "name": "Cash",
              "value": 3
            },
            {
              "name": "Check",
              "value": 16
            },
            {
              "name": "Credit Card Other",
              "value": 13
            },
            {
              "name": "Debit",
              "value": 4
            },
            {
              "name": "Diners Card",
              "value": 10
            },
            {
              "name": "Discover Card",
              "value": 9
            },
            {
              "name": "EuroCard",
              "value": 11
            },
            {
              "name": "GoCardless",
              "value": 31
            },
            {
              "name": "Google Wallet",
              "value": 15
            },
            {
              "name": "iZettle",
              "value": 24
            },
            {
              "name": "JCB",
              "value": 19
            },
            {
              "name": "Laser",
              "value": 20
            },
            {
              "name": "Maestro",
              "value": 21
            },
            {
              "name": "MasterCard",
              "value": 7
            },
            {
              "name": "Money Order",
              "value": 27
            },
            {
              "name": "Nova",
              "value": 12
            },
            {
              "name": "Paypal",
              "value": 14
            },
            {
              "name": "SEPA",
              "value": 30
            },
            {
              "name": "Sofort",
              "value": 29
            },
            {
              "name": "Solo",
              "value": 22
            },
            {
              "name": "Swich",
              "value": 23
            },
            {
              "name": "Swish",
              "value": 25
            },
            {
              "name": "UnionPay",
              "value": 18
            },
            {
              "name": "Venmo",
              "value": 26
            },
            {
              "name": "Visa Card",
              "value": 6
            }
          ],
          "default": 1
        },
        {
          "displayName": "Transfer Reference",
          "name": "transferReference",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Private Notes",
          "name": "privateNotes",
          "type": "string",
          "default": ""
        }
      ],
      "displayOptions": {
        "show": {
          "apiVersion": [
            "v4"
          ],
          "operation": [
            "create"
          ],
          "resource": [
            "payment"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Payment Type",
          "name": "paymentType",
          "type": "options",
          "options": [
            {
              "name": "Bank Transfer",
              "value": 1
            },
            {
              "name": "Cash",
              "value": 2
            },
            {
              "name": "ACH",
              "value": 4
            },
            {
              "name": "Visa",
              "value": 5
            },
            {
              "name": "Mastercard",
              "value": 6
            },
            {
              "name": "American Express",
              "value": 7
            },
            {
              "name": "Discover",
              "value": 8
            },
            {
              "name": "Diners",
              "value": 9
            },
            {
              "name": "Eurocard",
              "value": 10
            },
            {
              "name": "Nova",
              "value": 11
            },
            {
              "name": "Credit Card Other",
              "value": 12
            },
            {
              "name": "PayPal",
              "value": 13
            },
            {
              "name": "Check",
              "value": 15
            },
            {
              "name": "Carte Blanche",
              "value": 16
            },
            {
              "name": "UnionPay",
              "value": 17
            },
            {
              "name": "JCB",
              "value": 18
            },
            {
              "name": "Laser",
              "value": 19
            },
            {
              "name": "Maestro",
              "value": 20
            },
            {
              "name": "Solo",
              "value": 21
            },
            {
              "name": "Switch",
              "value": 22
            },
            {
              "name": "Venmo",
              "value": 24
            },
            {
              "name": "Alipay",
              "value": 27
            },
            {
              "name": "Sofort",
              "value": 28
            },
            {
              "name": "SEPA",
              "value": 29
            },
            {
              "name": "GoCardless",
              "value": 30
            },
            {
              "name": "Crypto",
              "value": 31
            },
            {
              "name": "Credit",
              "value": 32
            },
            {
              "name": "Zelle",
              "value": 33
            },
            {
              "name": "Mollie Bank Transfer",
              "value": 34
            },
            {
              "name": "KBC",
              "value": 35
            },
            {
              "name": "Bancontact",
              "value": 36
            },
            {
              "name": "iDEAL",
              "value": 37
            },
            {
              "name": "Hosted Page",
              "value": 38
            },
            {
              "name": "Giropay",
              "value": 39
            },
            {
              "name": "Przelewy24",
              "value": 40
            },
            {
              "name": "EPS",
              "value": 41
            },
            {
              "name": "Direct Debit",
              "value": 42
            },
            {
              "name": "BECS",
              "value": 43
            },
            {
              "name": "ACSS",
              "value": 44
            },
            {
              "name": "Instant Bank Pay",
              "value": 45
            },
            {
              "name": "FPX",
              "value": 46
            },
            {
              "name": "Klarna",
              "value": 47
            },
            {
              "name": "Interac E-Transfer",
              "value": 48
            },
            {
              "name": "BACS",
              "value": 49
            },
            {
              "name": "Stripe Bank Transfer",
              "value": 50
            },
            {
              "name": "Cash App",
              "value": 51
            },
            {
              "name": "Pay Later",
              "value": 52
            }
          ],
          "default": 1
        },
        {
          "displayName": "Transfer Reference",
          "name": "transferReference",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Private Notes",
          "name": "privateNotes",
          "type": "string",
          "default": ""
        }
      ],
      "displayOptions": {
        "show": {
          "apiVersion": [
            "v5"
          ],
          "operation": [
            "create"
          ],
          "resource": [
            "payment"
          ]
        }
      }
    },
    {
      "displayName": "Payment ID",
      "name": "paymentId",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "payment"
          ],
          "operation": [
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "Payment ID",
      "name": "paymentId",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "payment"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Include",
          "name": "include",
          "type": "options",
          "options": [
            {
              "name": "Client",
              "value": "client"
            }
          ],
          "default": "client"
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "get"
          ],
          "resource": [
            "payment"
          ]
        }
      }
    },
    {
      "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": [
            "payment"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 50,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "payment"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 60
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Include",
          "name": "include",
          "type": "options",
          "options": [
            {
              "name": "Client",
              "value": "client"
            }
          ],
          "default": "client"
        },
        {
          "displayName": "Status",
          "name": "status",
          "type": "options",
          "options": [
            {
              "name": "Active",
              "value": "active"
            },
            {
              "name": "Archived",
              "value": "archived"
            },
            {
              "name": "Deleted",
              "value": "deleted"
            }
          ],
          "default": "active"
        },
        {
          "displayName": "Created At",
          "name": "createdAt",
          "type": "dateTime",
          "default": ""
        },
        {
          "displayName": "Updated At",
          "name": "updatedAt",
          "type": "dateTime",
          "default": ""
        },
        {
          "displayName": "Is Deleted",
          "name": "isDeleted",
          "type": "boolean",
          "default": false
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "payment"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create a new expense",
          "action": "Create an expense"
        },
        {
          "name": "Delete",
          "value": "delete",
          "description": "Delete an expense",
          "action": "Delete an expense"
        },
        {
          "name": "Get",
          "value": "get",
          "description": "Get data of an expense",
          "action": "Get an expense"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get data of many expenses",
          "action": "Get many expenses"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "expense"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Amount",
          "name": "amount",
          "type": "number",
          "default": 0
        },
        {
          "displayName": "Billable",
          "name": "billable",
          "type": "boolean",
          "default": false
        },
        {
          "displayName": "Client Name or ID",
          "name": "client",
          "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": "getClients"
          },
          "default": ""
        },
        {
          "displayName": "Custom Value 1",
          "name": "customValue1",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Custom Value 2",
          "name": "customValue2",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Category Name or ID",
          "name": "category",
          "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": "getExpenseCategories"
          },
          "default": ""
        },
        {
          "displayName": "Expense Date",
          "name": "expenseDate",
          "type": "dateTime",
          "default": ""
        },
        {
          "displayName": "Payment Date",
          "name": "paymentDate",
          "type": "dateTime",
          "default": ""
        },
        {
          "displayName": "Payment Type",
          "name": "paymentType",
          "type": "options",
          "options": [
            {
              "name": "ACH",
              "value": 5
            },
            {
              "name": "Alipay",
              "value": 28
            },
            {
              "name": "American Express",
              "value": 8
            },
            {
              "name": "Apply Credit",
              "value": 1
            },
            {
              "name": "Bank Transfer",
              "value": 2
            },
            {
              "name": "Bitcoin",
              "value": 32
            },
            {
              "name": "Carte Blanche",
              "value": 17
            },
            {
              "name": "Cash",
              "value": 3
            },
            {
              "name": "Check",
              "value": 16
            },
            {
              "name": "Credit Card Other",
              "value": 13
            },
            {
              "name": "Debit",
              "value": 4
            },
            {
              "name": "Diners Card",
              "value": 10
            },
            {
              "name": "Discover Card",
              "value": 9
            },
            {
              "name": "EuroCard",
              "value": 11
            },
            {
              "name": "GoCardless",
              "value": 31
            },
            {
              "name": "Google Wallet",
              "value": 15
            },
            {
              "name": "iZettle",
              "value": 24
            },
            {
              "name": "JCB",
              "value": 19
            },
            {
              "name": "Laser",
              "value": 20
            },
            {
              "name": "Maestro",
              "value": 21
            },
            {
              "name": "MasterCard",
              "value": 7
            },
            {
              "name": "Money Order",
              "value": 27
            },
            {
              "name": "Nova",
              "value": 12
            },
            {
              "name": "Paypal",
              "value": 14
            },
            {
              "name": "SEPA",
              "value": 30
            },
            {
              "name": "Sofort",
              "value": 29
            },
            {
              "name": "Solo",
              "value": 22
            },
            {
              "name": "Swich",
              "value": 23
            },
            {
              "name": "Swish",
              "value": 25
            },
            {
              "name": "UnionPay",
              "value": 18
            },
            {
              "name": "Venmo",
              "value": 26
            },
            {
              "name": "Visa Card",
              "value": 6
            }
          ],
          "default": 1
        },
        {
          "displayName": "Private Notes",
          "name": "privateNotes",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Public Notes",
          "name": "publicNotes",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Tax Name 1",
          "name": "taxName1",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Tax Name 2",
          "name": "taxName2",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Tax Rate 1",
          "name": "taxRate1",
          "type": "number",
          "default": 0
        },
        {
          "displayName": "Tax Rate 2",
          "name": "taxRate2",
          "type": "number",
          "default": 0
        },
        {
          "displayName": "Transaction Reference",
          "name": "transactionReference",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Vendor Name or ID",
          "name": "vendor",
          "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": "getVendors"
          },
          "default": ""
        }
      ],
      "displayOptions": {
        "show": {
          "apiVersion": [
            "v4"
          ],
          "operation": [
            "create"
          ],
          "resource": [
            "expense"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Amount",
          "name": "amount",
          "type": "number",
          "default": 0
        },
        {
          "displayName": "Billable",
          "name": "billable",
          "type": "boolean",
          "default": false
        },
        {
          "displayName": "Client Name or ID",
          "name": "client",
          "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": "getClients"
          },
          "default": ""
        },
        {
          "displayName": "Custom Value 1",
          "name": "customValue1",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Custom Value 2",
          "name": "customValue2",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Category Name or ID",
          "name": "category",
          "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": "getExpenseCategories"
          },
          "default": ""
        },
        {
          "displayName": "Expense Date",
          "name": "expenseDate",
          "type": "dateTime",
          "default": ""
        },
        {
          "displayName": "Payment Date",
          "name": "paymentDate",
          "type": "dateTime",
          "default": ""
        },
        {
          "displayName": "Payment Type",
          "name": "paymentType",
          "type": "options",
          "options": [
            {
              "name": "Bank Transfer",
              "value": 1
            },
            {
              "name": "Cash",
              "value": 2
            },
            {
              "name": "ACH",
              "value": 4
            },
            {
              "name": "Visa",
              "value": 5
            },
            {
              "name": "Mastercard",
              "value": 6
            },
            {
              "name": "American Express",
              "value": 7
            },
            {
              "name": "Discover",
              "value": 8
            },
            {
              "name": "Diners",
              "value": 9
            },
            {
              "name": "Eurocard",
              "value": 10
            },
            {
              "name": "Nova",
              "value": 11
            },
            {
              "name": "Credit Card Other",
              "value": 12
            },
            {
              "name": "PayPal",
              "value": 13
            },
            {
              "name": "Check",
              "value": 15
            },
            {
              "name": "Carte Blanche",
              "value": 16
            },
            {
              "name": "UnionPay",
              "value": 17
            },
            {
              "name": "JCB",
              "value": 18
            },
            {
              "name": "Laser",
              "value": 19
            },
            {
              "name": "Maestro",
              "value": 20
            },
            {
              "name": "Solo",
              "value": 21
            },
            {
              "name": "Switch",
              "value": 22
            },
            {
              "name": "Venmo",
              "value": 24
            },
            {
              "name": "Alipay",
              "value": 27
            },
            {
              "name": "Sofort",
              "value": 28
            },
            {
              "name": "SEPA",
              "value": 29
            },
            {
              "name": "GoCardless",
              "value": 30
            },
            {
              "name": "Crypto",
              "value": 31
            },
            {
              "name": "Credit",
              "value": 32
            },
            {
              "name": "Zelle",
              "value": 33
            },
            {
              "name": "Mollie Bank Transfer",
              "value": 34
            },
            {
              "name": "KBC",
              "value": 35
            },
            {
              "name": "Bancontact",
              "value": 36
            },
            {
              "name": "iDEAL",
              "value": 37
            },
            {
              "name": "Hosted Page",
              "value": 38
            },
            {
              "name": "Giropay",
              "value": 39
            },
            {
              "name": "Przelewy24",
              "value": 40
            },
            {
              "name": "EPS",
              "value": 41
            },
            {
              "name": "Direct Debit",
              "value": 42
            },
            {
              "name": "BECS",
              "value": 43
            },
            {
              "name": "ACSS",
              "value": 44
            },
            {
              "name": "Instant Bank Pay",
              "value": 45
            },
            {
              "name": "FPX",
              "value": 46
            },
            {
              "name": "Klarna",
              "value": 47
            },
            {
              "name": "Interac E-Transfer",
              "value": 48
            },
            {
              "name": "BACS",
              "value": 49
            },
            {
              "name": "Stripe Bank Transfer",
              "value": 50
            },
            {
              "name": "Cash App",
              "value": 51
            },
            {
              "name": "Pay Later",
              "value": 52
            }
          ],
          "default": 1
        },
        {
          "displayName": "Private Notes",
          "name": "privateNotes",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Public Notes",
          "name": "publicNotes",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Tax Name 1",
          "name": "taxName1",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Tax Name 2",
          "name": "taxName2",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Tax Rate 1",
          "name": "taxRate1",
          "type": "number",
          "default": 0
        },
        {
          "displayName": "Tax Rate 2",
          "name": "taxRate2",
          "type": "number",
          "default": 0
        },
        {
          "displayName": "Transaction Reference",
          "name": "transactionReference",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Vendor Name or ID",
          "name": "vendor",
          "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": "getVendors"
          },
          "default": ""
        }
      ],
      "displayOptions": {
        "show": {
          "apiVersion": [
            "v5"
          ],
          "operation": [
            "create"
          ],
          "resource": [
            "expense"
          ]
        }
      }
    },
    {
      "displayName": "Expense ID",
      "name": "expenseId",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "expense"
          ],
          "operation": [
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "Expense ID",
      "name": "expenseId",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "expense"
          ],
          "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": [
            "expense"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 50,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "expense"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 60
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create a new quote",
          "action": "Create a quote"
        },
        {
          "name": "Delete",
          "value": "delete",
          "description": "Delete a quote",
          "action": "Delete a quote"
        },
        {
          "name": "Email",
          "value": "email",
          "description": "Email a quote",
          "action": "Email a quote"
        },
        {
          "name": "Get",
          "value": "get",
          "description": "Get data of a quote",
          "action": "Get a quote"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get data of many quotes",
          "action": "Get many quotes"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "quote"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Client Name or ID",
          "name": "client",
          "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": "getClients"
          },
          "default": ""
        },
        {
          "displayName": "Auto Bill",
          "name": "autoBill",
          "type": "boolean",
          "default": false
        },
        {
          "displayName": "Custom Value 1",
          "name": "customValue1",
          "type": "number",
          "typeOptions": {
            "minValue": 0
          },
          "default": 0
        },
        {
          "displayName": "Custom Value 2",
          "name": "customValue2",
          "type": "number",
          "typeOptions": {
            "minValue": 0
          },
          "default": 0
        },
        {
          "displayName": "Discount",
          "name": "discount",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Due Date",
          "name": "dueDate",
          "type": "dateTime",
          "default": ""
        },
        {
          "displayName": "Email",
          "name": "email",
          "type": "string",
          "placeholder": "name@email.com",
          "default": ""
        },
        {
          "displayName": "Email Quote",
          "name": "emailQuote",
          "type": "boolean",
          "default": false
        },
        {
          "displayName": "Quote Date",
          "name": "quoteDate",
          "type": "dateTime",
          "default": ""
        },
        {
          "displayName": "Quote Number",
          "name": "quoteNumber",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Quote Status",
          "name": "quoteStatus",
          "type": "options",
          "options": [
            {
              "name": "Draft",
              "value": 1
            },
            {
              "name": "Sent",
              "value": 2
            }
          ],
          "default": 1
        },
        {
          "displayName": "Is Amount Discount",
          "name": "isAmountDiscount",
          "type": "boolean",
          "default": false
        },
        {
          "displayName": "Paid",
          "name": "paid",
          "type": "number",
          "default": 0
        },
        {
          "displayName": "Partial",
          "name": "partial",
          "type": "number",
          "default": 0
        },
        {
          "displayName": "Partial Due Date",
          "name": "partialDueDate",
          "type": "dateTime",
          "default": ""
        },
        {
          "displayName": "Po Number",
          "name": "poNumber",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Private Notes",
          "name": "privateNotes",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Public Notes",
          "name": "publicNotes",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Tax Name 1",
          "name": "taxName1",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Tax Name 2",
          "name": "taxName2",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Tax Rate 1",
          "name": "taxRate1",
          "type": "number",
          "default": 0
        },
        {
          "displayName": "Tax Rate 2",
          "name": "taxRate2",
          "type": "number",
          "default": 0
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "create"
          ],
          "resource": [
            "quote"
          ]
        }
      }
    },
    {
      "displayName": "Invoice Items",
      "name": "invoiceItemsUi",
      "type": "fixedCollection",
      "default": {},
      "options": [
        {
          "name": "invoiceItemsValues",
          "displayName": "Invoice Item",
          "values": [
            {
              "displayName": "Cost",
              "name": "cost",
              "type": "number",
              "default": 0
            },
            {
              "displayName": "Description",
              "name": "description",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "Service",
              "name": "service",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "Hours",
              "name": "hours",
              "type": "number",
              "typeOptions": {
                "minValue": 0
              },
              "default": 0
            },
            {
              "displayName": "Tax Name 1",
              "name": "taxName1",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "Tax Name 2",
              "name": "taxName2",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "Tax Rate 1",
              "name": "taxRate1",
              "type": "number",
              "default": 0
            },
            {
              "displayName": "Tax Rate 2",
              "name": "taxRate2",
              "type": "number",
              "default": 0
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "quote"
          ],
          "operation": [
            "create"
          ]
        }
      },
      "typeOptions": {
        "multipleValues": true
      }
    },
    {
      "displayName": "Quote ID",
      "name": "quoteId",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "quote"
          ],
          "operation": [
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "Quote ID",
      "name": "quoteId",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "quote"
          ],
          "operation": [
            "email"
          ]
        }
      }
    },
    {
      "displayName": "Quote ID",
      "name": "quoteId",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "quote"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Include",
          "name": "include",
          "type": "options",
          "options": [
            {
              "name": "Client",
              "value": "client"
            }
          ],
          "default": "client"
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "get"
          ],
          "resource": [
            "quote"
          ]
        }
      }
    },
    {
      "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": [
            "quote"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 50,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "quote"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 60
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Quote Number",
          "name": "quoteNumber",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Include",
          "name": "include",
          "type": "options",
          "options": [
            {
              "name": "Client",
              "value": "client"
            }
          ],
          "default": "client"
        },
        {
          "displayName": "Status",
          "name": "status",
          "type": "options",
          "options": [
            {
              "name": "Active",
              "value": "active"
            },
            {
              "name": "Archived",
              "value": "archived"
            },
            {
              "name": "Deleted",
              "value": "deleted"
            }
          ],
          "default": "active"
        },
        {
          "displayName": "Created At",
          "name": "createdAt",
          "type": "dateTime",
          "default": ""
        },
        {
          "displayName": "Updated At",
          "name": "updatedAt",
          "type": "dateTime",
          "default": ""
        },
        {
          "displayName": "Is Deleted",
          "name": "isDeleted",
          "type": "boolean",
          "default": false
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "quote"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create a new bank transaction",
          "action": "Create a bank transaction"
        },
        {
          "name": "Delete",
          "value": "delete",
          "description": "Delete a bank transaction",
          "action": "Delete a bank transaction"
        },
        {
          "name": "Get",
          "value": "get",
          "description": "Get data of a bank transaction",
          "action": "Get a bank transaction"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get data of many bank transactions",
          "action": "Get many bank transactions"
        },
        {
          "name": "Match Payment",
          "value": "matchPayment",
          "description": "Match payment to a bank transaction",
          "action": "Match payment to a bank transaction"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "bank_transaction"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Amount",
          "name": "amount",
          "type": "number",
          "default": 0
        },
        {
          "displayName": "Bank Integration Name or ID",
          "name": "bankIntegrationId",
          "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": "getBankIntegrations"
          },
          "default": ""
        },
        {
          "displayName": "Base Type",
          "name": "baseType",
          "type": "options",
          "options": [
            {
              "name": "Deposit",
              "value": "CREDIT"
            },
            {
              "name": "Withdrawal",
              "value": "DEBIT"
            }
          ],
          "default": ""
        },
        {
          "displayName": "Currency Name or ID",
          "name": "currencyId",
          "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": "getCurrencies"
          },
          "default": ""
        },
        {
          "displayName": "Date",
          "name": "date",
          "type": "dateTime",
          "default": ""
        },
        {
          "displayName": "Description",
          "name": "description",
          "type": "string",
          "default": ""
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "create"
          ],
          "resource": [
            "bank_transaction"
          ]
        }
      }
    },
    {
      "displayName": "Bank Transaction ID",
      "name": "bankTransactionId",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "bank_transaction"
          ],
          "operation": [
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "Bank Transaction ID",
      "name": "bankTransactionId",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "bank_transaction"
          ],
          "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": [
            "bank_transaction"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 50,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "bank_transaction"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 60
      }
    },
    {
      "displayName": "Bank Transaction ID",
      "name": "bankTransactionId",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "bank_transaction"
          ],
          "operation": [
            "matchPayment"
          ]
        }
      }
    },
    {
      "displayName": "Payment Name or ID",
      "name": "paymentId",
      "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": [
            "bank_transaction"
          ],
          "operation": [
            "matchPayment"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getPayments"
      }
    }
  ]

operations:
  [
    {
      "operation": "create",
      "name": "Create",
      "description": "Create a new client"
    },
    {
      "operation": "delete",
      "name": "Delete",
      "description": "Delete a client"
    },
    {
      "operation": "get",
      "name": "Get",
      "description": "Get data of a client"
    },
    {
      "operation": "getAll",
      "name": "Get Many",
      "description": "Get data of many clients"
    }
  ]


node_type: nodes-base.invoiceNinjaTrigger
package_name: n8n-nodes-base
display_name: Invoice Ninja Trigger
description: Starts the workflow when Invoice Ninja events occur
category: trigger
development_style: programmatic
version: 2
operations: []
credentials_required:
  [
  {
  "name": "invoiceNinjaApi",
  "required": true
  }
  ]

outputs:
  [
  "main"
  ]

updated_at: 2025-12-11 23:50:26
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: Invoice Ninja Trigger node documentation
  description: Learn how to use the Invoice Ninja Trigger node in n8n. Follow technical documentation to integrate Invoice Ninja Trigger node into your workflows.
  contentType: [integration, reference]
  ---

  # Invoice Ninja Trigger node

  [Invoice Ninja](https://www.invoiceninja.com/){:target=_blank .external-link} is a free open-source online invoicing app for freelancers & businesses. It offers invoicing, payments, expense tracking, & time-tasks.

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

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

properties_schema:
  [
    {
      "displayName": "API Version",
      "name": "apiVersion",
      "type": "options",
      "default": "v4",
      "options": [
        {
          "name": "Version 4",
          "value": "v4"
        },
        {
          "name": "Version 5",
          "value": "v5"
        }
      ],
      "displayOptions": {
        "show": {
          "@version": [
            1
          ]
        }
      }
    },
    {
      "displayName": "API Version",
      "name": "apiVersion",
      "type": "options",
      "default": "v5",
      "options": [
        {
          "name": "Version 4",
          "value": "v4"
        },
        {
          "name": "Version 5",
          "value": "v5"
        }
      ],
      "displayOptions": {
        "show": {
          "@version": [
            2
          ]
        }
      }
    },
    {
      "displayName": "Event",
      "name": "event",
      "type": "options",
      "default": "",
      "options": [
        {
          "name": "Client Created",
          "value": "create_client"
        },
        {
          "name": "Invoice Created",
          "value": "create_invoice"
        },
        {
          "name": "Payment Created",
          "value": "create_payment"
        },
        {
          "name": "Quote Created",
          "value": "create_quote"
        },
        {
          "name": "Vendor Created",
          "value": "create_vendor"
        }
      ],
      "required": true
    }
  ]


node_type: nodes-base.itemLists
package_name: n8n-nodes-base
display_name: Item Lists
description: Helper for working with lists of items and transforming arrays
category: input
development_style: programmatic
version: 3.1
credentials_required: []
outputs:
  [
  "main"
  ]

updated_at: 2025-12-11 23:50:26
properties_schema:
  [
    {
      "displayName": "Resource",
      "name": "resource",
      "type": "hidden",
      "default": "itemList",
      "options": [
        {
          "name": "Item List",
          "value": "itemList"
        }
      ]
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "splitOutItems",
      "options": [
        {
          "name": "Concatenate Items",
          "value": "concatenateItems",
          "description": "Combine fields into a list in a single new item",
          "action": "Concatenate Items"
        },
        {
          "name": "Limit",
          "value": "limit",
          "description": "Remove items if there are too many",
          "action": "Limit"
        },
        {
          "name": "Remove Duplicates",
          "value": "removeDuplicates",
          "description": "Remove extra items that are similar",
          "action": "Remove Duplicates"
        },
        {
          "name": "Sort",
          "value": "sort",
          "description": "Change the item order",
          "action": "Sort"
        },
        {
          "name": "Split Out Items",
          "value": "splitOutItems",
          "description": "Turn a list or values of object's properties inside item(s) into separate items",
          "action": "Split Out Items"
        },
        {
          "name": "Summarize",
          "value": "summarize",
          "description": "Aggregate items together (pivot table)",
          "action": "Summarize"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "itemList"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Aggregate",
      "name": "aggregate",
      "type": "options",
      "default": "aggregateIndividualFields",
      "options": [
        {
          "name": "Individual Fields",
          "value": "aggregateIndividualFields"
        },
        {
          "name": "All Item Data (Into a Single List)",
          "value": "aggregateAllItemData"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "itemList"
          ],
          "operation": [
            "concatenateItems"
          ]
        }
      }
    },
    {
      "displayName": "Fields To Aggregate",
      "name": "fieldsToAggregate",
      "type": "fixedCollection",
      "default": {
        "fieldToAggregate": [
          {
            "fieldToAggregate": "",
            "renameField": false
          }
        ]
      },
      "options": [
        {
          "displayName": "",
          "name": "fieldToAggregate",
          "values": [
            {
              "displayName": "Input Field Name",
              "name": "fieldToAggregate",
              "type": "string",
              "default": "",
              "description": "The name of a field in the input items to aggregate together",
              "placeholder": "e.g. id",
              "hint": " Enter the field name as text",
              "requiresDataPath": "single"
            },
            {
              "displayName": "Rename Field",
              "name": "renameField",
              "type": "boolean",
              "default": false,
              "description": "Whether to give the field a different name in the output"
            },
            {
              "displayName": "Output Field Name",
              "name": "outputFieldName",
              "displayOptions": {
                "show": {
                  "renameField": [
                    true
                  ]
                }
              },
              "type": "string",
              "default": "",
              "description": "The name of the field to put the aggregated data in. Leave blank to use the input field name.",
              "requiresDataPath": "single"
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "aggregate": [
            "aggregateIndividualFields"
          ],
          "resource": [
            "itemList"
          ],
          "operation": [
            "concatenateItems"
          ]
        }
      },
      "typeOptions": {
        "multipleValues": true
      }
    },
    {
      "displayName": "Put Output in Field",
      "name": "destinationFieldName",
      "type": "string",
      "default": "data",
      "description": "The name of the output field to put the data in",
      "displayOptions": {
        "show": {
          "aggregate": [
            "aggregateAllItemData"
          ],
          "resource": [
            "itemList"
          ],
          "operation": [
            "concatenateItems"
          ]
        }
      }
    },
    {
      "displayName": "Include",
      "name": "include",
      "type": "options",
      "default": "allFields",
      "options": [
        {
          "name": "All Fields",
          "value": "allFields"
        },
        {
          "name": "Specified Fields",
          "value": "specifiedFields"
        },
        {
          "name": "All Fields Except",
          "value": "allFieldsExcept"
        }
      ],
      "displayOptions": {
        "show": {
          "aggregate": [
            "aggregateAllItemData"
          ],
          "resource": [
            "itemList"
          ],
          "operation": [
            "concatenateItems"
          ]
        }
      }
    },
    {
      "displayName": "Fields To Exclude",
      "name": "fieldsToExclude",
      "type": "string",
      "default": "",
      "displayOptions": {
        "show": {
          "aggregate": [
            "aggregateAllItemData"
          ],
          "include": [
            "allFieldsExcept"
          ],
          "resource": [
            "itemList"
          ],
          "operation": [
            "concatenateItems"
          ]
        }
      }
    },
    {
      "displayName": "Fields To Include",
      "name": "fieldsToInclude",
      "type": "string",
      "default": "",
      "displayOptions": {
        "show": {
          "aggregate": [
            "aggregateAllItemData"
          ],
          "include": [
            "specifiedFields"
          ],
          "resource": [
            "itemList"
          ],
          "operation": [
            "concatenateItems"
          ]
        }
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Disable Dot Notation",
          "name": "disableDotNotation",
          "type": "boolean",
          "default": false,
          "description": "Whether to disallow referencing child fields using `parent.child` in the field name",
          "displayOptions": {
            "hide": {
              "/aggregate": [
                "aggregateAllItemData"
              ]
            }
          }
        },
        {
          "displayName": "Merge Lists",
          "name": "mergeLists",
          "type": "boolean",
          "default": false,
          "description": "Whether to merge the output into a single flat list (rather than a list of lists), if the field to aggregate is a list",
          "displayOptions": {
            "hide": {
              "/aggregate": [
                "aggregateAllItemData"
              ]
            }
          }
        },
        {
          "displayName": "Include Binaries",
          "name": "includeBinaries",
          "type": "boolean",
          "default": false,
          "description": "Whether to include the binary data in the new item"
        },
        {
          "displayName": "Keep Only Unique Binaries",
          "name": "keepOnlyUnique",
          "type": "boolean",
          "default": false,
          "description": "Whether to keep only unique binaries by comparing mime types, file types, file sizes and file extensions",
          "displayOptions": {
            "show": {
              "includeBinaries": [
                true
              ]
            }
          }
        },
        {
          "displayName": "Keep Missing And Null Values",
          "name": "keepMissing",
          "type": "boolean",
          "default": false,
          "description": "Whether to add a null entry to the aggregated list when there is a missing or null value",
          "displayOptions": {
            "hide": {
              "/aggregate": [
                "aggregateAllItemData"
              ]
            }
          }
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "itemList"
          ],
          "operation": [
            "concatenateItems"
          ]
        }
      }
    },
    {
      "displayName": "Max Items",
      "name": "maxItems",
      "type": "number",
      "default": 1,
      "description": "If there are more items than this number, some are removed",
      "displayOptions": {
        "show": {
          "resource": [
            "itemList"
          ],
          "operation": [
            "limit"
          ]
        }
      },
      "typeOptions": {
        "minValue": 1
      }
    },
    {
      "displayName": "Keep",
      "name": "keep",
      "type": "options",
      "default": "firstItems",
      "description": "When removing items, whether to keep the ones at the start or the ending",
      "options": [
        {
          "name": "First Items",
          "value": "firstItems"
        },
        {
          "name": "Last Items",
          "value": "lastItems"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "itemList"
          ],
          "operation": [
            "limit"
          ]
        }
      }
    },
    {
      "displayName": "Compare",
      "name": "compare",
      "type": "options",
      "default": "allFields",
      "description": "The fields of the input items to compare to see if they are the same",
      "options": [
        {
          "name": "All Fields",
          "value": "allFields"
        },
        {
          "name": "All Fields Except",
          "value": "allFieldsExcept"
        },
        {
          "name": "Selected Fields",
          "value": "selectedFields"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "itemList"
          ],
          "operation": [
            "removeDuplicates"
          ]
        }
      }
    },
    {
      "displayName": "Fields To Exclude",
      "name": "fieldsToExclude",
      "type": "string",
      "default": "",
      "description": "Fields in the input to exclude from the comparison",
      "displayOptions": {
        "show": {
          "compare": [
            "allFieldsExcept"
          ],
          "resource": [
            "itemList"
          ],
          "operation": [
            "removeDuplicates"
          ]
        }
      }
    },
    {
      "displayName": "Fields To Compare",
      "name": "fieldsToCompare",
      "type": "string",
      "default": "",
      "description": "Fields in the input to add to the comparison",
      "displayOptions": {
        "show": {
          "compare": [
            "selectedFields"
          ],
          "resource": [
            "itemList"
          ],
          "operation": [
            "removeDuplicates"
          ]
        }
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Disable Dot Notation",
          "name": "disableDotNotation",
          "type": "boolean",
          "default": false,
          "description": "Whether to disallow referencing child fields using `parent.child` in the field name"
        },
        {
          "displayName": "Remove Other Fields",
          "name": "removeOtherFields",
          "type": "boolean",
          "default": false,
          "description": "Whether to remove any fields that are not being compared. If disabled, will keep the values from the first of the duplicates."
        }
      ],
      "displayOptions": {
        "show": {
          "compare": [
            "allFieldsExcept",
            "selectedFields"
          ],
          "resource": [
            "itemList"
          ],
          "operation": [
            "removeDuplicates"
          ]
        }
      }
    },
    {
      "displayName": "Type",
      "name": "type",
      "type": "options",
      "default": "simple",
      "description": "The fields of the input items to compare to see if they are the same",
      "options": [
        {
          "name": "Simple",
          "value": "simple"
        },
        {
          "name": "Random",
          "value": "random"
        },
        {
          "name": "Code",
          "value": "code"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "itemList"
          ],
          "operation": [
            "sort"
          ]
        }
      }
    },
    {
      "displayName": "Fields To Sort By",
      "name": "sortFieldsUi",
      "type": "fixedCollection",
      "default": {},
      "description": "The fields of the input items to compare to see if they are the same",
      "options": [
        {
          "displayName": "",
          "name": "sortField",
          "values": [
            {
              "displayName": "Field Name",
              "name": "fieldName",
              "type": "string",
              "required": true,
              "default": "",
              "description": "The field to sort by",
              "placeholder": "e.g. id",
              "hint": " Enter the field name as text",
              "requiresDataPath": "single"
            },
            {
              "displayName": "Order",
              "name": "order",
              "type": "options",
              "options": [
                {
                  "name": "Ascending",
                  "value": "ascending"
                },
                {
                  "name": "Descending",
                  "value": "descending"
                }
              ],
              "default": "ascending",
              "description": "The order to sort by"
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "type": [
            "simple"
          ],
          "resource": [
            "itemList"
          ],
          "operation": [
            "sort"
          ]
        }
      },
      "typeOptions": {
        "multipleValues": true
      }
    },
    {
      "displayName": "Code",
      "name": "code",
      "type": "string",
      "default": "// The two items to compare are in the variables a and b\n// Access the fields in a.json and b.json\n// Return -1 if a should go before b\n// Return 1 if b should go before a\n// Return 0 if there's no difference\n\nfieldName = 'myField';\n\nif (a.json[fieldName] < b.json[fieldName]) {\nreturn -1;\n}\nif (a.json[fieldName] > b.json[fieldName]) {\nreturn 1;\n}\nreturn 0;",
      "description": "Javascript code to determine the order of any two items",
      "displayOptions": {
        "show": {
          "type": [
            "code"
          ],
          "resource": [
            "itemList"
          ],
          "operation": [
            "sort"
          ]
        }
      },
      "typeOptions": {
        "alwaysOpenEditWindow": true,
        "editor": "jsEditor",
        "rows": 10
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Disable Dot Notation",
          "name": "disableDotNotation",
          "type": "boolean",
          "default": false,
          "description": "Whether to disallow referencing child fields using `parent.child` in the field name"
        }
      ],
      "displayOptions": {
        "show": {
          "type": [
            "simple"
          ],
          "resource": [
            "itemList"
          ],
          "operation": [
            "sort"
          ]
        }
      }
    },
    {
      "displayName": "Fields To Split Out",
      "name": "fieldToSplitOut",
      "type": "string",
      "default": "",
      "description": "The name of the input fields to break out into separate items. Separate multiple field names by commas. For binary data, use $binary.",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "itemList"
          ],
          "operation": [
            "splitOutItems"
          ]
        }
      }
    },
    {
      "displayName": "Include",
      "name": "include",
      "type": "options",
      "default": "noOtherFields",
      "description": "Whether to copy any other fields into the new items",
      "options": [
        {
          "name": "No Other Fields",
          "value": "noOtherFields"
        },
        {
          "name": "All Other Fields",
          "value": "allOtherFields"
        },
        {
          "name": "Selected Other Fields",
          "value": "selectedOtherFields"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "itemList"
          ],
          "operation": [
            "splitOutItems"
          ]
        }
      }
    },
    {
      "displayName": "Fields To Include",
      "name": "fieldsToInclude",
      "type": "string",
      "default": "",
      "description": "Fields in the input items to aggregate together",
      "displayOptions": {
        "show": {
          "include": [
            "selectedOtherFields"
          ],
          "resource": [
            "itemList"
          ],
          "operation": [
            "splitOutItems"
          ]
        }
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Disable Dot Notation",
          "name": "disableDotNotation",
          "type": "boolean",
          "default": false,
          "description": "Whether to disallow referencing child fields using `parent.child` in the field name"
        },
        {
          "displayName": "Destination Field Name",
          "name": "destinationFieldName",
          "type": "string",
          "requiresDataPath": "multiple",
          "default": "",
          "description": "The field in the output under which to put the split field contents"
        },
        {
          "displayName": "Include Binary",
          "name": "includeBinary",
          "type": "boolean",
          "default": false,
          "description": "Whether to include the binary data in the new items"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "itemList"
          ],
          "operation": [
            "splitOutItems"
          ]
        }
      }
    },
    {
      "displayName": "Fields to Summarize",
      "name": "fieldsToSummarize",
      "type": "fixedCollection",
      "default": {
        "values": [
          {
            "aggregation": "count",
            "field": ""
          }
        ]
      },
      "options": [
        {
          "displayName": "",
          "name": "values",
          "values": [
            {
              "displayName": "Aggregation",
              "name": "aggregation",
              "type": "options",
              "options": [
                {
                  "name": "Append",
                  "value": "append"
                },
                {
                  "name": "Average",
                  "value": "average"
                },
                {
                  "name": "Concatenate",
                  "value": "concatenate"
                },
                {
                  "name": "Count",
                  "value": "count"
                },
                {
                  "name": "Count Unique",
                  "value": "countUnique"
                },
                {
                  "name": "Max",
                  "value": "max"
                },
                {
                  "name": "Min",
                  "value": "min"
                },
                {
                  "name": "Sum",
                  "value": "sum"
                }
              ],
              "default": "count",
              "description": "How to combine the values of the field you want to summarize"
            },
            {
              "displayName": "Field",
              "name": "field",
              "type": "string",
              "default": "",
              "description": "The name of an input field that you want to summarize",
              "placeholder": "e.g. cost",
              "hint": " Enter the field name as text",
              "displayOptions": {
                "hide": {
                  "aggregation": [
                    "average",
                    "sum",
                    "countUnique",
                    "count",
                    "max",
                    "min"
                  ]
                }
              },
              "requiresDataPath": "single"
            },
            {
              "displayName": "Field",
              "name": "field",
              "type": "string",
              "default": "",
              "description": "The name of an input field that you want to summarize. The field should contain numerical values; null, undefined, empty strings would be ignored.",
              "placeholder": "e.g. cost",
              "hint": " Enter the field name as text",
              "displayOptions": {
                "show": {
                  "aggregation": [
                    "average",
                    "sum"
                  ]
                }
              },
              "requiresDataPath": "single"
            },
            {
              "displayName": "Field",
              "name": "field",
              "type": "string",
              "default": "",
              "description": "The name of an input field that you want to summarize; null, undefined, empty strings would be ignored",
              "placeholder": "e.g. cost",
              "hint": " Enter the field name as text",
              "displayOptions": {
                "show": {
                  "aggregation": [
                    "countUnique",
                    "count",
                    "max",
                    "min"
                  ]
                }
              },
              "requiresDataPath": "single"
            },
            {
              "displayName": "Include Empty Values",
              "name": "includeEmpty",
              "type": "boolean",
              "default": false,
              "displayOptions": {
                "show": {
                  "aggregation": [
                    "append",
                    "concatenate"
                  ]
                }
              }
            },
            {
              "displayName": "Separator",
              "name": "separateBy",
              "type": "options",
              "default": ",",
              "options": [
                {
                  "name": "Comma",
                  "value": ","
                },
                {
                  "name": "Comma and Space",
                  "value": ", "
                },
                {
                  "name": "New Line",
                  "value": "\n"
                },
                {
                  "name": "None",
                  "value": ""
                },
                {
                  "name": "Space",
                  "value": " "
                },
                {
                  "name": "Other",
                  "value": "other"
                }
              ],
              "hint": "What to insert between values",
              "displayOptions": {
                "show": {
                  "aggregation": [
                    "concatenate"
                  ]
                }
              }
            },
            {
              "displayName": "Custom Separator",
              "name": "customSeparator",
              "type": "string",
              "default": "",
              "displayOptions": {
                "show": {
                  "aggregation": [
                    "concatenate"
                  ],
                  "separateBy": [
                    "other"
                  ]
                }
              }
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "itemList"
          ],
          "operation": [
            "summarize"
          ]
        }
      },
      "typeOptions": {
        "multipleValues": true
      }
    },
    {
      "displayName": "Fields to Split By",
      "name": "fieldsToSplitBy",
      "type": "string",
      "default": "",
      "description": "The name of the input fields that you want to split the summary by",
      "displayOptions": {
        "hide": {
          "/options.outputFormat": [
            "singleItem"
          ]
        },
        "show": {
          "resource": [
            "itemList"
          ],
          "operation": [
            "summarize"
          ]
        }
      }
    },
    {
      "displayName": "Fields to Group By",
      "name": "fieldsToSplitBy",
      "type": "string",
      "default": "",
      "description": "The name of the input fields that you want to split the summary by",
      "displayOptions": {
        "show": {
          "/options.outputFormat": [
            "singleItem"
          ],
          "resource": [
            "itemList"
          ],
          "operation": [
            "summarize"
          ]
        }
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Disable Dot Notation",
          "name": "disableDotNotation",
          "type": "boolean",
          "default": false,
          "description": "Whether to disallow referencing child fields using `parent.child` in the field name"
        },
        {
          "displayName": "Output Format",
          "name": "outputFormat",
          "type": "options",
          "default": "separateItems",
          "options": [
            {
              "name": "Each Split in a Separate Item",
              "value": "separateItems"
            },
            {
              "name": "All Splits in a Single Item",
              "value": "singleItem"
            }
          ]
        },
        {
          "displayName": "Ignore items without valid fields to group by",
          "name": "skipEmptySplitFields",
          "type": "boolean",
          "default": false
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "itemList"
          ],
          "operation": [
            "summarize"
          ]
        }
      }
    }
  ]

operations:
  [
    {
      "operation": "concatenateItems",
      "name": "Concatenate Items",
      "description": "Combine fields into a list in a single new item"
    },
    {
      "operation": "limit",
      "name": "Limit",
      "description": "Remove items if there are too many"
    },
    {
      "operation": "removeDuplicates",
      "name": "Remove Duplicates",
      "description": "Remove extra items that are similar"
    },
    {
      "operation": "sort",
      "name": "Sort",
      "description": "Change the item order"
    },
    {
      "operation": "splitOutItems",
      "name": "Split Out Items",
      "description": "Turn a list or values of object's properties inside item(s) into separate items"
    },
    {
      "operation": "summarize",
      "name": "Summarize",
      "description": "Aggregate items together (pivot table)"
    }
  ]


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

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

output_names:
  [
  "Tool"
  ]

updated_at: 2025-12-11 23:50:26
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: Iterable node documentation
  description: Learn how to use the Iterable node in n8n. Follow technical documentation to integrate Iterable node into your workflows.
  contentType: [integration, reference]
  ---

  # Iterable node

  Use the Iterable node to automate work in Iterable, and integrate Iterable with other applications. n8n has built-in support for a wide range of Iterable features, including creating users, recording the actions performed by the users, and adding and removing users from the list. 

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

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

  ## Operations

  * Event
      * Record the actions a user perform
  * User
      * Create/Update a user
      * Delete a user
      * Get a user
  * User List
      * Add user to list
      * Remove a user from a list

  ## Templates and examples

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

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 Iterable"
    },
    {
      "displayName": "Resource",
      "name": "resource",
      "type": "options",
      "default": "user",
      "options": [
        {
          "name": "Event",
          "value": "event"
        },
        {
          "name": "User",
          "value": "user"
        },
        {
          "name": "User List",
          "value": "userList"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "track",
      "options": [
        {
          "name": "Track",
          "value": "track",
          "description": "Record the actions a user perform",
          "action": "Track an event"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "event"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Name",
      "name": "name",
      "type": "string",
      "default": "",
      "description": "The name of the event to track",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "event"
          ],
          "operation": [
            "track"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Campaign ID",
          "name": "campaignId",
          "type": "string",
          "default": "",
          "description": "Campaign tied to conversion"
        },
        {
          "displayName": "Created At",
          "name": "createdAt",
          "type": "dateTime",
          "default": "",
          "description": "Time event happened"
        },
        {
          "displayName": "Data Fields",
          "name": "dataFieldsUi",
          "type": "fixedCollection",
          "default": {},
          "placeholder": "Add Data Field",
          "typeOptions": {
            "multipleValues": true
          },
          "options": [
            {
              "name": "dataFieldValues",
              "displayName": "Data Field",
              "values": [
                {
                  "displayName": "Key",
                  "name": "key",
                  "type": "string",
                  "default": "",
                  "description": "The end event specified key of the event defined data"
                },
                {
                  "displayName": "Value",
                  "name": "value",
                  "type": "string",
                  "default": "",
                  "description": "The end event specified value of the event defined data"
                }
              ]
            }
          ]
        },
        {
          "displayName": "Email",
          "name": "email",
          "type": "string",
          "placeholder": "name@email.com",
          "default": "",
          "description": "Either email or userId must be passed in to identify the user. If both are passed in, email takes precedence."
        },
        {
          "displayName": "ID",
          "name": "id",
          "type": "string",
          "default": "",
          "description": "Optional event ID. If an event exists with that ID, the event will be updated. If none is specified, a new ID will automatically be generated and returned."
        },
        {
          "displayName": "Template ID",
          "name": "templateId",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "User ID",
          "name": "userId",
          "type": "string",
          "default": "",
          "description": "userId that was passed into the updateUser call"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "event"
          ],
          "operation": [
            "track"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "upsert",
      "options": [
        {
          "name": "Create or Update",
          "value": "upsert",
          "description": "Create a new user, or update the current one if it already exists (upsert)",
          "action": "Create or update a user"
        },
        {
          "name": "Delete",
          "value": "delete",
          "description": "Delete a user",
          "action": "Delete a user"
        },
        {
          "name": "Get",
          "value": "get",
          "description": "Get a user",
          "action": "Get a user"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Identifier",
      "name": "identifier",
      "type": "options",
      "default": "",
      "description": "Identifier to be used",
      "options": [
        {
          "name": "Email",
          "value": "email"
        },
        {
          "name": "User ID",
          "value": "userId"
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "upsert"
          ]
        }
      }
    },
    {
      "displayName": "Value",
      "name": "value",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "upsert"
          ]
        }
      }
    },
    {
      "displayName": "Create If Doesn't Exist",
      "name": "preferUserId",
      "type": "boolean",
      "default": true,
      "description": "Whether to create a new user if the idetifier does not exist",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "upsert"
          ],
          "identifier": [
            "userId"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Data Fields",
          "name": "dataFieldsUi",
          "type": "fixedCollection",
          "default": {},
          "placeholder": "Add Data Field",
          "typeOptions": {
            "multipleValues": true
          },
          "options": [
            {
              "name": "dataFieldValues",
              "displayName": "Data Field",
              "values": [
                {
                  "displayName": "Key",
                  "name": "key",
                  "type": "string",
                  "default": "",
                  "description": "The end user specified key of the user defined data"
                },
                {
                  "displayName": "Value",
                  "name": "value",
                  "type": "string",
                  "default": "",
                  "description": "The end user specified value of the user defined data"
                }
              ]
            }
          ]
        },
        {
          "displayName": "Merge Nested Objects",
          "name": "mergeNestedObjects",
          "type": "boolean",
          "default": false,
          "description": "Whether to merge top level objects instead of overwriting (default: false), e.g. if user profile has data: {mySettings:{mobile:true}} and change contact field has data: {mySettings:{email:true}}, the resulting profile: {mySettings:{mobile:true,email:true}}"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "upsert"
          ]
        }
      }
    },
    {
      "displayName": "By",
      "name": "by",
      "type": "options",
      "default": "email",
      "description": "Identifier to be used",
      "options": [
        {
          "name": "Email",
          "value": "email"
        },
        {
          "name": "User ID",
          "value": "userId"
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "User ID",
      "name": "userId",
      "type": "string",
      "default": "",
      "description": "Unique identifier for a particular user",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "delete"
          ],
          "by": [
            "userId"
          ]
        }
      }
    },
    {
      "displayName": "Email",
      "name": "email",
      "type": "string",
      "default": "",
      "description": "Email for a particular user",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "delete"
          ],
          "by": [
            "email"
          ]
        }
      }
    },
    {
      "displayName": "By",
      "name": "by",
      "type": "options",
      "default": "email",
      "description": "Identifier to be used",
      "options": [
        {
          "name": "Email",
          "value": "email"
        },
        {
          "name": "User ID",
          "value": "userId"
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "User ID",
      "name": "userId",
      "type": "string",
      "default": "",
      "description": "Unique identifier for a particular user",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "get"
          ],
          "by": [
            "userId"
          ]
        }
      }
    },
    {
      "displayName": "Email",
      "name": "email",
      "type": "string",
      "default": "",
      "description": "Email for a particular user",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "get"
          ],
          "by": [
            "email"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "add",
      "options": [
        {
          "name": "Add",
          "value": "add",
          "description": "Add user to list",
          "action": "Add a user to a list"
        },
        {
          "name": "Remove",
          "value": "remove",
          "description": "Remove a user from a list",
          "action": "Remove a user from a list"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "userList"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "List Name or ID",
      "name": "listId",
      "type": "options",
      "default": "",
      "description": "Identifier to be used. 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": [
            "userList"
          ],
          "operation": [
            "add"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getLists"
      }
    },
    {
      "displayName": "Identifier",
      "name": "identifier",
      "type": "options",
      "default": "",
      "description": "Identifier to be used",
      "options": [
        {
          "name": "Email",
          "value": "email"
        },
        {
          "name": "User ID",
          "value": "userId"
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "userList"
          ],
          "operation": [
            "add"
          ]
        }
      }
    },
    {
      "displayName": "Value",
      "name": "value",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "userList"
          ],
          "operation": [
            "add"
          ]
        }
      }
    },
    {
      "displayName": "List Name or ID",
      "name": "listId",
      "type": "options",
      "default": "",
      "description": "Identifier to be used. 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": [
            "userList"
          ],
          "operation": [
            "remove"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getLists"
      }
    },
    {
      "displayName": "Identifier",
      "name": "identifier",
      "type": "options",
      "default": "",
      "description": "Identifier to be used",
      "options": [
        {
          "name": "Email",
          "value": "email"
        },
        {
          "name": "User ID",
          "value": "userId"
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "userList"
          ],
          "operation": [
            "remove"
          ]
        }
      }
    },
    {
      "displayName": "Value",
      "name": "value",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "userList"
          ],
          "operation": [
            "remove"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Campaign ID",
          "name": "campaignId",
          "type": "number",
          "default": 0,
          "description": "Attribute unsubscribe to a campaign"
        },
        {
          "displayName": "Channel Unsubscribe",
          "name": "channelUnsubscribe",
          "type": "boolean",
          "default": false,
          "description": "Whether to unsubscribe email from list's associated channel - essentially a global unsubscribe"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "userList"
          ],
          "operation": [
            "remove"
          ]
        }
      }
    }
  ]

operations:
  [
    {
      "operation": "track",
      "name": "Track",
      "description": "Record the actions a user perform"
    }
  ]


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

outputs:
  [
  "main"
  ]

updated_at: 2025-12-11 23:50:26
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: Iterable node documentation
  description: Learn how to use the Iterable node in n8n. Follow technical documentation to integrate Iterable node into your workflows.
  contentType: [integration, reference]
  ---

  # Iterable node

  Use the Iterable node to automate work in Iterable, and integrate Iterable with other applications. n8n has built-in support for a wide range of Iterable features, including creating users, recording the actions performed by the users, and adding and removing users from the list. 

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

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

  ## Operations

  * Event
      * Record the actions a user perform
  * User
      * Create/Update a user
      * Delete a user
      * Get a user
  * User List
      * Add user to list
      * Remove a user from a list

  ## Templates and examples

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

properties_schema:
  [
    {
      "displayName": "Resource",
      "name": "resource",
      "type": "options",
      "default": "user",
      "options": [
        {
          "name": "Event",
          "value": "event"
        },
        {
          "name": "User",
          "value": "user"
        },
        {
          "name": "User List",
          "value": "userList"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "track",
      "options": [
        {
          "name": "Track",
          "value": "track",
          "description": "Record the actions a user perform",
          "action": "Track an event"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "event"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Name",
      "name": "name",
      "type": "string",
      "default": "",
      "description": "The name of the event to track",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "event"
          ],
          "operation": [
            "track"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Campaign ID",
          "name": "campaignId",
          "type": "string",
          "default": "",
          "description": "Campaign tied to conversion"
        },
        {
          "displayName": "Created At",
          "name": "createdAt",
          "type": "dateTime",
          "default": "",
          "description": "Time event happened"
        },
        {
          "displayName": "Data Fields",
          "name": "dataFieldsUi",
          "type": "fixedCollection",
          "default": {},
          "placeholder": "Add Data Field",
          "typeOptions": {
            "multipleValues": true
          },
          "options": [
            {
              "name": "dataFieldValues",
              "displayName": "Data Field",
              "values": [
                {
                  "displayName": "Key",
                  "name": "key",
                  "type": "string",
                  "default": "",
                  "description": "The end event specified key of the event defined data"
                },
                {
                  "displayName": "Value",
                  "name": "value",
                  "type": "string",
                  "default": "",
                  "description": "The end event specified value of the event defined data"
                }
              ]
            }
          ]
        },
        {
          "displayName": "Email",
          "name": "email",
          "type": "string",
          "placeholder": "name@email.com",
          "default": "",
          "description": "Either email or userId must be passed in to identify the user. If both are passed in, email takes precedence."
        },
        {
          "displayName": "ID",
          "name": "id",
          "type": "string",
          "default": "",
          "description": "Optional event ID. If an event exists with that ID, the event will be updated. If none is specified, a new ID will automatically be generated and returned."
        },
        {
          "displayName": "Template ID",
          "name": "templateId",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "User ID",
          "name": "userId",
          "type": "string",
          "default": "",
          "description": "userId that was passed into the updateUser call"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "event"
          ],
          "operation": [
            "track"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "upsert",
      "options": [
        {
          "name": "Create or Update",
          "value": "upsert",
          "description": "Create a new user, or update the current one if it already exists (upsert)",
          "action": "Create or update a user"
        },
        {
          "name": "Delete",
          "value": "delete",
          "description": "Delete a user",
          "action": "Delete a user"
        },
        {
          "name": "Get",
          "value": "get",
          "description": "Get a user",
          "action": "Get a user"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Identifier",
      "name": "identifier",
      "type": "options",
      "default": "",
      "description": "Identifier to be used",
      "options": [
        {
          "name": "Email",
          "value": "email"
        },
        {
          "name": "User ID",
          "value": "userId"
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "upsert"
          ]
        }
      }
    },
    {
      "displayName": "Value",
      "name": "value",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "upsert"
          ]
        }
      }
    },
    {
      "displayName": "Create If Doesn't Exist",
      "name": "preferUserId",
      "type": "boolean",
      "default": true,
      "description": "Whether to create a new user if the idetifier does not exist",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "upsert"
          ],
          "identifier": [
            "userId"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Data Fields",
          "name": "dataFieldsUi",
          "type": "fixedCollection",
          "default": {},
          "placeholder": "Add Data Field",
          "typeOptions": {
            "multipleValues": true
          },
          "options": [
            {
              "name": "dataFieldValues",
              "displayName": "Data Field",
              "values": [
                {
                  "displayName": "Key",
                  "name": "key",
                  "type": "string",
                  "default": "",
                  "description": "The end user specified key of the user defined data"
                },
                {
                  "displayName": "Value",
                  "name": "value",
                  "type": "string",
                  "default": "",
                  "description": "The end user specified value of the user defined data"
                }
              ]
            }
          ]
        },
        {
          "displayName": "Merge Nested Objects",
          "name": "mergeNestedObjects",
          "type": "boolean",
          "default": false,
          "description": "Whether to merge top level objects instead of overwriting (default: false), e.g. if user profile has data: {mySettings:{mobile:true}} and change contact field has data: {mySettings:{email:true}}, the resulting profile: {mySettings:{mobile:true,email:true}}"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "upsert"
          ]
        }
      }
    },
    {
      "displayName": "By",
      "name": "by",
      "type": "options",
      "default": "email",
      "description": "Identifier to be used",
      "options": [
        {
          "name": "Email",
          "value": "email"
        },
        {
          "name": "User ID",
          "value": "userId"
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "User ID",
      "name": "userId",
      "type": "string",
      "default": "",
      "description": "Unique identifier for a particular user",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "delete"
          ],
          "by": [
            "userId"
          ]
        }
      }
    },
    {
      "displayName": "Email",
      "name": "email",
      "type": "string",
      "default": "",
      "description": "Email for a particular user",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "delete"
          ],
          "by": [
            "email"
          ]
        }
      }
    },
    {
      "displayName": "By",
      "name": "by",
      "type": "options",
      "default": "email",
      "description": "Identifier to be used",
      "options": [
        {
          "name": "Email",
          "value": "email"
        },
        {
          "name": "User ID",
          "value": "userId"
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "User ID",
      "name": "userId",
      "type": "string",
      "default": "",
      "description": "Unique identifier for a particular user",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "get"
          ],
          "by": [
            "userId"
          ]
        }
      }
    },
    {
      "displayName": "Email",
      "name": "email",
      "type": "string",
      "default": "",
      "description": "Email for a particular user",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "get"
          ],
          "by": [
            "email"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "add",
      "options": [
        {
          "name": "Add",
          "value": "add",
          "description": "Add user to list",
          "action": "Add a user to a list"
        },
        {
          "name": "Remove",
          "value": "remove",
          "description": "Remove a user from a list",
          "action": "Remove a user from a list"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "userList"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "List Name or ID",
      "name": "listId",
      "type": "options",
      "default": "",
      "description": "Identifier to be used. 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": [
            "userList"
          ],
          "operation": [
            "add"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getLists"
      }
    },
    {
      "displayName": "Identifier",
      "name": "identifier",
      "type": "options",
      "default": "",
      "description": "Identifier to be used",
      "options": [
        {
          "name": "Email",
          "value": "email"
        },
        {
          "name": "User ID",
          "value": "userId"
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "userList"
          ],
          "operation": [
            "add"
          ]
        }
      }
    },
    {
      "displayName": "Value",
      "name": "value",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "userList"
          ],
          "operation": [
            "add"
          ]
        }
      }
    },
    {
      "displayName": "List Name or ID",
      "name": "listId",
      "type": "options",
      "default": "",
      "description": "Identifier to be used. 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": [
            "userList"
          ],
          "operation": [
            "remove"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getLists"
      }
    },
    {
      "displayName": "Identifier",
      "name": "identifier",
      "type": "options",
      "default": "",
      "description": "Identifier to be used",
      "options": [
        {
          "name": "Email",
          "value": "email"
        },
        {
          "name": "User ID",
          "value": "userId"
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "userList"
          ],
          "operation": [
            "remove"
          ]
        }
      }
    },
    {
      "displayName": "Value",
      "name": "value",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "userList"
          ],
          "operation": [
            "remove"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Campaign ID",
          "name": "campaignId",
          "type": "number",
          "default": 0,
          "description": "Attribute unsubscribe to a campaign"
        },
        {
          "displayName": "Channel Unsubscribe",
          "name": "channelUnsubscribe",
          "type": "boolean",
          "default": false,
          "description": "Whether to unsubscribe email from list's associated channel - essentially a global unsubscribe"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "userList"
          ],
          "operation": [
            "remove"
          ]
        }
      }
    }
  ]

operations:
  [
    {
      "operation": "track",
      "name": "Track",
      "description": "Record the actions a user perform"
    }
  ]


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

output_names:
  [
  "Tool"
  ]

updated_at: 2025-12-11 23:50:26
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: Jenkins node documentation
  description: Learn how to use the Jenkins node in n8n. Follow technical documentation to integrate Jenkins node into your workflows.
  contentType: [integration, reference]
  ---

  # Jenkins node

  Use the Jenkins node to automate work in Jenkins, and integrate Jenkins with other applications. n8n has built-in support for a wide range of Jenkins features, including listing builds, managing instances, and creating and copying jobs. 

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

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

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

  ## Operations

  * Build
      * List Builds
  * Instance
      * Cancel quiet down state
      * Put Jenkins in quiet mode, no builds can be started, Jenkins is ready for shutdown
      * Restart Jenkins immediately on environments where it's possible
      * Restart Jenkins once no jobs are running on environments where it's possible
      * Shutdown once no jobs are running
      * Shutdown Jenkins immediately
  * Job
      * Copy a specific job
      * Create a new job
      * Trigger a specific job
      * Trigger a specific job

  ## Templates and examples

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

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 Jenkins"
    },
    {
      "displayName": "Resource",
      "name": "resource",
      "type": "options",
      "default": "job",
      "options": [
        {
          "name": "Build",
          "value": "build"
        },
        {
          "name": "Instance",
          "value": "instance"
        },
        {
          "name": "Job",
          "value": "job"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "trigger",
      "description": "Possible operations",
      "options": [
        {
          "name": "Copy",
          "value": "copy",
          "description": "Copy a specific job",
          "action": "Copy a job"
        },
        {
          "name": "Create",
          "value": "create",
          "description": "Create a new job",
          "action": "Create a job"
        },
        {
          "name": "Trigger",
          "value": "trigger",
          "description": "Trigger a specific job",
          "action": "Trigger a job"
        },
        {
          "name": "Trigger with Parameters",
          "value": "triggerParams",
          "description": "Trigger a specific job",
          "action": "Trigger a job with parameters"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "job"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Make sure the job is setup to support triggering with parameters. <a href=\"https://wiki.jenkins.io/display/JENKINS/Parameterized+Build\" target=\"_blank\">More info</a>",
      "name": "triggerParamsNotice",
      "type": "notice",
      "default": "",
      "displayOptions": {
        "show": {
          "resource": [
            "job"
          ],
          "operation": [
            "triggerParams"
          ]
        }
      }
    },
    {
      "displayName": "Job Name or ID",
      "name": "job",
      "type": "options",
      "default": "",
      "description": "Name of the job. 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": [
            "job"
          ],
          "operation": [
            "trigger",
            "triggerParams",
            "copy"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getJobs"
      }
    },
    {
      "displayName": "Parameters",
      "name": "param",
      "type": "fixedCollection",
      "default": {},
      "description": "Parameters for Jenkins job",
      "options": [
        {
          "name": "params",
          "displayName": "Parameters",
          "values": [
            {
              "displayName": "Name or ID",
              "name": "name",
              "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": "getJobParameters",
                "loadOptionsDependsOn": [
                  "job"
                ]
              },
              "default": ""
            },
            {
              "displayName": "Value",
              "name": "value",
              "type": "string",
              "default": ""
            }
          ]
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "job"
          ],
          "operation": [
            "triggerParams"
          ]
        }
      },
      "typeOptions": {
        "multipleValues": true
      }
    },
    {
      "displayName": "New Job Name",
      "name": "newJob",
      "type": "string",
      "default": "",
      "description": "Name of the new Jenkins job",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "job"
          ],
          "operation": [
            "copy",
            "create"
          ]
        }
      }
    },
    {
      "displayName": "XML",
      "name": "xml",
      "type": "string",
      "default": "",
      "description": "XML of Jenkins config",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "job"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "To get the XML of an existing job, add ‘config.xml’ to the end of the job URL",
      "name": "createNotice",
      "type": "notice",
      "default": "",
      "displayOptions": {
        "show": {
          "resource": [
            "job"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "safeRestart",
      "description": "Jenkins instance operations",
      "options": [
        {
          "name": "Cancel Quiet Down",
          "value": "cancelQuietDown",
          "description": "Cancel quiet down state",
          "action": "Cancel Quiet Down an instance"
        },
        {
          "name": "Quiet Down",
          "value": "quietDown",
          "description": "Put Jenkins in quiet mode, no builds can be started, Jenkins is ready for shutdown",
          "action": "Quiet Down an instance"
        },
        {
          "name": "Restart",
          "value": "restart",
          "description": "Restart Jenkins immediately on environments where it is possible",
          "action": "Restart an instance"
        },
        {
          "name": "Safely Restart",
          "value": "safeRestart",
          "description": "Restart Jenkins once no jobs are running on environments where it is possible",
          "action": "Safely Restart an instance"
        },
        {
          "name": "Safely Shutdown",
          "value": "safeExit",
          "description": "Shutdown once no jobs are running",
          "action": "Safely Shutdown an instance"
        },
        {
          "name": "Shutdown",
          "value": "exit",
          "description": "Shutdown Jenkins immediately",
          "action": "Shutdown an instance"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "instance"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Reason",
      "name": "reason",
      "type": "string",
      "default": "",
      "description": "Freeform reason for quiet down mode",
      "displayOptions": {
        "show": {
          "resource": [
            "instance"
          ],
          "operation": [
            "quietDown"
          ]
        }
      }
    },
    {
      "displayName": "Instance operation can shutdown Jenkins instance and make it unresponsive. Some commands may not be available depending on instance implementation.",
      "name": "instanceNotice",
      "type": "notice",
      "default": "",
      "displayOptions": {
        "show": {
          "resource": [
            "instance"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "getAll",
      "options": [
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "List Builds",
          "action": "Get many builds"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "build"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Job Name or ID",
      "name": "job",
      "type": "options",
      "default": "",
      "description": "Name of the job. 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": [
            "build"
          ],
          "operation": [
            "getAll"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getJobs"
      }
    },
    {
      "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": [
            "build"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 50,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "build"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1
      }
    }
  ]

operations:
  [
    {
      "operation": "copy",
      "name": "Copy",
      "description": "Copy a specific job"
    },
    {
      "operation": "create",
      "name": "Create",
      "description": "Create a new job"
    },
    {
      "operation": "trigger",
      "name": "Trigger",
      "description": "Trigger a specific job"
    },
    {
      "operation": "triggerParams",
      "name": "Trigger with Parameters",
      "description": "Trigger a specific job"
    }
  ]

credentials_required:
  [
    {
      "name": "jenkinsApi",
      "required": true,
      "testedBy": "jenkinApiCredentialTest"
    }
  ]


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

updated_at: 2025-12-11 23:50:26
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: Jenkins node documentation
  description: Learn how to use the Jenkins node in n8n. Follow technical documentation to integrate Jenkins node into your workflows.
  contentType: [integration, reference]
  ---

  # Jenkins node

  Use the Jenkins node to automate work in Jenkins, and integrate Jenkins with other applications. n8n has built-in support for a wide range of Jenkins features, including listing builds, managing instances, and creating and copying jobs. 

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

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

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

  ## Operations

  * Build
      * List Builds
  * Instance
      * Cancel quiet down state
      * Put Jenkins in quiet mode, no builds can be started, Jenkins is ready for shutdown
      * Restart Jenkins immediately on environments where it's possible
      * Restart Jenkins once no jobs are running on environments where it's possible
      * Shutdown once no jobs are running
      * Shutdown Jenkins immediately
  * Job
      * Copy a specific job
      * Create a new job
      * Trigger a specific job
      * Trigger a specific job

  ## Templates and examples

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

properties_schema:
  [
    {
      "displayName": "Resource",
      "name": "resource",
      "type": "options",
      "default": "job",
      "options": [
        {
          "name": "Build",
          "value": "build"
        },
        {
          "name": "Instance",
          "value": "instance"
        },
        {
          "name": "Job",
          "value": "job"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "trigger",
      "description": "Possible operations",
      "options": [
        {
          "name": "Copy",
          "value": "copy",
          "description": "Copy a specific job",
          "action": "Copy a job"
        },
        {
          "name": "Create",
          "value": "create",
          "description": "Create a new job",
          "action": "Create a job"
        },
        {
          "name": "Trigger",
          "value": "trigger",
          "description": "Trigger a specific job",
          "action": "Trigger a job"
        },
        {
          "name": "Trigger with Parameters",
          "value": "triggerParams",
          "description": "Trigger a specific job",
          "action": "Trigger a job with parameters"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "job"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Make sure the job is setup to support triggering with parameters. <a href=\"https://wiki.jenkins.io/display/JENKINS/Parameterized+Build\" target=\"_blank\">More info</a>",
      "name": "triggerParamsNotice",
      "type": "notice",
      "default": "",
      "displayOptions": {
        "show": {
          "resource": [
            "job"
          ],
          "operation": [
            "triggerParams"
          ]
        }
      }
    },
    {
      "displayName": "Job Name or ID",
      "name": "job",
      "type": "options",
      "default": "",
      "description": "Name of the job. 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": [
            "job"
          ],
          "operation": [
            "trigger",
            "triggerParams",
            "copy"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getJobs"
      }
    },
    {
      "displayName": "Parameters",
      "name": "param",
      "type": "fixedCollection",
      "default": {},
      "description": "Parameters for Jenkins job",
      "options": [
        {
          "name": "params",
          "displayName": "Parameters",
          "values": [
            {
              "displayName": "Name or ID",
              "name": "name",
              "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": "getJobParameters",
                "loadOptionsDependsOn": [
                  "job"
                ]
              },
              "default": ""
            },
            {
              "displayName": "Value",
              "name": "value",
              "type": "string",
              "default": ""
            }
          ]
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "job"
          ],
          "operation": [
            "triggerParams"
          ]
        }
      },
      "typeOptions": {
        "multipleValues": true
      }
    },
    {
      "displayName": "New Job Name",
      "name": "newJob",
      "type": "string",
      "default": "",
      "description": "Name of the new Jenkins job",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "job"
          ],
          "operation": [
            "copy",
            "create"
          ]
        }
      }
    },
    {
      "displayName": "XML",
      "name": "xml",
      "type": "string",
      "default": "",
      "description": "XML of Jenkins config",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "job"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "To get the XML of an existing job, add ‘config.xml’ to the end of the job URL",
      "name": "createNotice",
      "type": "notice",
      "default": "",
      "displayOptions": {
        "show": {
          "resource": [
            "job"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "safeRestart",
      "description": "Jenkins instance operations",
      "options": [
        {
          "name": "Cancel Quiet Down",
          "value": "cancelQuietDown",
          "description": "Cancel quiet down state",
          "action": "Cancel Quiet Down an instance"
        },
        {
          "name": "Quiet Down",
          "value": "quietDown",
          "description": "Put Jenkins in quiet mode, no builds can be started, Jenkins is ready for shutdown",
          "action": "Quiet Down an instance"
        },
        {
          "name": "Restart",
          "value": "restart",
          "description": "Restart Jenkins immediately on environments where it is possible",
          "action": "Restart an instance"
        },
        {
          "name": "Safely Restart",
          "value": "safeRestart",
          "description": "Restart Jenkins once no jobs are running on environments where it is possible",
          "action": "Safely Restart an instance"
        },
        {
          "name": "Safely Shutdown",
          "value": "safeExit",
          "description": "Shutdown once no jobs are running",
          "action": "Safely Shutdown an instance"
        },
        {
          "name": "Shutdown",
          "value": "exit",
          "description": "Shutdown Jenkins immediately",
          "action": "Shutdown an instance"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "instance"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Reason",
      "name": "reason",
      "type": "string",
      "default": "",
      "description": "Freeform reason for quiet down mode",
      "displayOptions": {
        "show": {
          "resource": [
            "instance"
          ],
          "operation": [
            "quietDown"
          ]
        }
      }
    },
    {
      "displayName": "Instance operation can shutdown Jenkins instance and make it unresponsive. Some commands may not be available depending on instance implementation.",
      "name": "instanceNotice",
      "type": "notice",
      "default": "",
      "displayOptions": {
        "show": {
          "resource": [
            "instance"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "getAll",
      "options": [
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "List Builds",
          "action": "Get many builds"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "build"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Job Name or ID",
      "name": "job",
      "type": "options",
      "default": "",
      "description": "Name of the job. 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": [
            "build"
          ],
          "operation": [
            "getAll"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getJobs"
      }
    },
    {
      "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": [
            "build"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 50,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "build"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1
      }
    }
  ]

operations:
  [
    {
      "operation": "copy",
      "name": "Copy",
      "description": "Copy a specific job"
    },
    {
      "operation": "create",
      "name": "Create",
      "description": "Create a new job"
    },
    {
      "operation": "trigger",
      "name": "Trigger",
      "description": "Trigger a specific job"
    },
    {
      "operation": "triggerParams",
      "name": "Trigger with Parameters",
      "description": "Trigger a specific job"
    }
  ]

credentials_required:
  [
    {
      "name": "jenkinsApi",
      "required": true,
      "testedBy": "jenkinApiCredentialTest"
    }
  ]


node_type: nodes-base.jinaAiTool
package_name: n8n-nodes-base
display_name: Jina AI Tool
description: Interact with Jina AI API (AI Tool variant for use with AI Agents)
category: transform
development_style: programmatic
tool_variant_of: nodes-base.jinaAi
version: 1
credentials_required:
  [
  {
  "name": "jinaAiApi",
  "required": true
  }
  ]

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

output_names:
  [
  "Tool"
  ]

updated_at: 2025-12-11 23:50:26
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: Jina AI node documentation
  description: Learn how to use the Jina AI node in n8n. Follow technical documentation to integrate Jina AI node into your workflows.
  contentType: [integration, reference]
  ---

  # Jina AI node

  Use the Jina AI node to automate work in Jina AI and integrate Jina AI with other applications. n8n has built-in support for a wide range of Jina AI features.

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

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


  ## Operations

  * **Reader**:
  	* **Read**: Fetches content from a URL and converts it to clean, LLM-friendly formats.
  	* **Search**: Performs a web search using Jina AI and returns the top results as clean, LLM-friendly formats.
  * **Research**:
  	* **Deep Research**: Research a topic and generate a structured research report.

  ## Templates and examples

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

  ## Related resources

  Refer to [Jina AI's reader API documentation](https://r.jina.ai/docs) and [Jina AI's search API documentation](https://s.jina.ai/docs) for more information about the service.

  --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 Jina AI"
    },
    {
      "displayName": "Resource",
      "name": "resource",
      "type": "options",
      "default": "reader",
      "options": [
        {
          "name": "Reader",
          "value": "reader"
        },
        {
          "name": "Research",
          "value": "research"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "read",
      "options": [
        {
          "name": "Read",
          "value": "read",
          "action": "Read URL content",
          "description": "Fetches content from a URL and converts it to clean, LLM-friendly formats",
          "routing": {
            "request": {
              "method": "GET",
              "url": "=https://r.jina.ai/{{ $parameter[\"url\"] }}",
              "headers": {
                "X-Return-Format": "={{ $parameter[\"options\"][\"outputFormat\"] }}",
                "X-Target-Selector": "={{ $parameter[\"options\"][\"targetSelector\"] }}",
                "X-Remove-Selector": "={{ $parameter[\"options\"][\"excludeSelector\"] }}",
                "X-With-Generated-Alt": "={{ $parameter[\"options\"][\"enableImageCaptioning\"] }}",
                "X-Wait-For-Selector": "={{ $parameter[\"options\"][\"waitForSelector\"] }}"
              }
            },
            "output": {
              "postReceive": [
                {
                  "type": "rootProperty",
                  "enabled": "={{ $parameter[\"simplify\"] }}",
                  "properties": {
                    "property": "data"
                  }
                }
              ]
            }
          }
        },
        {
          "name": "Search",
          "value": "search",
          "action": "Search web",
          "description": "Performs a web search via Jina AI and returns top results as clean, LLM-friendly formats",
          "routing": {
            "request": {
              "method": "GET",
              "url": "https://s.jina.ai/",
              "headers": {
                "X-Return-Format": "={{ $parameter[\"options\"][\"outputFormat\"] }}",
                "X-Site": "={{ $parameter[\"options\"][\"siteFilter\"] }}"
              },
              "qs": {
                "q": "={{ $parameter[\"searchQuery\"] }}",
                "page": "={{ $parameter[\"options\"][\"pageNumber\"] }}"
              }
            },
            "output": {
              "postReceive": [
                {
                  "type": "rootProperty",
                  "enabled": "={{ $parameter[\"simplify\"] }}",
                  "properties": {
                    "property": "data"
                  }
                }
              ]
            }
          }
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "reader"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "deepResearch",
      "options": [
        {
          "name": "Deep Research",
          "value": "deepResearch",
          "action": "Perform deep research",
          "description": "Research a topic and generate a structured research report",
          "routing": {
            "request": {
              "method": "POST",
              "url": "https://deepsearch.jina.ai/v1/chat/completions",
              "body": {
                "messages": [
                  {
                    "role": "user",
                    "content": "={{ $parameter[\"researchQuery\"] }}"
                  }
                ],
                "max_returned_urls": "={{ $parameter[\"options\"][\"maxReturnedSources\"] }}",
                "boost_hostnames": "={{ $parameter[\"options\"][\"prioritizeSources\"].split(/,\\s*/) }}",
                "bad_hostnames": "={{ $parameter[\"options\"][\"excludeSources\"].split(/,\\s*/) }}",
                "only_hostnames": "={{ $parameter[\"options\"][\"siteFilter\"].split(/,\\s*/) }}"
              }
            },
            "output": {
              "postReceive": [
                {
                  "type": "setKeyValue",
                  "enabled": "={{ $parameter[\"simplify\"] }}",
                  "properties": {
                    "content": "={{ $responseItem[\"choices\"][0][\"message\"][\"content\"] }}",
                    "annotations": "={{ $responseItem[\"choices\"][0][\"message\"][\"annotations\"] }}",
                    "usage": "={{ $responseItem[\"usage\"] }}"
                  }
                }
              ]
            }
          }
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "research"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "URL",
      "name": "url",
      "type": "string",
      "default": "",
      "description": "The URL to fetch content from",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "reader"
          ],
          "operation": [
            "read"
          ]
        }
      }
    },
    {
      "displayName": "Simplify",
      "name": "simplify",
      "type": "boolean",
      "default": true,
      "description": "Whether to return a simplified version of the response instead of the raw data",
      "displayOptions": {
        "show": {
          "resource": [
            "reader"
          ],
          "operation": [
            "read"
          ]
        }
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Output Format",
          "name": "outputFormat",
          "description": "Specify desired output format",
          "type": "options",
          "options": [
            {
              "name": "HTML",
              "value": "html"
            },
            {
              "name": "JSON",
              "value": ""
            },
            {
              "name": "Markdown",
              "value": "markdown"
            },
            {
              "name": "Screenshot",
              "value": "screenshot"
            },
            {
              "name": "Text",
              "value": "text"
            }
          ],
          "default": ""
        },
        {
          "displayName": "Target CSS Selector",
          "name": "targetSelector",
          "type": "string",
          "description": "CSS selector to focus on specific page elements",
          "default": "",
          "placeholder": "e.g. #main-content .article"
        },
        {
          "displayName": "Exclude CSS Selector",
          "name": "excludeSelector",
          "type": "string",
          "description": "CSS selector for elements to exclude",
          "default": "",
          "placeholder": "e.g. header, footer, .ads"
        },
        {
          "displayName": "Enable Image Captioning",
          "name": "enableImageCaptioning",
          "type": "boolean",
          "default": false,
          "description": "Whether to generate captions for images within the content"
        },
        {
          "displayName": "Wait for CSS Selector",
          "name": "waitForSelector",
          "type": "string",
          "description": "Wait for a specific element to appear before extracting content (for dynamic pages)",
          "default": "",
          "placeholder": "e.g. #results-loaded"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "reader"
          ],
          "operation": [
            "read"
          ]
        }
      }
    },
    {
      "displayName": "Search Query",
      "name": "searchQuery",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "reader"
          ],
          "operation": [
            "search"
          ]
        }
      }
    },
    {
      "displayName": "Simplify",
      "name": "simplify",
      "type": "boolean",
      "default": true,
      "description": "Whether to return a simplified version of the response instead of the raw data",
      "displayOptions": {
        "show": {
          "resource": [
            "reader"
          ],
          "operation": [
            "search"
          ]
        }
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Output Format",
          "name": "outputFormat",
          "description": "Specify desired output format",
          "type": "options",
          "options": [
            {
              "name": "HTML",
              "value": "html"
            },
            {
              "name": "JSON",
              "value": ""
            },
            {
              "name": "Markdown",
              "value": "markdown"
            },
            {
              "name": "Screenshot",
              "value": "screenshot"
            },
            {
              "name": "Text",
              "value": "text"
            }
          ],
          "default": ""
        },
        {
          "displayName": "Site Filter",
          "name": "siteFilter",
          "type": "string",
          "description": "Restrict search to specific websites",
          "default": "",
          "placeholder": "e.g. jina.ai, github.com"
        },
        {
          "displayName": "Page Number",
          "name": "pageNumber",
          "type": "number",
          "typeOptions": {
            "minValue": 1,
            "numberPrecision": 0
          },
          "description": "The page number of the search results to retrieve",
          "default": "",
          "placeholder": "1"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "reader"
          ],
          "operation": [
            "search"
          ]
        }
      }
    },
    {
      "displayName": "Research Query",
      "name": "researchQuery",
      "type": "string",
      "default": "",
      "description": "The topic or question for the AI to research",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "research"
          ],
          "operation": [
            "deepResearch"
          ]
        }
      },
      "typeOptions": {
        "rows": 2
      }
    },
    {
      "displayName": "Simplify",
      "name": "simplify",
      "type": "boolean",
      "default": true,
      "description": "Whether to return a simplified version of the response instead of the raw data",
      "displayOptions": {
        "show": {
          "resource": [
            "research"
          ],
          "operation": [
            "deepResearch"
          ]
        }
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Max Returned Sources",
          "name": "maxReturnedSources",
          "description": "The maximum number of URLs to include in the final answer",
          "type": "number",
          "typeOptions": {
            "minValue": 1,
            "numberPrecision": 0
          },
          "default": "",
          "placeholder": "e.g. 5"
        },
        {
          "displayName": "Prioritize Sources",
          "name": "prioritizeSources",
          "type": "string",
          "description": "A list of domains that are given a higher priority for content retrieval",
          "default": "",
          "placeholder": "e.g. jina.ai, github.com"
        },
        {
          "displayName": "Exclude Sources",
          "name": "excludeSources",
          "type": "string",
          "description": "A list of domains to be strictly excluded from content retrieval",
          "default": "",
          "placeholder": "e.g. jina.ai, github.com"
        },
        {
          "displayName": "Site Filter",
          "name": "siteFilter",
          "type": "string",
          "description": "Restrict search to specific websites",
          "default": "",
          "placeholder": "e.g. jina.ai, github.com"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "research"
          ],
          "operation": [
            "deepResearch"
          ]
        }
      }
    }
  ]

operations:
  [
    {
      "operation": "read",
      "name": "Read",
      "description": "Fetches content from a URL and converts it to clean, LLM-friendly formats"
    },
    {
      "operation": "search",
      "name": "Search",
      "description": "Performs a web search via Jina AI and returns top results as clean, LLM-friendly formats"
    }
  ]


