# nodes

node_type: nodes-base.quickbooks
package_name: n8n-nodes-base
display_name: QuickBooks Online
description: Consume the QuickBooks Online API
category: transform
development_style: programmatic
version: 1
credentials_required:
  [
  {
  "name": "quickBooksOAuth2Api",
  "required": true
  }
  ]

outputs:
  [
  "main"
  ]

updated_at: 2026-04-16 09:43:09
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: QuickBooks Online node documentation
  description: Learn how to use the QuickBooks Online node in n8n. Follow technical documentation to integrate QuickBooks Online node into your workflows.
  contentType: [integration, reference]
  ---

  # QuickBooks Online node

  Use the QuickBooks node to automate work in QuickBooks, and integrate QuickBooks with other applications. n8n has built-in support for a wide range of QuickBooks features, including creating, updating, deleting, and getting bills, customers, employees, estimates, and invoices. 

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

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

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

  ## Operations

  * Bill
      * Create
      * Delete
      * Get
      * Get All
      * Update
  * Customer
      * Create
      * Get
      * Get All
      * Update
  * Employee
      * Create
      * Get
      * Get All
      * Update
  * Estimate
      * Create
      * Delete
      * Get
      * Get All
      * Send
      * Update
  * Invoice
      * Create
      * Delete
      * Get
      * Get All
      * Send
      * Update
      * Void
  * Item
      * Get
      * Get All
  * Payment
      * Create
      * Delete
      * Get
      * Get All
      * Send
      * Update
      * Void
  * Purchase
      * Get
      * Get All
  * Transaction
      * Get Report
  * Vendor
      * Create
      * Get
      * Get All
      * Update

  ## Templates and examples

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

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

properties_schema:
  [
    {
      "displayName": "Resource",
      "name": "resource",
      "type": "options",
      "default": "customer",
      "options": [
        {
          "name": "Bill",
          "value": "bill"
        },
        {
          "name": "Customer",
          "value": "customer"
        },
        {
          "name": "Employee",
          "value": "employee"
        },
        {
          "name": "Estimate",
          "value": "estimate"
        },
        {
          "name": "Invoice",
          "value": "invoice"
        },
        {
          "name": "Item",
          "value": "item"
        },
        {
          "name": "Payment",
          "value": "payment"
        },
        {
          "name": "Purchase",
          "value": "purchase"
        },
        {
          "name": "Transaction",
          "value": "transaction"
        },
        {
          "name": "Vendor",
          "value": "vendor"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "get",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "action": "Create a bill"
        },
        {
          "name": "Delete",
          "value": "delete",
          "action": "Delete a bill"
        },
        {
          "name": "Get",
          "value": "get",
          "action": "Get a bill"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "action": "Get many bills"
        },
        {
          "name": "Update",
          "value": "update",
          "action": "Update a bill"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "bill"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "For Vendor Name or ID",
      "name": "VendorRef",
      "type": "options",
      "default": [],
      "description": "The ID of the vendor who the bill is for. 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": [
            "bill"
          ],
          "operation": [
            "create"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getVendors"
      }
    },
    {
      "displayName": "Line",
      "name": "Line",
      "type": "collection",
      "default": {},
      "description": "Individual line item of a transaction",
      "options": [
        {
          "displayName": "Account ID",
          "name": "accountId",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Amount",
          "name": "Amount",
          "description": "Monetary amount of the line item",
          "type": "number",
          "default": 0
        },
        {
          "displayName": "Description",
          "name": "Description",
          "description": "Textual description of the line item",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Detail Type",
          "name": "DetailType",
          "type": "options",
          "default": "ItemBasedExpenseLineDetail",
          "options": [
            {
              "name": "Account-Based Expense Line Detail",
              "value": "AccountBasedExpenseLineDetail"
            },
            {
              "name": "Item-Based Expense Line Detail",
              "value": "ItemBasedExpenseLineDetail"
            }
          ]
        },
        {
          "displayName": "Item Name or ID",
          "name": "itemId",
          "type": "options",
          "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
          "default": [],
          "typeOptions": {
            "loadOptionsMethod": "getItems"
          }
        },
        {
          "displayName": "Position",
          "name": "LineNum",
          "description": "Position of the line item relative to others",
          "type": "number",
          "default": 1
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "bill"
          ],
          "operation": [
            "create"
          ]
        }
      },
      "typeOptions": {
        "multipleValues": true
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Accounts Payable Account",
          "name": "APAccountRef",
          "placeholder": "Add APA Fields",
          "description": "Accounts Payable account to which the bill will be credited",
          "type": "fixedCollection",
          "default": {},
          "options": [
            {
              "displayName": "Details",
              "name": "details",
              "values": [
                {
                  "displayName": "Name",
                  "name": "name",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "ID",
                  "name": "value",
                  "type": "string",
                  "default": ""
                }
              ]
            }
          ]
        },
        {
          "displayName": "Balance",
          "name": "Balance",
          "description": "The balance reflecting any payments made against the transaction",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Due Date",
          "name": "DueDate",
          "description": "Date when the payment of the transaction is due",
          "type": "dateTime",
          "default": ""
        },
        {
          "displayName": "Sales Term",
          "name": "SalesTermRef",
          "description": "Sales term associated with the transaction",
          "placeholder": "Add Sales Term Fields",
          "type": "fixedCollection",
          "default": {},
          "options": [
            {
              "displayName": "Details",
              "name": "details",
              "values": [
                {
                  "displayName": "Name",
                  "name": "name",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "ID",
                  "name": "value",
                  "type": "string",
                  "default": ""
                }
              ]
            }
          ]
        },
        {
          "displayName": "Total Amount",
          "name": "TotalAmt",
          "description": "Total amount of the transaction",
          "type": "number",
          "default": 0
        },
        {
          "displayName": "Transaction Date",
          "name": "TxnDate",
          "description": "Date when the transaction occurred",
          "type": "dateTime",
          "default": ""
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "bill"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Bill ID",
      "name": "billId",
      "type": "string",
      "default": "",
      "description": "The ID of the bill to delete",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "bill"
          ],
          "operation": [
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "Bill ID",
      "name": "billId",
      "type": "string",
      "default": "",
      "description": "The ID of the bill to retrieve",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "bill"
          ],
          "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": [
            "bill"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 50,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "bill"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 1000
      }
    },
    {
      "displayName": "Filters",
      "name": "filters",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Query",
          "name": "query",
          "type": "string",
          "default": "",
          "placeholder": "WHERE Metadata.LastUpdatedTime > '2021-01-01'",
          "description": "The condition for selecting bills. See the <a href=\"https://developer.intuit.com/app/developer/qbo/docs/develop/explore-the-quickbooks-online-api/data-queries\">guide</a> for supported syntax."
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "bill"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Bill ID",
      "name": "billId",
      "type": "string",
      "default": "",
      "description": "The ID of the bill to update",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "bill"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Update Fields",
      "name": "updateFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Accounts Payable Account",
          "name": "APAccountRef",
          "placeholder": "Add APA Fields",
          "description": "Accounts Payable account to which the bill will be credited",
          "type": "fixedCollection",
          "default": {},
          "options": [
            {
              "displayName": "Details",
              "name": "details",
              "values": [
                {
                  "displayName": "Name",
                  "name": "name",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "ID",
                  "name": "value",
                  "type": "string",
                  "default": ""
                }
              ]
            }
          ]
        },
        {
          "displayName": "Due Date",
          "name": "DueDate",
          "description": "Date when the payment of the transaction is due",
          "type": "dateTime",
          "default": ""
        },
        {
          "displayName": "Sales Term",
          "name": "SalesTermRef",
          "description": "Sales term associated with the transaction",
          "placeholder": "Add Sales Term Fields",
          "type": "fixedCollection",
          "default": {},
          "options": [
            {
              "displayName": "Details",
              "name": "details",
              "values": [
                {
                  "displayName": "Name",
                  "name": "name",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "ID",
                  "name": "value",
                  "type": "string",
                  "default": ""
                }
              ]
            }
          ]
        },
        {
          "displayName": "Transaction Date",
          "name": "TxnDate",
          "description": "Date when the transaction occurred",
          "type": "dateTime",
          "default": ""
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "bill"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "get",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "action": "Create a customer"
        },
        {
          "name": "Get",
          "value": "get",
          "action": "Get a customer"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "action": "Get many customers"
        },
        {
          "name": "Update",
          "value": "update",
          "action": "Update a customer"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "customer"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Display Name",
      "name": "displayName",
      "type": "string",
      "default": "",
      "description": "The display name of the customer to create",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "customer"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Active",
          "name": "Active",
          "description": "Whether the customer is currently enabled for use by QuickBooks",
          "type": "boolean",
          "default": true
        },
        {
          "displayName": "Balance",
          "name": "Balance",
          "description": "Open balance amount or amount unpaid by the customer",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Balance With Jobs",
          "name": "BalanceWithJobs",
          "description": "Cumulative open balance amount for the customer (or job) and all its sub-jobs",
          "type": "number",
          "default": 0
        },
        {
          "displayName": "Billing Address",
          "name": "BillAddr",
          "placeholder": "Add Billing Address Fields",
          "type": "fixedCollection",
          "default": {},
          "options": [
            {
              "displayName": "Details",
              "name": "details",
              "values": [
                {
                  "displayName": "City",
                  "name": "City",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Line 1",
                  "name": "Line1",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Postal Code",
                  "name": "PostalCode",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Latitude",
                  "name": "Lat",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Longitude",
                  "name": "Long",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Country Subdivision Code",
                  "name": "CountrySubDivisionCode",
                  "type": "string",
                  "default": ""
                }
              ]
            }
          ]
        },
        {
          "displayName": "Bill With Parent",
          "name": "BillWithParent",
          "description": "Whether to bill this customer together with its parent",
          "type": "boolean",
          "default": false
        },
        {
          "displayName": "Company Name",
          "name": "CompanyName",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Family Name",
          "name": "FamilyName",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Fully Qualified Name",
          "name": "FullyQualifiedName",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Given Name",
          "name": "GivenName",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Preferred Delivery Method",
          "name": "PreferredDeliveryMethod",
          "type": "options",
          "default": "Print",
          "options": [
            {
              "name": "Print",
              "value": "Print"
            },
            {
              "name": "Email",
              "value": "Email"
            },
            {
              "name": "None",
              "value": "None"
            }
          ]
        },
        {
          "displayName": "Primary Email Address",
          "name": "PrimaryEmailAddr",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Primary Phone",
          "name": "PrimaryPhone",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Print-On-Check Name",
          "name": "PrintOnCheckName",
          "description": "Name of the customer as printed on a check",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Taxable",
          "name": "Taxable",
          "description": "Whether transactions for this customer are taxable",
          "type": "boolean",
          "default": false
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "customer"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Customer ID",
      "name": "customerId",
      "type": "string",
      "default": "",
      "description": "The ID of the customer to retrieve",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "customer"
          ],
          "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": [
            "customer"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 50,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "customer"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 1000
      }
    },
    {
      "displayName": "Filters",
      "name": "filters",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Query",
          "name": "query",
          "type": "string",
          "default": "",
          "placeholder": "WHERE Metadata.LastUpdatedTime > '2021-01-01'",
          "description": "The condition for selecting customers. See the <a href=\"https://developer.intuit.com/app/developer/qbo/docs/develop/explore-the-quickbooks-online-api/data-queries\">guide</a> for supported syntax."
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "customer"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Customer ID",
      "name": "customerId",
      "type": "string",
      "default": "",
      "description": "The ID of the customer to update",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "customer"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Update Fields",
      "name": "updateFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Active",
          "name": "Active",
          "description": "Whether the customer is currently enabled for use by QuickBooks",
          "type": "boolean",
          "default": true
        },
        {
          "displayName": "Balance",
          "name": "Balance",
          "description": "Open balance amount or amount unpaid by the customer",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Balance With Jobs",
          "name": "BalanceWithJobs",
          "description": "Cumulative open balance amount for the customer (or job) and all its sub-jobs",
          "type": "number",
          "default": 0
        },
        {
          "displayName": "Billing Address",
          "name": "BillAddr",
          "placeholder": "Add Billing Address Fields",
          "type": "fixedCollection",
          "default": {},
          "options": [
            {
              "displayName": "Details",
              "name": "details",
              "values": [
                {
                  "displayName": "City",
                  "name": "City",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Line 1",
                  "name": "Line1",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Postal Code",
                  "name": "PostalCode",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Latitude",
                  "name": "Lat",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Longitude",
                  "name": "Long",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Country Subdivision Code",
                  "name": "CountrySubDivisionCode",
                  "type": "string",
                  "default": ""
                }
              ]
            }
          ]
        },
        {
          "displayName": "Bill With Parent",
          "name": "BillWithParent",
          "description": "Whether to bill this customer together with its parent",
          "type": "boolean",
          "default": false
        },
        {
          "displayName": "Company Name",
          "name": "CompanyName",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Family Name",
          "name": "FamilyName",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Fully Qualified Name",
          "name": "FullyQualifiedName",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Given Name",
          "name": "GivenName",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Preferred Delivery Method",
          "name": "PreferredDeliveryMethod",
          "type": "options",
          "default": "Print",
          "options": [
            {
              "name": "Print",
              "value": "Print"
            },
            {
              "name": "Email",
              "value": "Email"
            },
            {
              "name": "None",
              "value": "None"
            }
          ]
        },
        {
          "displayName": "Primary Email Address",
          "name": "PrimaryEmailAddr",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Primary Phone",
          "name": "PrimaryPhone",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Print-On-Check Name",
          "name": "PrintOnCheckName",
          "description": "Name of the customer as printed on a check",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Taxable",
          "name": "Taxable",
          "description": "Whether transactions for this customer are taxable",
          "type": "boolean",
          "default": false
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "customer"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "get",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "action": "Create an employee"
        },
        {
          "name": "Get",
          "value": "get",
          "action": "Get an employee"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "action": "Get many employees"
        },
        {
          "name": "Update",
          "value": "update",
          "action": "Update an employee"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "employee"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Family Name",
      "name": "FamilyName",
      "type": "string",
      "default": "",
      "displayOptions": {
        "show": {
          "resource": [
            "employee"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Given Name",
      "name": "GivenName",
      "type": "string",
      "default": "",
      "displayOptions": {
        "show": {
          "resource": [
            "employee"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Active",
          "name": "Active",
          "description": "Whether the employee is currently enabled for use by QuickBooks",
          "type": "boolean",
          "default": false
        },
        {
          "displayName": "Billable Time",
          "name": "BillableTime",
          "type": "boolean",
          "default": false
        },
        {
          "displayName": "Display Name",
          "name": "DisplayName",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Billing Address",
          "name": "BillAddr",
          "placeholder": "Add Billing Address Fields",
          "type": "fixedCollection",
          "default": {},
          "options": [
            {
              "displayName": "Details",
              "name": "details",
              "values": [
                {
                  "displayName": "City",
                  "name": "City",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Line 1",
                  "name": "Line1",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Postal Code",
                  "name": "PostalCode",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Latitude",
                  "name": "Lat",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Longitude",
                  "name": "Long",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Country Subdivision Code",
                  "name": "CountrySubDivisionCode",
                  "type": "string",
                  "default": ""
                }
              ]
            }
          ]
        },
        {
          "displayName": "Primary Phone",
          "name": "PrimaryPhone",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Print-On-Check Name",
          "name": "PrintOnCheckName",
          "description": "Name of the employee as printed on a check",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Social Security Number",
          "name": "SSN",
          "type": "string",
          "default": ""
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "employee"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Employee ID",
      "name": "employeeId",
      "type": "string",
      "default": "",
      "description": "The ID of the employee to retrieve",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "employee"
          ],
          "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": [
            "employee"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 50,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "employee"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 1000
      }
    },
    {
      "displayName": "Filters",
      "name": "filters",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Query",
          "name": "query",
          "type": "string",
          "default": "",
          "placeholder": "WHERE Metadata.LastUpdatedTime > '2021-01-01'",
          "description": "The condition for selecting employees. See the <a href=\"https://developer.intuit.com/app/developer/qbo/docs/develop/explore-the-quickbooks-online-api/data-queries\">guide</a> for supported syntax."
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "employee"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Employee ID",
      "name": "employeeId",
      "type": "string",
      "default": "",
      "description": "The ID of the employee to update",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "employee"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Update Fields",
      "name": "updateFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Active",
          "name": "Active",
          "description": "Whether the employee is currently enabled for use by QuickBooks",
          "type": "boolean",
          "default": false
        },
        {
          "displayName": "Billable Time",
          "name": "BillableTime",
          "type": "boolean",
          "default": false
        },
        {
          "displayName": "Display Name",
          "name": "DisplayName",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Billing Address",
          "name": "BillAddr",
          "placeholder": "Add Billing Address Fields",
          "type": "fixedCollection",
          "default": {},
          "options": [
            {
              "displayName": "Details",
              "name": "details",
              "values": [
                {
                  "displayName": "City",
                  "name": "City",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Line 1",
                  "name": "Line1",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Postal Code",
                  "name": "PostalCode",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Latitude",
                  "name": "Lat",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Longitude",
                  "name": "Long",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Country Subdivision Code",
                  "name": "CountrySubDivisionCode",
                  "type": "string",
                  "default": ""
                }
              ]
            }
          ]
        },
        {
          "displayName": "Primary Phone",
          "name": "PrimaryPhone",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Print-On-Check Name",
          "name": "PrintOnCheckName",
          "description": "Name of the employee as printed on a check",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Social Security Number",
          "name": "SSN",
          "type": "string",
          "default": ""
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "employee"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "get",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "action": "Create an estimate"
        },
        {
          "name": "Delete",
          "value": "delete",
          "action": "Delete an estimate"
        },
        {
          "name": "Get",
          "value": "get",
          "action": "Get an estimate"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "action": "Get many estimates"
        },
        {
          "name": "Send",
          "value": "send",
          "action": "Send an estimate"
        },
        {
          "name": "Update",
          "value": "update",
          "action": "Update an estimate"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "estimate"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "For Customer Name or ID",
      "name": "CustomerRef",
      "type": "options",
      "default": [],
      "description": "The ID of the customer who the estimate is for. 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": [
            "estimate"
          ],
          "operation": [
            "create"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getCustomers"
      }
    },
    {
      "displayName": "Line",
      "name": "Line",
      "type": "collection",
      "default": {},
      "description": "Individual line item of a transaction",
      "options": [
        {
          "displayName": "Amount",
          "name": "Amount",
          "description": "Monetary amount of the line item",
          "type": "number",
          "default": 0
        },
        {
          "displayName": "Description",
          "name": "Description",
          "description": "Textual description of the line item",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Detail Type",
          "name": "DetailType",
          "type": "options",
          "default": "SalesItemLineDetail",
          "options": [
            {
              "name": "Sales Item Line Detail",
              "value": "SalesItemLineDetail"
            }
          ]
        },
        {
          "displayName": "Item Name or ID",
          "name": "itemId",
          "type": "options",
          "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
          "default": [],
          "typeOptions": {
            "loadOptionsMethod": "getItems"
          }
        },
        {
          "displayName": "Position",
          "name": "LineNum",
          "description": "Position of the line item relative to others",
          "type": "number",
          "default": 1
        },
        {
          "displayName": "Tax Code Ref Name or ID",
          "name": "TaxCodeRef",
          "type": "options",
          "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
          "default": [],
          "typeOptions": {
            "loadOptionsMethod": "getTaxCodeRefs"
          }
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "estimate"
          ],
          "operation": [
            "create"
          ]
        }
      },
      "typeOptions": {
        "multipleValues": true
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Apply Tax After Discount",
          "name": "ApplyTaxAfterDiscount",
          "type": "boolean",
          "default": false
        },
        {
          "displayName": "Billing Address",
          "name": "BillAddr",
          "placeholder": "Add Billing Address Fields",
          "type": "fixedCollection",
          "default": {},
          "options": [
            {
              "displayName": "Details",
              "name": "details",
              "values": [
                {
                  "displayName": "City",
                  "name": "City",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Line 1",
                  "name": "Line1",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Postal Code",
                  "name": "PostalCode",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Latitude",
                  "name": "Lat",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Longitude",
                  "name": "Long",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Country Subdivision Code",
                  "name": "CountrySubDivisionCode",
                  "type": "string",
                  "default": ""
                }
              ]
            }
          ]
        },
        {
          "displayName": "Billing Email",
          "name": "BillEmail",
          "description": "E-mail address to which the estimate will be sent",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Custom Fields",
          "name": "CustomFields",
          "placeholder": "Add Custom Fields",
          "type": "fixedCollection",
          "typeOptions": {
            "multipleValues": true
          },
          "default": {},
          "options": [
            {
              "displayName": "Field",
              "name": "Field",
              "values": [
                {
                  "displayName": "Field Definition Name or ID",
                  "name": "DefinitionId",
                  "type": "options",
                  "typeOptions": {
                    "loadOptionsMethod": "getCustomFields"
                  },
                  "default": "",
                  "description": "ID of the field to set. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
                },
                {
                  "displayName": "Field Value",
                  "name": "StringValue",
                  "type": "string",
                  "default": "",
                  "description": "Value of the field to set"
                }
              ]
            }
          ]
        },
        {
          "displayName": "Customer Memo",
          "name": "CustomerMemo",
          "description": "User-entered message to the customer. This message is visible to end user on their transactions.",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Document Number",
          "name": "DocNumber",
          "description": "Reference number for the transaction",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Email Status",
          "name": "EmailStatus",
          "type": "options",
          "default": "NotSet",
          "options": [
            {
              "name": "Not Set",
              "value": "NotSet"
            },
            {
              "name": "Need To Send",
              "value": "NeedToSend"
            },
            {
              "name": "Email Sent",
              "value": "EmailSent"
            }
          ]
        },
        {
          "displayName": "Print Status",
          "name": "PrintStatus",
          "type": "options",
          "default": "NotSet",
          "options": [
            {
              "name": "Not Set",
              "value": "NotSet"
            },
            {
              "name": "Need To Print",
              "value": "NeedToPrint"
            },
            {
              "name": "PrintComplete",
              "value": "PrintComplete"
            }
          ]
        },
        {
          "displayName": "Shipping Address",
          "name": "ShipAddr",
          "placeholder": "Add Shippping Address Fields",
          "type": "fixedCollection",
          "default": {},
          "options": [
            {
              "displayName": "Details",
              "name": "details",
              "values": [
                {
                  "displayName": "City",
                  "name": "City",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Line 1",
                  "name": "Line1",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Postal Code",
                  "name": "PostalCode",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Latitude",
                  "name": "Lat",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Longitude",
                  "name": "Long",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Country Subdivision Code",
                  "name": "CountrySubDivisionCode",
                  "type": "string",
                  "default": ""
                }
              ]
            }
          ]
        },
        {
          "displayName": "Total Amount",
          "name": "TotalAmt",
          "description": "Total amount of the transaction",
          "type": "number",
          "default": 0
        },
        {
          "displayName": "Transaction Date",
          "name": "TxnDate",
          "description": "Date when the transaction occurred",
          "type": "dateTime",
          "default": ""
        },
        {
          "displayName": "Total Tax",
          "name": "TotalTax",
          "description": "Total amount of tax incurred",
          "type": "number",
          "default": 0
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "estimate"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Estimate ID",
      "name": "estimateId",
      "type": "string",
      "default": "",
      "description": "The ID of the estimate to delete",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "estimate"
          ],
          "operation": [
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "Estimate ID",
      "name": "estimateId",
      "type": "string",
      "default": "",
      "description": "The ID of the estimate to retrieve",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "estimate"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Download",
      "name": "download",
      "type": "boolean",
      "default": false,
      "description": "Whether to download the estimate as a PDF file",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "estimate"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Put Output File in Field",
      "name": "binaryProperty",
      "type": "string",
      "default": "data",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "estimate"
          ],
          "operation": [
            "get"
          ],
          "download": [
            true
          ]
        }
      }
    },
    {
      "displayName": "File Name",
      "name": "fileName",
      "type": "string",
      "default": "",
      "description": "Name of the file that will be downloaded",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "estimate"
          ],
          "operation": [
            "get"
          ],
          "download": [
            true
          ]
        }
      }
    },
    {
      "displayName": "Return All",
      "name": "returnAll",
      "type": "boolean",
      "default": false,
      "description": "Whether to return all results or only up to a given limit",
      "displayOptions": {
        "show": {
          "resource": [
            "estimate"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 50,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "estimate"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 1000
      }
    },
    {
      "displayName": "Filters",
      "name": "filters",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Query",
          "name": "query",
          "type": "string",
          "default": "",
          "placeholder": "WHERE Metadata.LastUpdatedTime > '2021-01-01'",
          "description": "The condition for selecting estimates. See the <a href=\"https://developer.intuit.com/app/developer/qbo/docs/develop/explore-the-quickbooks-online-api/data-queries\">guide</a> for supported syntax."
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "estimate"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Estimate ID",
      "name": "estimateId",
      "type": "string",
      "default": "",
      "description": "The ID of the estimate to send",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "estimate"
          ],
          "operation": [
            "send"
          ]
        }
      }
    },
    {
      "displayName": "Email",
      "name": "email",
      "type": "string",
      "default": "",
      "description": "The email of the recipient of the estimate",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "estimate"
          ],
          "operation": [
            "send"
          ]
        }
      }
    },
    {
      "displayName": "Estimate ID",
      "name": "estimateId",
      "type": "string",
      "default": "",
      "description": "The ID of the estimate to update",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "estimate"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Update Fields",
      "name": "updateFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Apply Tax After Discount",
          "name": "ApplyTaxAfterDiscount",
          "type": "boolean",
          "default": false
        },
        {
          "displayName": "Billing Address",
          "name": "BillAddr",
          "placeholder": "Add Billing Address Fields",
          "type": "fixedCollection",
          "default": {},
          "options": [
            {
              "displayName": "Details",
              "name": "details",
              "values": [
                {
                  "displayName": "City",
                  "name": "City",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Line 1",
                  "name": "Line1",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Postal Code",
                  "name": "PostalCode",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Latitude",
                  "name": "Lat",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Longitude",
                  "name": "Long",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Country Subdivision Code",
                  "name": "CountrySubDivisionCode",
                  "type": "string",
                  "default": ""
                }
              ]
            }
          ]
        },
        {
          "displayName": "Billing Email",
          "name": "BillEmail",
          "description": "E-mail address to which the estimate will be sent",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Custom Fields",
          "name": "CustomFields",
          "placeholder": "Add Custom Fields",
          "type": "fixedCollection",
          "typeOptions": {
            "multipleValues": true
          },
          "default": {},
          "options": [
            {
              "displayName": "Field",
              "name": "Field",
              "values": [
                {
                  "displayName": "Field Definition Name or ID",
                  "name": "DefinitionId",
                  "type": "options",
                  "typeOptions": {
                    "loadOptionsMethod": "getCustomFields"
                  },
                  "default": "",
                  "description": "ID of the field to set. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
                },
                {
                  "displayName": "Field Value",
                  "name": "StringValue",
                  "type": "string",
                  "default": "",
                  "description": "Value of the field to set"
                }
              ]
            }
          ]
        },
        {
          "displayName": "Customer Memo",
          "name": "CustomerMemo",
          "description": "User-entered message to the customer. This message is visible to end user on their transactions.",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Document Number",
          "name": "DocNumber",
          "description": "Reference number for the transaction",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Email Status",
          "name": "EmailStatus",
          "type": "options",
          "default": "NotSet",
          "options": [
            {
              "name": "Not Set",
              "value": "NotSet"
            },
            {
              "name": "Need To Send",
              "value": "NeedToSend"
            },
            {
              "name": "Email Sent",
              "value": "EmailSent"
            }
          ]
        },
        {
          "displayName": "Print Status",
          "name": "PrintStatus",
          "type": "options",
          "default": "NotSet",
          "options": [
            {
              "name": "Not Set",
              "value": "NotSet"
            },
            {
              "name": "Need To Print",
              "value": "NeedToPrint"
            },
            {
              "name": "PrintComplete",
              "value": "PrintComplete"
            }
          ]
        },
        {
          "displayName": "Shipping Address",
          "name": "ShipAddr",
          "placeholder": "Add Shippping Address Fields",
          "type": "fixedCollection",
          "default": {},
          "options": [
            {
              "displayName": "Details",
              "name": "details",
              "values": [
                {
                  "displayName": "City",
                  "name": "City",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Line 1",
                  "name": "Line1",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Postal Code",
                  "name": "PostalCode",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Latitude",
                  "name": "Lat",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Longitude",
                  "name": "Long",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Country Subdivision Code",
                  "name": "CountrySubDivisionCode",
                  "type": "string",
                  "default": ""
                }
              ]
            }
          ]
        },
        {
          "displayName": "Transaction Date",
          "name": "TxnDate",
          "description": "Date when the transaction occurred",
          "type": "dateTime",
          "default": ""
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "estimate"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "get",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "action": "Create an invoice"
        },
        {
          "name": "Delete",
          "value": "delete",
          "action": "Delete an invoice"
        },
        {
          "name": "Get",
          "value": "get",
          "action": "Get an invoice"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "action": "Get many invoices"
        },
        {
          "name": "Send",
          "value": "send",
          "action": "Send an invoice"
        },
        {
          "name": "Update",
          "value": "update",
          "action": "Update an invoice"
        },
        {
          "name": "Void",
          "value": "void",
          "action": "Void an invoice"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "invoice"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "For Customer Name or ID",
      "name": "CustomerRef",
      "type": "options",
      "default": [],
      "description": "The ID of the customer who the invoice is for. 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": [
            "invoice"
          ],
          "operation": [
            "create"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getCustomers"
      }
    },
    {
      "displayName": "Line",
      "name": "Line",
      "type": "collection",
      "default": {},
      "description": "Individual line item of a transaction",
      "options": [
        {
          "displayName": "Amount",
          "name": "Amount",
          "description": "Monetary amount of the line item",
          "type": "number",
          "default": 0
        },
        {
          "displayName": "Description",
          "name": "Description",
          "description": "Textual description of the line item",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Detail Type",
          "name": "DetailType",
          "type": "options",
          "default": "SalesItemLineDetail",
          "options": [
            {
              "name": "Sales Item Line Detail",
              "value": "SalesItemLineDetail"
            }
          ]
        },
        {
          "displayName": "Item Name or ID",
          "name": "itemId",
          "type": "options",
          "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
          "default": [],
          "typeOptions": {
            "loadOptionsMethod": "getItems"
          }
        },
        {
          "displayName": "Position",
          "name": "LineNum",
          "description": "Position of the line item relative to others",
          "type": "number",
          "default": 1
        },
        {
          "displayName": "Tax Code Ref Name or ID",
          "name": "TaxCodeRef",
          "type": "options",
          "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
          "default": [],
          "typeOptions": {
            "loadOptionsMethod": "getTaxCodeRefs"
          }
        },
        {
          "displayName": "Quantity",
          "name": "Qty",
          "description": "Number of units of the line item",
          "type": "number",
          "default": 0
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "invoice"
          ],
          "operation": [
            "create"
          ]
        }
      },
      "typeOptions": {
        "multipleValues": true
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Balance",
          "name": "Balance",
          "description": "The balance reflecting any payments made against the transaction",
          "type": "number",
          "default": 0
        },
        {
          "displayName": "Billing Address",
          "name": "BillAddr",
          "placeholder": "Add Billing Address Fields",
          "type": "fixedCollection",
          "default": {},
          "options": [
            {
              "displayName": "Details",
              "name": "details",
              "values": [
                {
                  "displayName": "City",
                  "name": "City",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Line 1",
                  "name": "Line1",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Postal Code",
                  "name": "PostalCode",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Latitude",
                  "name": "Lat",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Longitude",
                  "name": "Long",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Country Subdivision Code",
                  "name": "CountrySubDivisionCode",
                  "type": "string",
                  "default": ""
                }
              ]
            }
          ]
        },
        {
          "displayName": "Billing Email",
          "name": "BillEmail",
          "description": "E-mail address to which the invoice will be sent",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Customer Memo",
          "name": "CustomerMemo",
          "description": "User-entered message to the customer. This message is visible to end user on their transactions.",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Custom Fields",
          "name": "CustomFields",
          "placeholder": "Add Custom Fields",
          "type": "fixedCollection",
          "typeOptions": {
            "multipleValues": true
          },
          "default": {},
          "options": [
            {
              "displayName": "Field",
              "name": "Field",
              "values": [
                {
                  "displayName": "Field Definition Name or ID",
                  "name": "DefinitionId",
                  "type": "options",
                  "typeOptions": {
                    "loadOptionsMethod": "getCustomFields"
                  },
                  "default": "",
                  "description": "ID of the field to set. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
                },
                {
                  "displayName": "Field Value",
                  "name": "StringValue",
                  "type": "string",
                  "default": "",
                  "description": "Value of the field to set"
                }
              ]
            }
          ]
        },
        {
          "displayName": "Document Number",
          "name": "DocNumber",
          "description": "Reference number for the transaction",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Due Date",
          "name": "DueDate",
          "description": "Date when the payment of the transaction is due",
          "type": "dateTime",
          "default": ""
        },
        {
          "displayName": "Email Status",
          "name": "EmailStatus",
          "type": "options",
          "default": "NotSet",
          "options": [
            {
              "name": "Not Set",
              "value": "NotSet"
            },
            {
              "name": "Need To Send",
              "value": "NeedToSend"
            },
            {
              "name": "Email Sent",
              "value": "EmailSent"
            }
          ]
        },
        {
          "displayName": "Print Status",
          "name": "PrintStatus",
          "type": "options",
          "default": "NotSet",
          "options": [
            {
              "name": "Not Set",
              "value": "NotSet"
            },
            {
              "name": "Need To Print",
              "value": "NeedToPrint"
            },
            {
              "name": "PrintComplete",
              "value": "PrintComplete"
            }
          ]
        },
        {
          "displayName": "Shipping Address",
          "name": "ShipAddr",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Total Amount",
          "name": "TotalAmt",
          "description": "Total amount of the transaction",
          "type": "number",
          "default": 0
        },
        {
          "displayName": "Transaction Date",
          "name": "TxnDate",
          "description": "Date when the transaction occurred",
          "type": "dateTime",
          "default": ""
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "invoice"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Invoice ID",
      "name": "invoiceId",
      "type": "string",
      "default": "",
      "description": "The ID of the invoice to delete",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "invoice"
          ],
          "operation": [
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "Invoice ID",
      "name": "invoiceId",
      "type": "string",
      "default": "",
      "description": "The ID of the invoice to retrieve",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "invoice"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Download",
      "name": "download",
      "type": "boolean",
      "default": false,
      "description": "Whether to download the invoice as a PDF file",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "invoice"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Put Output File in Field",
      "name": "binaryProperty",
      "type": "string",
      "default": "data",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "invoice"
          ],
          "operation": [
            "get"
          ],
          "download": [
            true
          ]
        }
      }
    },
    {
      "displayName": "File Name",
      "name": "fileName",
      "type": "string",
      "default": "",
      "description": "Name of the file that will be downloaded",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "invoice"
          ],
          "operation": [
            "get"
          ],
          "download": [
            true
          ]
        }
      }
    },
    {
      "displayName": "Return All",
      "name": "returnAll",
      "type": "boolean",
      "default": false,
      "description": "Whether to return all results or only up to a given limit",
      "displayOptions": {
        "show": {
          "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": 1000
      }
    },
    {
      "displayName": "Filters",
      "name": "filters",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Query",
          "name": "query",
          "type": "string",
          "default": "",
          "placeholder": "WHERE Metadata.LastUpdatedTime > '2021-01-01'",
          "description": "The condition for selecting invoices. See the <a href=\"https://developer.intuit.com/app/developer/qbo/docs/develop/explore-the-quickbooks-online-api/data-queries\">guide</a> for supported syntax."
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "invoice"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Invoice ID",
      "name": "invoiceId",
      "type": "string",
      "default": "",
      "description": "The ID of the invoice to send",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "invoice"
          ],
          "operation": [
            "send"
          ]
        }
      }
    },
    {
      "displayName": "Email",
      "name": "email",
      "type": "string",
      "default": "",
      "description": "The email of the recipient of the invoice",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "invoice"
          ],
          "operation": [
            "send"
          ]
        }
      }
    },
    {
      "displayName": "Invoice ID",
      "name": "invoiceId",
      "type": "string",
      "default": "",
      "description": "The ID of the invoice to void",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "invoice"
          ],
          "operation": [
            "void"
          ]
        }
      }
    },
    {
      "displayName": "Invoice ID",
      "name": "invoiceId",
      "type": "string",
      "default": "",
      "description": "The ID of the invoice to update",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "invoice"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Update Fields",
      "name": "updateFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Billing Address",
          "name": "BillAddr",
          "placeholder": "Add Billing Address Fields",
          "type": "fixedCollection",
          "default": {},
          "options": [
            {
              "displayName": "Details",
              "name": "details",
              "values": [
                {
                  "displayName": "City",
                  "name": "City",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Line 1",
                  "name": "Line1",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Postal Code",
                  "name": "PostalCode",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Latitude",
                  "name": "Lat",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Longitude",
                  "name": "Long",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Country Subdivision Code",
                  "name": "CountrySubDivisionCode",
                  "type": "string",
                  "default": ""
                }
              ]
            }
          ]
        },
        {
          "displayName": "Billing Email",
          "name": "BillEmail",
          "description": "E-mail address to which the invoice will be sent",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Customer Memo",
          "name": "CustomerMemo",
          "description": "User-entered message to the customer. This message is visible to end user on their transactions.",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Custom Fields",
          "name": "CustomFields",
          "placeholder": "Add Custom Fields",
          "type": "fixedCollection",
          "typeOptions": {
            "multipleValues": true
          },
          "default": {},
          "options": [
            {
              "displayName": "Field",
              "name": "Field",
              "values": [
                {
                  "displayName": "Field Definition Name or ID",
                  "name": "DefinitionId",
                  "type": "options",
                  "typeOptions": {
                    "loadOptionsMethod": "getCustomFields"
                  },
                  "default": "",
                  "description": "ID of the field to set. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
                },
                {
                  "displayName": "Field Value",
                  "name": "StringValue",
                  "type": "string",
                  "default": "",
                  "description": "Value of the field to set"
                }
              ]
            }
          ]
        },
        {
          "displayName": "Document Number",
          "name": "DocNumber",
          "description": "Reference number for the transaction",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Due Date",
          "name": "DueDate",
          "description": "Date when the payment of the transaction is due",
          "type": "dateTime",
          "default": ""
        },
        {
          "displayName": "Email Status",
          "name": "EmailStatus",
          "type": "options",
          "default": "NotSet",
          "options": [
            {
              "name": "Not Set",
              "value": "NotSet"
            },
            {
              "name": "Need To Send",
              "value": "NeedToSend"
            },
            {
              "name": "Email Sent",
              "value": "EmailSent"
            }
          ]
        },
        {
          "displayName": "Print Status",
          "name": "PrintStatus",
          "type": "options",
          "default": "NotSet",
          "options": [
            {
              "name": "Not Set",
              "value": "NotSet"
            },
            {
              "name": "Need To Print",
              "value": "NeedToPrint"
            },
            {
              "name": "PrintComplete",
              "value": "PrintComplete"
            }
          ]
        },
        {
          "displayName": "Shipping Address",
          "name": "ShipAddr",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Transaction Date",
          "name": "TxnDate",
          "description": "Date when the transaction occurred",
          "type": "dateTime",
          "default": ""
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "invoice"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "get",
      "options": [
        {
          "name": "Get",
          "value": "get",
          "action": "Get an item"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "action": "Get many items"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "item"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Item ID",
      "name": "itemId",
      "type": "string",
      "default": "",
      "description": "The ID of the item to retrieve",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "item"
          ],
          "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": [
            "item"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 50,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "item"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 1000
      }
    },
    {
      "displayName": "Filters",
      "name": "filters",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Query",
          "name": "query",
          "type": "string",
          "default": "",
          "placeholder": "WHERE Metadata.LastUpdatedTime > '2021-01-01'",
          "description": "The condition for selecting items. See the <a href=\"https://developer.intuit.com/app/developer/qbo/docs/develop/explore-the-quickbooks-online-api/data-queries\">guide</a> for supported syntax."
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "item"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "get",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "action": "Create a payment"
        },
        {
          "name": "Delete",
          "value": "delete",
          "action": "Delete a payment"
        },
        {
          "name": "Get",
          "value": "get",
          "action": "Get a payment"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "action": "Get many payments"
        },
        {
          "name": "Send",
          "value": "send",
          "action": "Send a payment"
        },
        {
          "name": "Update",
          "value": "update",
          "action": "Update a payment"
        },
        {
          "name": "Void",
          "value": "void",
          "action": "Void a payment"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "payment"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "For Customer Name or ID",
      "name": "CustomerRef",
      "type": "options",
      "default": [],
      "description": "The ID of the customer who the payment is for. 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": [
            "payment"
          ],
          "operation": [
            "create"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getCustomers"
      }
    },
    {
      "displayName": "Total Amount",
      "name": "TotalAmt",
      "type": "number",
      "default": 0,
      "description": "Total amount of the transaction",
      "displayOptions": {
        "show": {
          "resource": [
            "payment"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Transaction Date",
          "name": "TxnDate",
          "description": "Date when the transaction occurred",
          "type": "dateTime",
          "default": ""
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "payment"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Payment ID",
      "name": "paymentId",
      "type": "string",
      "default": "",
      "description": "The ID of the payment to delete",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "payment"
          ],
          "operation": [
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "Payment ID",
      "name": "paymentId",
      "type": "string",
      "default": "",
      "description": "The ID of the payment to retrieve",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "payment"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Download",
      "name": "download",
      "type": "boolean",
      "default": false,
      "description": "Whether to download estimate as PDF file",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "payment"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Put Output File in Field",
      "name": "binaryProperty",
      "type": "string",
      "default": "data",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "payment"
          ],
          "operation": [
            "get"
          ],
          "download": [
            true
          ]
        }
      }
    },
    {
      "displayName": "File Name",
      "name": "fileName",
      "type": "string",
      "default": "",
      "description": "Name of the file that will be downloaded",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "payment"
          ],
          "operation": [
            "get"
          ],
          "download": [
            true
          ]
        }
      }
    },
    {
      "displayName": "Return All",
      "name": "returnAll",
      "type": "boolean",
      "default": false,
      "description": "Whether to return all results or only up to a given limit",
      "displayOptions": {
        "show": {
          "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": 1000
      }
    },
    {
      "displayName": "Filters",
      "name": "filters",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Query",
          "name": "query",
          "type": "string",
          "default": "",
          "placeholder": "WHERE Metadata.LastUpdatedTime > '2021-01-01'",
          "description": "The condition for selecting payments. See the <a href=\"https://developer.intuit.com/app/developer/qbo/docs/develop/explore-the-quickbooks-online-api/data-queries\">guide</a> for supported syntax."
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "payment"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Payment ID",
      "name": "paymentId",
      "type": "string",
      "default": "",
      "description": "The ID of the payment to send",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "payment"
          ],
          "operation": [
            "send"
          ]
        }
      }
    },
    {
      "displayName": "Email",
      "name": "email",
      "type": "string",
      "default": "",
      "description": "The email of the recipient of the payment",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "payment"
          ],
          "operation": [
            "send"
          ]
        }
      }
    },
    {
      "displayName": "Payment ID",
      "name": "paymentId",
      "type": "string",
      "default": "",
      "description": "The ID of the payment to void",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "payment"
          ],
          "operation": [
            "void"
          ]
        }
      }
    },
    {
      "displayName": "Payment ID",
      "name": "paymentId",
      "type": "string",
      "default": "",
      "description": "The ID of the payment to update",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "payment"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Update Fields",
      "name": "updateFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Transaction Date",
          "name": "TxnDate",
          "description": "Date when the transaction occurred",
          "type": "dateTime",
          "default": ""
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "payment"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "get",
      "options": [
        {
          "name": "Get",
          "value": "get",
          "action": "Get a purchase"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "action": "Get many purchases"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "purchase"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Purchase ID",
      "name": "purchaseId",
      "type": "string",
      "default": "",
      "description": "The ID of the purchase to retrieve",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "purchase"
          ],
          "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": [
            "purchase"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 50,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "purchase"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 1000
      }
    },
    {
      "displayName": "Filters",
      "name": "filters",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Query",
          "name": "query",
          "type": "string",
          "default": "",
          "placeholder": "WHERE Metadata.LastUpdatedTime > '2021-01-01'",
          "description": "The condition for selecting purchases. See the <a href=\"https://developer.intuit.com/app/developer/qbo/docs/develop/explore-the-quickbooks-online-api/data-queries\">guide</a> for supported syntax."
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "purchase"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "getReport",
      "options": [
        {
          "name": "Get Report",
          "value": "getReport",
          "action": "Get a report"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "transaction"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Simplify",
      "name": "simple",
      "type": "boolean",
      "default": true,
      "description": "Whether to return a simplified version of the response instead of the raw data",
      "displayOptions": {
        "show": {
          "resource": [
            "transaction"
          ],
          "operation": [
            "getReport"
          ]
        }
      }
    },
    {
      "displayName": "Filters",
      "name": "filters",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Accounts Payable Paid",
          "name": "appaid",
          "type": "options",
          "default": "All",
          "options": [
            {
              "name": "All",
              "value": "All"
            },
            {
              "name": "Paid",
              "value": "Paid"
            },
            {
              "name": "Unpaid",
              "value": "Unpaid"
            }
          ]
        },
        {
          "displayName": "Accounts Receivable Paid",
          "name": "arpaid",
          "type": "options",
          "default": "All",
          "options": [
            {
              "name": "All",
              "value": "All"
            },
            {
              "name": "Paid",
              "value": "Paid"
            },
            {
              "name": "Unpaid",
              "value": "Unpaid"
            }
          ]
        },
        {
          "displayName": "Cleared Status",
          "name": "cleared",
          "type": "options",
          "default": "Reconciled",
          "options": [
            {
              "name": "Cleared",
              "value": "Cleared"
            },
            {
              "name": "Uncleared",
              "value": "Uncleared"
            },
            {
              "name": "Reconciled",
              "value": "Reconciled"
            },
            {
              "name": "Deposited",
              "value": "Deposited"
            }
          ]
        },
        {
          "displayName": "Columns",
          "name": "columns",
          "type": "multiOptions",
          "default": [],
          "description": "Columns to return",
          "options": [
            {
              "name": "Account Name",
              "value": "account_name"
            },
            {
              "name": "Created By",
              "value": "create_by"
            },
            {
              "name": "Create Date",
              "value": "create_date"
            },
            {
              "name": "Customer Message",
              "value": "cust_msg"
            },
            {
              "name": "Department Name",
              "value": "dept_name"
            },
            {
              "name": "Due Date",
              "value": "due_date"
            },
            {
              "name": "Document Number",
              "value": "doc_num"
            },
            {
              "name": "Invoice Date",
              "value": "inv_date"
            },
            {
              "name": "Is Account Payable Paid",
              "value": "is_ap_paid"
            },
            {
              "name": "Is Cleared",
              "value": "is_cleared"
            },
            {
              "name": "Last Modified By",
              "value": "last_mod_by"
            },
            {
              "name": "Memo",
              "value": "memo"
            },
            {
              "name": "Name",
              "value": "name"
            },
            {
              "name": "Other Account",
              "value": "other_account"
            },
            {
              "name": "Payment Method",
              "value": "pmt_mthod"
            },
            {
              "name": "Posting",
              "value": "is_no_post"
            },
            {
              "name": "Printed Status",
              "value": "printed"
            },
            {
              "name": "Sales Customer 1",
              "value": "sales_cust1"
            },
            {
              "name": "Sales Customer 2",
              "value": "sales_cust2"
            },
            {
              "name": "Sales Customer 3",
              "value": "sales_cust3"
            },
            {
              "name": "Term Name",
              "value": "term_name"
            },
            {
              "name": "Tracking Number",
              "value": "tracking_num"
            },
            {
              "name": "Transaction Date",
              "value": "tx_date"
            },
            {
              "name": "Transaction Type",
              "value": "txn_type"
            }
          ]
        },
        {
          "displayName": "Customer Names or IDs",
          "name": "customer",
          "type": "multiOptions",
          "default": [],
          "description": "Customer to filter results by. Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
          "typeOptions": {
            "loadOptionsMethod": "getCustomers"
          }
        },
        {
          "displayName": "Date Range (Custom)",
          "name": "dateRangeCustom",
          "placeholder": "Add Date Range",
          "type": "fixedCollection",
          "default": {},
          "options": [
            {
              "displayName": "Date Range Properties",
              "name": "dateRangeCustomProperties",
              "values": [
                {
                  "displayName": "Start Date",
                  "name": "start_date",
                  "type": "dateTime",
                  "default": "",
                  "description": "Start date of the date range to filter results by"
                },
                {
                  "displayName": "End Date",
                  "name": "end_date",
                  "type": "dateTime",
                  "default": "",
                  "description": "End date of the date range to filter results by"
                }
              ]
            }
          ]
        },
        {
          "displayName": "Date Range (Predefined)",
          "name": "date_macro",
          "type": "options",
          "default": "This Month",
          "description": "Predefined date range to filter results by",
          "options": [
            {
              "name": "Today",
              "value": "Today"
            },
            {
              "name": "Yesterday",
              "value": "Yesterday"
            },
            {
              "name": "This Week",
              "value": "This Week"
            },
            {
              "name": "Last Week",
              "value": "Last Week"
            },
            {
              "name": "This Week-to-Date",
              "value": "This Week-to-Date"
            },
            {
              "name": "Last Week-to-Date",
              "value": "Last Week-to-Date"
            },
            {
              "name": "Next Week",
              "value": "Next Week"
            },
            {
              "name": "Next 4 Weeks",
              "value": "Next 4 Weeks"
            },
            {
              "name": "This Month",
              "value": "This Month"
            },
            {
              "name": "Last Month",
              "value": "Last Month"
            },
            {
              "name": "This Month-to-Date",
              "value": "This Month-to-Date"
            },
            {
              "name": "Last Month-to-Date",
              "value": "Last Month-to-Date"
            },
            {
              "name": "Next Month",
              "value": "Next Month"
            },
            {
              "name": "This Fiscal Quarter",
              "value": "This Fiscal Quarter"
            },
            {
              "name": "Last Fiscal Quarter",
              "value": "Last Fiscal Quarter"
            },
            {
              "name": "This Fiscal Quarter-to-Date",
              "value": "This Fiscal Quarter-to-Date"
            },
            {
              "name": "Last Fiscal Quarter-to-Date",
              "value": "Last Fiscal Quarter-to-Date"
            },
            {
              "name": "Next Fiscal Quarter",
              "value": "Next Fiscal Quarter"
            },
            {
              "name": "This Fiscal Year",
              "value": "This Fiscal Year"
            },
            {
              "name": "Last Fiscal Year",
              "value": "Last Fiscal Year"
            },
            {
              "name": "This Fiscal Year-to-Date",
              "value": "This Fiscal Year-to-Date"
            },
            {
              "name": "Last Fiscal Year-to-Date",
              "value": "Last Fiscal Year-to-Date"
            },
            {
              "name": "Next Fiscal Year",
              "value": "Next Fiscal Year"
            }
          ]
        },
        {
          "displayName": "Date Range for Creation Date (Custom)",
          "name": "dateRangeCreationCustom",
          "placeholder": "Add Creation Date Range",
          "type": "fixedCollection",
          "default": {},
          "options": [
            {
              "displayName": "Creation Date Range Properties",
              "name": "dateRangeCreationCustomProperties",
              "values": [
                {
                  "displayName": "Start Creation Date",
                  "name": "start_createdate",
                  "type": "dateTime",
                  "default": "",
                  "description": "Start date of the account creation date range to filter results by"
                },
                {
                  "displayName": "End Creation Date",
                  "name": "end_createdate",
                  "type": "dateTime",
                  "default": "",
                  "description": "End date of the account creation date range to filter results by"
                }
              ]
            }
          ]
        },
        {
          "displayName": "Date Range for Creation Date (Predefined)",
          "name": "createdate_macro",
          "type": "options",
          "default": "This Month",
          "options": [
            {
              "name": "Today",
              "value": "Today"
            },
            {
              "name": "Yesterday",
              "value": "Yesterday"
            },
            {
              "name": "This Week",
              "value": "This Week"
            },
            {
              "name": "Last Week",
              "value": "Last Week"
            },
            {
              "name": "This Week-to-Date",
              "value": "This Week-to-Date"
            },
            {
              "name": "Last Week-to-Date",
              "value": "Last Week-to-Date"
            },
            {
              "name": "Next Week",
              "value": "Next Week"
            },
            {
              "name": "Next 4 Weeks",
              "value": "Next 4 Weeks"
            },
            {
              "name": "This Month",
              "value": "This Month"
            },
            {
              "name": "Last Month",
              "value": "Last Month"
            },
            {
              "name": "This Month-to-Date",
              "value": "This Month-to-Date"
            },
            {
              "name": "Last Month-to-Date",
              "value": "Last Month-to-Date"
            },
            {
              "name": "Next Month",
              "value": "Next Month"
            },
            {
              "name": "This Fiscal Quarter",
              "value": "This Fiscal Quarter"
            },
            {
              "name": "Last Fiscal Quarter",
              "value": "Last Fiscal Quarter"
            },
            {
              "name": "This Fiscal Quarter-to-Date",
              "value": "This Fiscal Quarter-to-Date"
            },
            {
              "name": "Last Fiscal Quarter-to-Date",
              "value": "Last Fiscal Quarter-to-Date"
            },
            {
              "name": "Next Fiscal Quarter",
              "value": "Next Fiscal Quarter"
            },
            {
              "name": "This Fiscal Year",
              "value": "This Fiscal Year"
            },
            {
              "name": "Last Fiscal Year",
              "value": "Last Fiscal Year"
            },
            {
              "name": "This Fiscal Year-to-Date",
              "value": "This Fiscal Year-to-Date"
            },
            {
              "name": "Last Fiscal Year-to-Date",
              "value": "Last Fiscal Year-to-Date"
            },
            {
              "name": "Next Fiscal Year",
              "value": "Next Fiscal Year"
            }
          ],
          "description": "Predefined report account creation date range"
        },
        {
          "displayName": "Date Range for Due Date (Custom)",
          "name": "dateRangeDueCustom",
          "placeholder": "Add Due Date Range",
          "type": "fixedCollection",
          "default": {},
          "options": [
            {
              "displayName": "Due Date Range Properties",
              "name": "dateRangeDueCustomProperties",
              "values": [
                {
                  "displayName": "Start Due Date",
                  "name": "start_duedate",
                  "type": "dateTime",
                  "default": "",
                  "description": "Start date of the due date range to filter results by"
                },
                {
                  "displayName": "End Due Date",
                  "name": "end_duedate",
                  "type": "dateTime",
                  "default": "",
                  "description": "End date of the due date range to filter results by"
                }
              ]
            }
          ]
        },
        {
          "displayName": "Date Range for Due Date (Predefined)",
          "name": "duedate_macro",
          "type": "options",
          "default": "This Month",
          "description": "Predefined due date range to filter results by",
          "options": [
            {
              "name": "Today",
              "value": "Today"
            },
            {
              "name": "Yesterday",
              "value": "Yesterday"
            },
            {
              "name": "This Week",
              "value": "This Week"
            },
            {
              "name": "Last Week",
              "value": "Last Week"
            },
            {
              "name": "This Week-to-Date",
              "value": "This Week-to-Date"
            },
            {
              "name": "Last Week-to-Date",
              "value": "Last Week-to-Date"
            },
            {
              "name": "Next Week",
              "value": "Next Week"
            },
            {
              "name": "Next 4 Weeks",
              "value": "Next 4 Weeks"
            },
            {
              "name": "This Month",
              "value": "This Month"
            },
            {
              "name": "Last Month",
              "value": "Last Month"
            },
            {
              "name": "This Month-to-Date",
              "value": "This Month-to-Date"
            },
            {
              "name": "Last Month-to-Date",
              "value": "Last Month-to-Date"
            },
            {
              "name": "Next Month",
              "value": "Next Month"
            },
            {
              "name": "This Fiscal Quarter",
              "value": "This Fiscal Quarter"
            },
            {
              "name": "Last Fiscal Quarter",
              "value": "Last Fiscal Quarter"
            },
            {
              "name": "This Fiscal Quarter-to-Date",
              "value": "This Fiscal Quarter-to-Date"
            },
            {
              "name": "Last Fiscal Quarter-to-Date",
              "value": "Last Fiscal Quarter-to-Date"
            },
            {
              "name": "Next Fiscal Quarter",
              "value": "Next Fiscal Quarter"
            },
            {
              "name": "This Fiscal Year",
              "value": "This Fiscal Year"
            },
            {
              "name": "Last Fiscal Year",
              "value": "Last Fiscal Year"
            },
            {
              "name": "This Fiscal Year-to-Date",
              "value": "This Fiscal Year-to-Date"
            },
            {
              "name": "Last Fiscal Year-to-Date",
              "value": "Last Fiscal Year-to-Date"
            },
            {
              "name": "Next Fiscal Year",
              "value": "Next Fiscal Year"
            }
          ]
        },
        {
          "displayName": "Date Range for Modification Date (Custom)",
          "name": "dateRangeModificationCustom",
          "placeholder": "Add Modification Date Range",
          "type": "fixedCollection",
          "default": {},
          "options": [
            {
              "displayName": "Modification Date Range Properties",
              "name": "dateRangeModificationCustomProperties",
              "values": [
                {
                  "displayName": "Start Modification Date",
                  "name": "start_moddate",
                  "type": "dateTime",
                  "default": "",
                  "description": "Start date of the account modification date range to filter results by"
                },
                {
                  "displayName": "End Modification Date",
                  "name": "end_moddate",
                  "type": "dateTime",
                  "default": "",
                  "description": "End date of the account modification date range to filter results by"
                }
              ]
            }
          ]
        },
        {
          "displayName": "Date Range for Modification Date (Predefined)",
          "name": "moddate_macro",
          "type": "options",
          "default": "This Month",
          "description": "Predefined account modifiction date range to filter results by",
          "options": [
            {
              "name": "Today",
              "value": "Today"
            },
            {
              "name": "Yesterday",
              "value": "Yesterday"
            },
            {
              "name": "This Week",
              "value": "This Week"
            },
            {
              "name": "Last Week",
              "value": "Last Week"
            },
            {
              "name": "This Week-to-Date",
              "value": "This Week-to-Date"
            },
            {
              "name": "Last Week-to-Date",
              "value": "Last Week-to-Date"
            },
            {
              "name": "Next Week",
              "value": "Next Week"
            },
            {
              "name": "Next 4 Weeks",
              "value": "Next 4 Weeks"
            },
            {
              "name": "This Month",
              "value": "This Month"
            },
            {
              "name": "Last Month",
              "value": "Last Month"
            },
            {
              "name": "This Month-to-Date",
              "value": "This Month-to-Date"
            },
            {
              "name": "Last Month-to-Date",
              "value": "Last Month-to-Date"
            },
            {
              "name": "Next Month",
              "value": "Next Month"
            },
            {
              "name": "This Fiscal Quarter",
              "value": "This Fiscal Quarter"
            },
            {
              "name": "Last Fiscal Quarter",
              "value": "Last Fiscal Quarter"
            },
            {
              "name": "This Fiscal Quarter-to-Date",
              "value": "This Fiscal Quarter-to-Date"
            },
            {
              "name": "Last Fiscal Quarter-to-Date",
              "value": "Last Fiscal Quarter-to-Date"
            },
            {
              "name": "Next Fiscal Quarter",
              "value": "Next Fiscal Quarter"
            },
            {
              "name": "This Fiscal Year",
              "value": "This Fiscal Year"
            },
            {
              "name": "Last Fiscal Year",
              "value": "Last Fiscal Year"
            },
            {
              "name": "This Fiscal Year-to-Date",
              "value": "This Fiscal Year-to-Date"
            },
            {
              "name": "Last Fiscal Year-to-Date",
              "value": "Last Fiscal Year-to-Date"
            },
            {
              "name": "Next Fiscal Year",
              "value": "Next Fiscal Year"
            }
          ]
        },
        {
          "displayName": "Department Names or IDs",
          "name": "department",
          "type": "multiOptions",
          "default": [],
          "description": "Department to filter results by. Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
          "typeOptions": {
            "loadOptionsMethod": "getDepartments"
          }
        },
        {
          "displayName": "Document Number",
          "name": "docnum",
          "type": "string",
          "default": "",
          "description": "Transaction document number to filter results by"
        },
        {
          "displayName": "Group By",
          "name": "group_by",
          "default": "Account",
          "type": "options",
          "description": "Transaction field to group results by",
          "options": [
            {
              "name": "Account",
              "value": "Account"
            },
            {
              "name": "Customer",
              "value": "Customer"
            },
            {
              "name": "Day",
              "value": "Day"
            },
            {
              "name": "Employee",
              "value": "Employee"
            },
            {
              "name": "Location",
              "value": "Location"
            },
            {
              "name": "Month",
              "value": "Month"
            },
            {
              "name": "Name",
              "value": "Name"
            },
            {
              "name": "None",
              "value": "None"
            },
            {
              "name": "Payment Method",
              "value": "Payment Method"
            },
            {
              "name": "Quarter",
              "value": "Quarter"
            },
            {
              "name": "Transaction Type",
              "value": "Transaction Type"
            },
            {
              "name": "Vendor",
              "value": "Vendor"
            },
            {
              "name": "Week",
              "value": "Week"
            },
            {
              "name": "Year",
              "value": "Year"
            }
          ]
        },
        {
          "displayName": "Memo Names or IDs",
          "name": "memo",
          "type": "multiOptions",
          "default": [],
          "description": "Memo to filter results by. Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
          "typeOptions": {
            "loadOptionsMethod": "getMemos"
          }
        },
        {
          "displayName": "Payment Method",
          "name": "payment_Method",
          "type": "options",
          "default": "Cash",
          "description": "Payment method to filter results by",
          "options": [
            {
              "name": "American Express",
              "value": "American Express"
            },
            {
              "name": "Cash",
              "value": "Cash"
            },
            {
              "name": "Check",
              "value": "Check"
            },
            {
              "name": "Dinners Club",
              "value": "Dinners Club"
            },
            {
              "name": "Discover",
              "value": "Discover"
            },
            {
              "name": "Master Card",
              "value": "Master Card"
            },
            {
              "name": "Visa",
              "value": "Visa"
            }
          ]
        },
        {
          "displayName": "Printed Status",
          "name": "printed",
          "type": "options",
          "default": "Printed",
          "description": "Printed state to filter results by",
          "options": [
            {
              "name": "Printed",
              "value": "Printed"
            },
            {
              "name": "To Be Printed",
              "value": "To_be_printed"
            }
          ]
        },
        {
          "displayName": "Quick Zoom URL",
          "name": "qzurl",
          "type": "boolean",
          "default": true,
          "description": "Whether Quick Zoom URL information should be generated"
        },
        {
          "displayName": "Sort By",
          "name": "sort_by",
          "type": "options",
          "default": "account_name",
          "description": "Column to sort results by",
          "options": [
            {
              "name": "Account Name",
              "value": "account_name"
            },
            {
              "name": "Created By",
              "value": "create_by"
            },
            {
              "name": "Create Date",
              "value": "create_date"
            },
            {
              "name": "Customer Message",
              "value": "cust_msg"
            },
            {
              "name": "Department Name",
              "value": "dept_name"
            },
            {
              "name": "Due Date",
              "value": "due_date"
            },
            {
              "name": "Document Number",
              "value": "doc_num"
            },
            {
              "name": "Invoice Date",
              "value": "inv_date"
            },
            {
              "name": "Is Account Payable Paid",
              "value": "is_ap_paid"
            },
            {
              "name": "Is Cleared",
              "value": "is_cleared"
            },
            {
              "name": "Last Modified By",
              "value": "last_mod_by"
            },
            {
              "name": "Memo",
              "value": "memo"
            },
            {
              "name": "Name",
              "value": "name"
            },
            {
              "name": "Other Account",
              "value": "other_account"
            },
            {
              "name": "Payment Method",
              "value": "pmt_mthod"
            },
            {
              "name": "Posting",
              "value": "is_no_post"
            },
            {
              "name": "Printed Status",
              "value": "printed"
            },
            {
              "name": "Sales Customer 1",
              "value": "sales_cust1"
            },
            {
              "name": "Sales Customer 2",
              "value": "sales_cust2"
            },
            {
              "name": "Sales Customer 3",
              "value": "sales_cust3"
            },
            {
              "name": "Term Name",
              "value": "term_name"
            },
            {
              "name": "Tracking Number",
              "value": "tracking_num"
            },
            {
              "name": "Transaction Date",
              "value": "tx_date"
            },
            {
              "name": "Transaction Type",
              "value": "txn_type"
            }
          ]
        },
        {
          "displayName": "Sort Order",
          "name": "sort_order",
          "type": "options",
          "default": "Ascend",
          "options": [
            {
              "name": "Ascend",
              "value": "Ascend"
            },
            {
              "name": "Descend",
              "value": "Descend"
            }
          ]
        },
        {
          "displayName": "Source Account Type",
          "name": "source_account_type",
          "default": "Bank",
          "type": "options",
          "description": "Account type to filter results by",
          "options": [
            {
              "name": "Accounts Payable",
              "value": "AccountsPayable"
            },
            {
              "name": "Accounts Receivable",
              "value": "AccountsReceivable"
            },
            {
              "name": "Bank",
              "value": "Bank"
            },
            {
              "name": "Cost Of Goods Sold",
              "value": "CostOfGoodsSold"
            },
            {
              "name": "Credit Card",
              "value": "CreditCard"
            },
            {
              "name": "Equity",
              "value": "Equity"
            },
            {
              "name": "Expense",
              "value": "Expense"
            },
            {
              "name": "Fixed Asset",
              "value": "FixedAsset"
            },
            {
              "name": "Income",
              "value": "Income"
            },
            {
              "name": "Long Term Liability",
              "value": "LongTermLiability"
            },
            {
              "name": "Non Posting",
              "value": "NonPosting"
            },
            {
              "name": "Other Asset",
              "value": "OtherAsset"
            },
            {
              "name": "Other Current Asset",
              "value": "OtherCurrentAsset"
            },
            {
              "name": "Other Current Liability",
              "value": "OtherCurrentLiability"
            },
            {
              "name": "Other Expense",
              "value": "OtherExpense"
            },
            {
              "name": "Other Income",
              "value": "OtherIncome"
            }
          ]
        },
        {
          "displayName": "Term Names or IDs",
          "name": "term",
          "type": "multiOptions",
          "default": [],
          "description": "Term to filter results by. Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
          "typeOptions": {
            "loadOptionsMethod": "getTerms"
          }
        },
        {
          "displayName": "Transaction Amount",
          "name": "bothamount",
          "type": "number",
          "default": 0,
          "typeOptions": {
            "numberPrecision": 2
          },
          "description": "Monetary amount to filter results by"
        },
        {
          "displayName": "Transaction Type",
          "name": "transaction_type",
          "type": "options",
          "default": "CreditCardCharge",
          "description": "Transaction type to filter results by",
          "options": [
            {
              "name": "Bill",
              "value": "Bill"
            },
            {
              "name": "Bill Payment Check",
              "value": "BillPaymentCheck"
            },
            {
              "name": "Bill Payment Credit Card",
              "value": "BillPaymentCreditCard"
            },
            {
              "name": "Billable Charge",
              "value": "BillableCharge"
            },
            {
              "name": "Cash Purchase",
              "value": "CashPurchase"
            },
            {
              "name": "Charge",
              "value": "Charge"
            },
            {
              "name": "Check",
              "value": "Check"
            },
            {
              "name": "Credit",
              "value": "Credit"
            },
            {
              "name": "Credit Card Charge",
              "value": "CreditCardCharge"
            },
            {
              "name": "Credit Card Credit",
              "value": "CreditCardCredit"
            },
            {
              "name": "Credit Memo",
              "value": "CreditMemo"
            },
            {
              "name": "Credit Refund",
              "value": "CreditRefund"
            },
            {
              "name": "Deposit",
              "value": "Deposit"
            },
            {
              "name": "Estimate",
              "value": "Estimate"
            },
            {
              "name": "Global Tax Adjustment",
              "value": "GlobalTaxAdjustment"
            },
            {
              "name": "Global Tax Payment",
              "value": "GlobalTaxPayment"
            },
            {
              "name": "Inventory Quantity Adjustment",
              "value": "InventoryQuantityAdjustment"
            },
            {
              "name": "Invoice",
              "value": "Invoice"
            },
            {
              "name": "Journal Entry",
              "value": "JournalEntry"
            },
            {
              "name": "Purchase Order",
              "value": "PurchaseOrder"
            },
            {
              "name": "Receive Payment",
              "value": "ReceivePayment"
            },
            {
              "name": "Sales Receipt",
              "value": "SalesReceipt"
            },
            {
              "name": "Service  Tax  Defer",
              "value": "Service Tax Defer"
            },
            {
              "name": "Service  Tax  Gross  Adjustment",
              "value": "Service Tax Gross Adjustment"
            },
            {
              "name": "Service  Tax  Partial  Utilisation",
              "value": "Service Tax Partial Utilisation"
            },
            {
              "name": "Service  Tax  Refund",
              "value": "Service Tax Refund"
            },
            {
              "name": "Service  Tax  Reversal",
              "value": "Service Tax Reversal"
            },
            {
              "name": "Statement",
              "value": "Statement"
            },
            {
              "name": "Time Activity",
              "value": "TimeActivity"
            },
            {
              "name": "Transfer",
              "value": "Transfer"
            },
            {
              "name": "Vendor Credit",
              "value": "VendorCredit"
            }
          ]
        },
        {
          "displayName": "Vendor Names or IDs",
          "name": "vendor",
          "type": "multiOptions",
          "default": [],
          "description": "Vendor to filter results by. Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
          "typeOptions": {
            "loadOptionsMethod": "getVendors"
          }
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "transaction"
          ],
          "operation": [
            "getReport"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "get",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "action": "Create a vendor"
        },
        {
          "name": "Get",
          "value": "get",
          "action": "Get a vendor"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "action": "Get many vendors"
        },
        {
          "name": "Update",
          "value": "update",
          "action": "Update a vendor"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "vendor"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Display Name",
      "name": "displayName",
      "type": "string",
      "default": "",
      "description": "The display name of the vendor to create",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "vendor"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Account Number",
          "name": "AcctNum",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Active",
          "name": "Active",
          "description": "Whether the employee is currently enabled for use by QuickBooks",
          "type": "boolean",
          "default": false
        },
        {
          "displayName": "Balance",
          "name": "Balance",
          "description": "The balance reflecting any payments made against the transaction",
          "type": "number",
          "default": 0
        },
        {
          "displayName": "Billing Address",
          "name": "BillAddr",
          "placeholder": "Add Billing Address Fields",
          "type": "fixedCollection",
          "default": {},
          "options": [
            {
              "displayName": "Details",
              "name": "details",
              "values": [
                {
                  "displayName": "City",
                  "name": "City",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Line 1",
                  "name": "Line1",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Postal Code",
                  "name": "PostalCode",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Latitude",
                  "name": "Lat",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Longitude",
                  "name": "Long",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Country Subdivision Code",
                  "name": "CountrySubDivisionCode",
                  "type": "string",
                  "default": ""
                }
              ]
            }
          ]
        },
        {
          "displayName": "Company Name",
          "name": "CompanyName",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Family Name",
          "name": "FamilyName",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Given Name",
          "name": "GivenName",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Primary Email Address",
          "name": "PrimaryEmailAddr",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Primary Phone",
          "name": "PrimaryPhone",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Print-On-Check Name",
          "name": "PrintOnCheckName",
          "description": "Name of the vendor as printed on a check",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Vendor 1099",
          "name": "Vendor1099",
          "description": "Whether the vendor is an independent contractor, given a 1099-MISC form at the end of the year",
          "type": "boolean",
          "default": false
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "vendor"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Vendor ID",
      "name": "vendorId",
      "type": "string",
      "default": "",
      "description": "The ID of the vendor to retrieve",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "vendor"
          ],
          "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": [
            "vendor"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 50,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "vendor"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 1000
      }
    },
    {
      "displayName": "Filters",
      "name": "filters",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Query",
          "name": "query",
          "type": "string",
          "default": "",
          "placeholder": "WHERE Metadata.LastUpdatedTime > '2021-01-01'",
          "description": "The condition for selecting vendors. See the <a href=\"https://developer.intuit.com/app/developer/qbo/docs/develop/explore-the-quickbooks-online-api/data-queries\">guide</a> for supported syntax."
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "vendor"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Vendor ID",
      "name": "vendorId",
      "type": "string",
      "default": "",
      "description": "The ID of the vendor to update",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "vendor"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Update Fields",
      "name": "updateFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Account Number",
          "name": "AcctNum",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Active",
          "name": "Active",
          "description": "Whether the employee is currently enabled for use by QuickBooks",
          "type": "boolean",
          "default": false
        },
        {
          "displayName": "Balance",
          "name": "Balance",
          "description": "The balance reflecting any payments made against the transaction",
          "type": "number",
          "default": 0
        },
        {
          "displayName": "Billing Address",
          "name": "BillAddr",
          "placeholder": "Add Billing Address Fields",
          "type": "fixedCollection",
          "default": {},
          "options": [
            {
              "displayName": "Details",
              "name": "details",
              "values": [
                {
                  "displayName": "City",
                  "name": "City",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Line 1",
                  "name": "Line1",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Postal Code",
                  "name": "PostalCode",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Latitude",
                  "name": "Lat",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Longitude",
                  "name": "Long",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Country Subdivision Code",
                  "name": "CountrySubDivisionCode",
                  "type": "string",
                  "default": ""
                }
              ]
            }
          ]
        },
        {
          "displayName": "Company Name",
          "name": "CompanyName",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Family Name",
          "name": "FamilyName",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Given Name",
          "name": "GivenName",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Primary Email Address",
          "name": "PrimaryEmailAddr",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Primary Phone",
          "name": "PrimaryPhone",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Print-On-Check Name",
          "name": "PrintOnCheckName",
          "description": "Name of the vendor as printed on a check",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Vendor 1099",
          "name": "Vendor1099",
          "description": "Whether the vendor is an independent contractor, given a 1099-MISC form at the end of the year",
          "type": "boolean",
          "default": false
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "vendor"
          ],
          "operation": [
            "update"
          ]
        }
      }
    }
  ]

operations:
  [
    {
      "operation": "create",
      "name": "Create",
      "resource": "bill"
    },
    {
      "operation": "delete",
      "name": "Delete",
      "resource": "bill"
    },
    {
      "operation": "get",
      "name": "Get",
      "resource": "bill"
    },
    {
      "operation": "getAll",
      "name": "Get Many",
      "resource": "bill"
    },
    {
      "operation": "update",
      "name": "Update",
      "resource": "bill"
    },
    {
      "operation": "create",
      "name": "Create",
      "resource": "customer"
    },
    {
      "operation": "get",
      "name": "Get",
      "resource": "customer"
    },
    {
      "operation": "getAll",
      "name": "Get Many",
      "resource": "customer"
    },
    {
      "operation": "update",
      "name": "Update",
      "resource": "customer"
    },
    {
      "operation": "create",
      "name": "Create",
      "resource": "employee"
    },
    {
      "operation": "get",
      "name": "Get",
      "resource": "employee"
    },
    {
      "operation": "getAll",
      "name": "Get Many",
      "resource": "employee"
    },
    {
      "operation": "update",
      "name": "Update",
      "resource": "employee"
    },
    {
      "operation": "create",
      "name": "Create",
      "resource": "estimate"
    },
    {
      "operation": "delete",
      "name": "Delete",
      "resource": "estimate"
    },
    {
      "operation": "get",
      "name": "Get",
      "resource": "estimate"
    },
    {
      "operation": "getAll",
      "name": "Get Many",
      "resource": "estimate"
    },
    {
      "operation": "send",
      "name": "Send",
      "resource": "estimate"
    },
    {
      "operation": "update",
      "name": "Update",
      "resource": "estimate"
    },
    {
      "operation": "create",
      "name": "Create",
      "resource": "invoice"
    },
    {
      "operation": "delete",
      "name": "Delete",
      "resource": "invoice"
    },
    {
      "operation": "get",
      "name": "Get",
      "resource": "invoice"
    },
    {
      "operation": "getAll",
      "name": "Get Many",
      "resource": "invoice"
    },
    {
      "operation": "send",
      "name": "Send",
      "resource": "invoice"
    },
    {
      "operation": "update",
      "name": "Update",
      "resource": "invoice"
    },
    {
      "operation": "void",
      "name": "Void",
      "resource": "invoice"
    },
    {
      "operation": "get",
      "name": "Get",
      "resource": "item"
    },
    {
      "operation": "getAll",
      "name": "Get Many",
      "resource": "item"
    },
    {
      "operation": "create",
      "name": "Create",
      "resource": "payment"
    },
    {
      "operation": "delete",
      "name": "Delete",
      "resource": "payment"
    },
    {
      "operation": "get",
      "name": "Get",
      "resource": "payment"
    },
    {
      "operation": "getAll",
      "name": "Get Many",
      "resource": "payment"
    },
    {
      "operation": "send",
      "name": "Send",
      "resource": "payment"
    },
    {
      "operation": "update",
      "name": "Update",
      "resource": "payment"
    },
    {
      "operation": "void",
      "name": "Void",
      "resource": "payment"
    },
    {
      "operation": "get",
      "name": "Get",
      "resource": "purchase"
    },
    {
      "operation": "getAll",
      "name": "Get Many",
      "resource": "purchase"
    },
    {
      "operation": "getReport",
      "name": "Get Report",
      "resource": "transaction"
    },
    {
      "operation": "create",
      "name": "Create",
      "resource": "vendor"
    },
    {
      "operation": "get",
      "name": "Get",
      "resource": "vendor"
    },
    {
      "operation": "getAll",
      "name": "Get Many",
      "resource": "vendor"
    },
    {
      "operation": "update",
      "name": "Update",
      "resource": "vendor"
    }
  ]


node_type: nodes-base.quickChartTool
package_name: n8n-nodes-base
display_name: QuickChart Tool
description: Create a chart via QuickChart (AI Tool variant for use with AI Agents)
category: output
development_style: programmatic
version: 1
operations: []
credentials_required: []
outputs:
  [
  {
  "type": "ai_tool",
  "displayName": "Tool"
  }
  ]

output_names:
  [
  "Tool"
  ]

updated_at: 2026-04-16 09:43:09
tool_variant_of: nodes-base.quickChart
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: QuickChart node documentation
  description: Learn how to use the QuickChart node in n8n. Follow technical documentation to integrate QuickChart node into your workflows.
  contentType: [integration, reference]
  priority: medium
  ---

  # QuickChart node

  Use the QuickChart node to automate work in QuickChart, and integrate QuickChart with other applications. n8n has built-in support for a wide range of QuickChart chart types, including bar, doughnut, line, pie, and polar charts.

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

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

  ## Operations

  Create a chart by selecting the chart type:

  * Chart Type
  	* Bar Chart
  	* Doughnut Chart
  	* Line Chart
  	* Pie Chart
  	* Polar Chart

  ## Templates and examples

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

  ## Related resources

  Refer to [QuickChart's API documentation](https://quickchart.io/documentation/){:target=_blank .external-link} for more information about the service.

properties_schema:
  [
    {
      "displayName": "Tool Description",
      "name": "toolDescription",
      "type": "string",
      "default": "",
      "required": false,
      "description": "Description for the AI to understand what this tool does and when to use it",
      "typeOptions": {
        "rows": 3
      },
      "placeholder": "e.g., Use this tool to interact with QuickChart"
    },
    {
      "displayName": "Chart Type",
      "name": "chartType",
      "type": "options",
      "default": "bar",
      "description": "The type of chart to create",
      "options": [
        {
          "name": "Bar Chart",
          "value": "bar"
        },
        {
          "name": "Doughnut Chart",
          "value": "doughnut"
        },
        {
          "name": "Line Chart",
          "value": "line"
        },
        {
          "name": "Pie Chart",
          "value": "pie"
        },
        {
          "name": "Polar Chart",
          "value": "polarArea"
        }
      ]
    },
    {
      "displayName": "Add Labels",
      "name": "labelsMode",
      "type": "options",
      "default": "manually",
      "options": [
        {
          "name": "Manually",
          "value": "manually"
        },
        {
          "name": "From Array",
          "value": "array"
        }
      ]
    },
    {
      "displayName": "Labels",
      "name": "labelsUi",
      "type": "fixedCollection",
      "default": {},
      "description": "Labels to use in the chart",
      "options": [
        {
          "name": "labelsValues",
          "displayName": "Labels",
          "values": [
            {
              "displayName": "Label",
              "name": "label",
              "type": "string",
              "default": ""
            }
          ]
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "labelsMode": [
            "manually"
          ]
        }
      },
      "typeOptions": {
        "multipleValues": true,
        "sortable": true
      }
    },
    {
      "displayName": "Labels Array",
      "name": "labelsArray",
      "type": "string",
      "default": "",
      "description": "The array of labels to be used in the chart",
      "required": true,
      "displayOptions": {
        "show": {
          "labelsMode": [
            "array"
          ]
        }
      }
    },
    {
      "displayName": "Data",
      "name": "data",
      "type": "json",
      "default": "",
      "description": "Data to use for the dataset, documentation and examples <a href=\"https://quickchart.io/documentation/chart-types/\" target=\"_blank\">here</a>",
      "required": true
    },
    {
      "displayName": "Put Output In Field",
      "name": "output",
      "type": "string",
      "default": "data",
      "description": "The binary data will be displayed in the Output panel on the right, under the Binary tab",
      "required": true
    },
    {
      "displayName": "Chart Options",
      "name": "chartOptions",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Background Color",
          "name": "backgroundColor",
          "type": "color",
          "typeOptions": {
            "showAlpha": true
          },
          "default": "",
          "description": "Background color of the chart"
        },
        {
          "displayName": "Device Pixel Ratio",
          "name": "devicePixelRatio",
          "type": "number",
          "default": 2,
          "typeOptions": {
            "minValue": 1,
            "maxValue": 2
          },
          "description": "Pixel ratio of the chart"
        },
        {
          "displayName": "Format",
          "name": "format",
          "type": "options",
          "default": "png",
          "description": "File format of the resulting chart",
          "options": [
            {
              "name": "PNG",
              "value": "png"
            },
            {
              "name": "PDF",
              "value": "pdf"
            },
            {
              "name": "SVG",
              "value": "svg"
            },
            {
              "name": "WebP",
              "value": "webp"
            }
          ]
        },
        {
          "displayName": "Height",
          "name": "height",
          "type": "number",
          "default": 300,
          "description": "Height of the chart"
        },
        {
          "displayName": "Horizontal",
          "name": "horizontal",
          "type": "boolean",
          "default": false,
          "description": "Whether the chart should use its Y axis horizontal",
          "displayOptions": {
            "show": {
              "/chartType": [
                "bar",
                "boxplot",
                "violin"
              ]
            }
          }
        },
        {
          "displayName": "Width",
          "name": "width",
          "type": "number",
          "default": 500,
          "description": "Width of the chart"
        }
      ]
    },
    {
      "displayName": "Dataset Options",
      "name": "datasetOptions",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Background Color",
          "name": "backgroundColor",
          "type": "color",
          "default": "",
          "typeOptions": {
            "showAlpha": true
          },
          "description": "Color used for the background the dataset (area of a line graph, fill of a bar chart, etc.)"
        },
        {
          "displayName": "Border Color",
          "name": "borderColor",
          "type": "color",
          "typeOptions": {
            "showAlpha": true
          },
          "default": "",
          "description": "Color used for lines of the dataset"
        },
        {
          "displayName": "Fill",
          "name": "fill",
          "type": "boolean",
          "default": true,
          "description": "Whether to fill area of the dataset",
          "displayOptions": {
            "show": {
              "/chartType": [
                "line"
              ]
            }
          }
        },
        {
          "displayName": "Label",
          "name": "label",
          "type": "string",
          "default": "",
          "description": "The label of the dataset"
        },
        {
          "displayName": "Point Style",
          "name": "pointStyle",
          "type": "options",
          "default": "circle",
          "description": "Style to use for points of the dataset",
          "options": [
            {
              "name": "Circle",
              "value": "circle"
            },
            {
              "name": "Cross",
              "value": "cross"
            },
            {
              "name": "CrossRot",
              "value": "crossRot"
            },
            {
              "name": "Dash",
              "value": "dash"
            },
            {
              "name": "Line",
              "value": "line"
            },
            {
              "name": "Rect",
              "value": "rect"
            },
            {
              "name": "Rect Rot",
              "value": "rectRot"
            },
            {
              "name": "Rect Rounded",
              "value": "rectRounded"
            },
            {
              "name": "Star",
              "value": "star"
            },
            {
              "name": "Triangle",
              "value": "triangle"
            }
          ],
          "displayOptions": {
            "show": {
              "/chartType": [
                "line"
              ]
            }
          }
        }
      ]
    }
  ]


node_type: nodes-base.quickChart
package_name: n8n-nodes-base
display_name: QuickChart
description: Create a chart via QuickChart
category: output
development_style: programmatic
version: 1
operations: []
credentials_required: []
outputs:
  [
  "main"
  ]

updated_at: 2026-04-16 09:43:09
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: QuickChart node documentation
  description: Learn how to use the QuickChart node in n8n. Follow technical documentation to integrate QuickChart node into your workflows.
  contentType: [integration, reference]
  priority: medium
  ---

  # QuickChart node

  Use the QuickChart node to automate work in QuickChart, and integrate QuickChart with other applications. n8n has built-in support for a wide range of QuickChart chart types, including bar, doughnut, line, pie, and polar charts.

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

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

  ## Operations

  Create a chart by selecting the chart type:

  * Chart Type
  	* Bar Chart
  	* Doughnut Chart
  	* Line Chart
  	* Pie Chart
  	* Polar Chart

  ## Templates and examples

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

  ## Related resources

  Refer to [QuickChart's API documentation](https://quickchart.io/documentation/){:target=_blank .external-link} for more information about the service.

properties_schema:
  [
    {
      "displayName": "Chart Type",
      "name": "chartType",
      "type": "options",
      "default": "bar",
      "description": "The type of chart to create",
      "options": [
        {
          "name": "Bar Chart",
          "value": "bar"
        },
        {
          "name": "Doughnut Chart",
          "value": "doughnut"
        },
        {
          "name": "Line Chart",
          "value": "line"
        },
        {
          "name": "Pie Chart",
          "value": "pie"
        },
        {
          "name": "Polar Chart",
          "value": "polarArea"
        }
      ]
    },
    {
      "displayName": "Add Labels",
      "name": "labelsMode",
      "type": "options",
      "default": "manually",
      "options": [
        {
          "name": "Manually",
          "value": "manually"
        },
        {
          "name": "From Array",
          "value": "array"
        }
      ]
    },
    {
      "displayName": "Labels",
      "name": "labelsUi",
      "type": "fixedCollection",
      "default": {},
      "description": "Labels to use in the chart",
      "options": [
        {
          "name": "labelsValues",
          "displayName": "Labels",
          "values": [
            {
              "displayName": "Label",
              "name": "label",
              "type": "string",
              "default": ""
            }
          ]
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "labelsMode": [
            "manually"
          ]
        }
      },
      "typeOptions": {
        "multipleValues": true,
        "sortable": true
      }
    },
    {
      "displayName": "Labels Array",
      "name": "labelsArray",
      "type": "string",
      "default": "",
      "description": "The array of labels to be used in the chart",
      "required": true,
      "displayOptions": {
        "show": {
          "labelsMode": [
            "array"
          ]
        }
      }
    },
    {
      "displayName": "Data",
      "name": "data",
      "type": "json",
      "default": "",
      "description": "Data to use for the dataset, documentation and examples <a href=\"https://quickchart.io/documentation/chart-types/\" target=\"_blank\">here</a>",
      "required": true
    },
    {
      "displayName": "Put Output In Field",
      "name": "output",
      "type": "string",
      "default": "data",
      "description": "The binary data will be displayed in the Output panel on the right, under the Binary tab",
      "required": true
    },
    {
      "displayName": "Chart Options",
      "name": "chartOptions",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Background Color",
          "name": "backgroundColor",
          "type": "color",
          "typeOptions": {
            "showAlpha": true
          },
          "default": "",
          "description": "Background color of the chart"
        },
        {
          "displayName": "Device Pixel Ratio",
          "name": "devicePixelRatio",
          "type": "number",
          "default": 2,
          "typeOptions": {
            "minValue": 1,
            "maxValue": 2
          },
          "description": "Pixel ratio of the chart"
        },
        {
          "displayName": "Format",
          "name": "format",
          "type": "options",
          "default": "png",
          "description": "File format of the resulting chart",
          "options": [
            {
              "name": "PNG",
              "value": "png"
            },
            {
              "name": "PDF",
              "value": "pdf"
            },
            {
              "name": "SVG",
              "value": "svg"
            },
            {
              "name": "WebP",
              "value": "webp"
            }
          ]
        },
        {
          "displayName": "Height",
          "name": "height",
          "type": "number",
          "default": 300,
          "description": "Height of the chart"
        },
        {
          "displayName": "Horizontal",
          "name": "horizontal",
          "type": "boolean",
          "default": false,
          "description": "Whether the chart should use its Y axis horizontal",
          "displayOptions": {
            "show": {
              "/chartType": [
                "bar",
                "boxplot",
                "violin"
              ]
            }
          }
        },
        {
          "displayName": "Width",
          "name": "width",
          "type": "number",
          "default": 500,
          "description": "Width of the chart"
        }
      ]
    },
    {
      "displayName": "Dataset Options",
      "name": "datasetOptions",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Background Color",
          "name": "backgroundColor",
          "type": "color",
          "default": "",
          "typeOptions": {
            "showAlpha": true
          },
          "description": "Color used for the background the dataset (area of a line graph, fill of a bar chart, etc.)"
        },
        {
          "displayName": "Border Color",
          "name": "borderColor",
          "type": "color",
          "typeOptions": {
            "showAlpha": true
          },
          "default": "",
          "description": "Color used for lines of the dataset"
        },
        {
          "displayName": "Fill",
          "name": "fill",
          "type": "boolean",
          "default": true,
          "description": "Whether to fill area of the dataset",
          "displayOptions": {
            "show": {
              "/chartType": [
                "line"
              ]
            }
          }
        },
        {
          "displayName": "Label",
          "name": "label",
          "type": "string",
          "default": "",
          "description": "The label of the dataset"
        },
        {
          "displayName": "Point Style",
          "name": "pointStyle",
          "type": "options",
          "default": "circle",
          "description": "Style to use for points of the dataset",
          "options": [
            {
              "name": "Circle",
              "value": "circle"
            },
            {
              "name": "Cross",
              "value": "cross"
            },
            {
              "name": "CrossRot",
              "value": "crossRot"
            },
            {
              "name": "Dash",
              "value": "dash"
            },
            {
              "name": "Line",
              "value": "line"
            },
            {
              "name": "Rect",
              "value": "rect"
            },
            {
              "name": "Rect Rot",
              "value": "rectRot"
            },
            {
              "name": "Rect Rounded",
              "value": "rectRounded"
            },
            {
              "name": "Star",
              "value": "star"
            },
            {
              "name": "Triangle",
              "value": "triangle"
            }
          ],
          "displayOptions": {
            "show": {
              "/chartType": [
                "line"
              ]
            }
          }
        }
      ]
    }
  ]


node_type: nodes-base.rabbitmqTool
package_name: n8n-nodes-base
display_name: RabbitMQ Tool
description: Sends messages to a RabbitMQ topic (AI Tool variant for use with AI Agents)
category: transform
development_style: programmatic
version: 1.1
credentials_required:
  [
  {
  "name": "rabbitmq",
  "required": true,
  "testedBy": "rabbitmqConnectionTest"
  }
  ]

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

output_names:
  [
  "Tool"
  ]

updated_at: 2026-04-16 09:43:09
tool_variant_of: nodes-base.rabbitmq
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: RabbitMQ node documentation
  description: Learn how to use the RabbitMQ node in n8n. Follow technical documentation to integrate RabbitMQ node into your workflows.
  contentType: [integration, reference]
  priority: medium
  ---

  # RabbitMQ node

  Use the RabbitMQ node to automate work in RabbitMQ, and integrate RabbitMQ with other applications. n8n has built-in support for a wide range of RabbitMQ features, including accepting, and forwarding messages. 

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

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

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

  ## Operations

  * Delete From Queue
  * Send a Message to RabbitMQ

  ## Templates and examples

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

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 RabbitMQ"
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "hidden",
      "default": "sendMessage",
      "options": [
        {
          "name": "Send a Message to RabbitMQ",
          "value": "sendMessage",
          "action": "Send a Message to RabbitMQ"
        },
        {
          "name": "Delete From Queue",
          "value": "deleteMessage",
          "action": "Delete From Queue"
        }
      ],
      "displayOptions": {
        "show": {
          "@version": [
            1
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "sendMessage",
      "options": [
        {
          "name": "Send a Message to RabbitMQ",
          "value": "sendMessage",
          "action": "Send a Message to RabbitMQ"
        },
        {
          "name": "Delete From Queue",
          "value": "deleteMessage",
          "action": "Delete From Queue"
        }
      ],
      "displayOptions": {
        "show": {
          "@version": [
            1.1
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Will delete an item from the queue triggered earlier in the workflow by a RabbitMQ Trigger node",
      "name": "deleteMessage",
      "type": "notice",
      "default": "",
      "displayOptions": {
        "show": {
          "operation": [
            "deleteMessage"
          ]
        }
      }
    },
    {
      "displayName": "Mode",
      "name": "mode",
      "type": "options",
      "default": "queue",
      "description": "To where data should be moved",
      "options": [
        {
          "name": "Queue",
          "value": "queue",
          "description": "Publish data to queue"
        },
        {
          "name": "Exchange",
          "value": "exchange",
          "description": "Publish data to exchange"
        }
      ],
      "displayOptions": {
        "hide": {
          "operation": [
            "deleteMessage"
          ]
        }
      }
    },
    {
      "displayName": "Queue / Topic",
      "name": "queue",
      "type": "string",
      "default": "",
      "description": "Name of the queue to publish to",
      "displayOptions": {
        "show": {
          "mode": [
            "queue"
          ]
        },
        "hide": {
          "operation": [
            "deleteMessage"
          ]
        }
      }
    },
    {
      "displayName": "Exchange",
      "name": "exchange",
      "type": "string",
      "default": "",
      "description": "Name of the exchange to publish to",
      "displayOptions": {
        "show": {
          "mode": [
            "exchange"
          ]
        }
      }
    },
    {
      "displayName": "Type",
      "name": "exchangeType",
      "type": "options",
      "default": "fanout",
      "description": "Type of exchange",
      "options": [
        {
          "name": "Direct",
          "value": "direct",
          "description": "Direct exchange type"
        },
        {
          "name": "Topic",
          "value": "topic",
          "description": "Topic exchange type"
        },
        {
          "name": "Headers",
          "value": "headers",
          "description": "Headers exchange type"
        },
        {
          "name": "Fanout",
          "value": "fanout",
          "description": "Fanout exchange type"
        }
      ],
      "displayOptions": {
        "show": {
          "mode": [
            "exchange"
          ]
        }
      }
    },
    {
      "displayName": "Routing Key",
      "name": "routingKey",
      "type": "string",
      "default": "",
      "description": "The routing key for the message",
      "displayOptions": {
        "show": {
          "mode": [
            "exchange"
          ]
        }
      }
    },
    {
      "displayName": "Send Input Data",
      "name": "sendInputData",
      "type": "boolean",
      "default": true,
      "description": "Whether to send the data the node receives as JSON",
      "displayOptions": {
        "show": {
          "operation": [
            "sendMessage"
          ]
        }
      }
    },
    {
      "displayName": "Message",
      "name": "message",
      "type": "string",
      "default": "",
      "description": "The message to be sent",
      "displayOptions": {
        "show": {
          "sendInputData": [
            false
          ]
        }
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Alternate Exchange",
          "name": "alternateExchange",
          "type": "string",
          "displayOptions": {
            "show": {
              "/mode": [
                "exchange"
              ]
            }
          },
          "default": "",
          "description": "An exchange to send messages to if this exchange can’t route them to any queues"
        },
        {
          "displayName": "Arguments",
          "name": "arguments",
          "placeholder": "Add Argument",
          "description": "Arguments to add, See <a href=\"https://amqp-node.github.io/amqplib/channel_api.html#channel_publish\" target=\"_blank\">here</a> for valid options",
          "type": "fixedCollection",
          "typeOptions": {
            "multipleValues": true
          },
          "default": {},
          "options": [
            {
              "name": "argument",
              "displayName": "Argument",
              "values": [
                {
                  "displayName": "Key",
                  "name": "key",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Value",
                  "name": "value",
                  "type": "string",
                  "default": ""
                }
              ]
            }
          ]
        },
        {
          "displayName": "Auto Delete Queue",
          "name": "autoDelete",
          "type": "boolean",
          "default": false,
          "description": "Whether the queue will be deleted when the number of consumers drops to zero"
        },
        {
          "displayName": "Durable",
          "name": "durable",
          "type": "boolean",
          "default": true,
          "description": "Whether the queue will survive broker restarts"
        },
        {
          "displayName": "Exclusive",
          "name": "exclusive",
          "type": "boolean",
          "displayOptions": {
            "show": {
              "/mode": [
                "queue"
              ]
            }
          },
          "default": false,
          "description": "Whether to scope the queue to the connection"
        },
        {
          "displayName": "Headers",
          "name": "headers",
          "placeholder": "Add Header",
          "description": "Headers to add",
          "type": "fixedCollection",
          "typeOptions": {
            "multipleValues": true
          },
          "default": {},
          "options": [
            {
              "name": "header",
              "displayName": "Header",
              "values": [
                {
                  "displayName": "Key",
                  "name": "key",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Value",
                  "name": "value",
                  "type": "string",
                  "default": ""
                }
              ]
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "sendMessage"
          ]
        }
      }
    }
  ]

operations:
  [
    {
      "operation": "sendMessage",
      "name": "Send a Message to RabbitMQ"
    },
    {
      "operation": "deleteMessage",
      "name": "Delete From Queue"
    },
    {
      "operation": "sendMessage",
      "name": "Send a Message to RabbitMQ"
    },
    {
      "operation": "deleteMessage",
      "name": "Delete From Queue"
    }
  ]


node_type: nodes-base.rabbitmq
package_name: n8n-nodes-base
display_name: RabbitMQ
description: Sends messages to a RabbitMQ topic
category: transform
development_style: programmatic
version: 1.1
credentials_required:
  [
  {
  "name": "rabbitmq",
  "required": true,
  "testedBy": "rabbitmqConnectionTest"
  }
  ]

outputs:
  [
  "main"
  ]

updated_at: 2026-04-16 09:43:09
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: RabbitMQ node documentation
  description: Learn how to use the RabbitMQ node in n8n. Follow technical documentation to integrate RabbitMQ node into your workflows.
  contentType: [integration, reference]
  priority: medium
  ---

  # RabbitMQ node

  Use the RabbitMQ node to automate work in RabbitMQ, and integrate RabbitMQ with other applications. n8n has built-in support for a wide range of RabbitMQ features, including accepting, and forwarding messages. 

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

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

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

  ## Operations

  * Delete From Queue
  * Send a Message to RabbitMQ

  ## Templates and examples

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

properties_schema:
  [
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "hidden",
      "default": "sendMessage",
      "options": [
        {
          "name": "Send a Message to RabbitMQ",
          "value": "sendMessage",
          "action": "Send a Message to RabbitMQ"
        },
        {
          "name": "Delete From Queue",
          "value": "deleteMessage",
          "action": "Delete From Queue"
        }
      ],
      "displayOptions": {
        "show": {
          "@version": [
            1
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "sendMessage",
      "options": [
        {
          "name": "Send a Message to RabbitMQ",
          "value": "sendMessage",
          "action": "Send a Message to RabbitMQ"
        },
        {
          "name": "Delete From Queue",
          "value": "deleteMessage",
          "action": "Delete From Queue"
        }
      ],
      "displayOptions": {
        "show": {
          "@version": [
            1.1
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Will delete an item from the queue triggered earlier in the workflow by a RabbitMQ Trigger node",
      "name": "deleteMessage",
      "type": "notice",
      "default": "",
      "displayOptions": {
        "show": {
          "operation": [
            "deleteMessage"
          ]
        }
      }
    },
    {
      "displayName": "Mode",
      "name": "mode",
      "type": "options",
      "default": "queue",
      "description": "To where data should be moved",
      "options": [
        {
          "name": "Queue",
          "value": "queue",
          "description": "Publish data to queue"
        },
        {
          "name": "Exchange",
          "value": "exchange",
          "description": "Publish data to exchange"
        }
      ],
      "displayOptions": {
        "hide": {
          "operation": [
            "deleteMessage"
          ]
        }
      }
    },
    {
      "displayName": "Queue / Topic",
      "name": "queue",
      "type": "string",
      "default": "",
      "description": "Name of the queue to publish to",
      "displayOptions": {
        "show": {
          "mode": [
            "queue"
          ]
        },
        "hide": {
          "operation": [
            "deleteMessage"
          ]
        }
      }
    },
    {
      "displayName": "Exchange",
      "name": "exchange",
      "type": "string",
      "default": "",
      "description": "Name of the exchange to publish to",
      "displayOptions": {
        "show": {
          "mode": [
            "exchange"
          ]
        }
      }
    },
    {
      "displayName": "Type",
      "name": "exchangeType",
      "type": "options",
      "default": "fanout",
      "description": "Type of exchange",
      "options": [
        {
          "name": "Direct",
          "value": "direct",
          "description": "Direct exchange type"
        },
        {
          "name": "Topic",
          "value": "topic",
          "description": "Topic exchange type"
        },
        {
          "name": "Headers",
          "value": "headers",
          "description": "Headers exchange type"
        },
        {
          "name": "Fanout",
          "value": "fanout",
          "description": "Fanout exchange type"
        }
      ],
      "displayOptions": {
        "show": {
          "mode": [
            "exchange"
          ]
        }
      }
    },
    {
      "displayName": "Routing Key",
      "name": "routingKey",
      "type": "string",
      "default": "",
      "description": "The routing key for the message",
      "displayOptions": {
        "show": {
          "mode": [
            "exchange"
          ]
        }
      }
    },
    {
      "displayName": "Send Input Data",
      "name": "sendInputData",
      "type": "boolean",
      "default": true,
      "description": "Whether to send the data the node receives as JSON",
      "displayOptions": {
        "show": {
          "operation": [
            "sendMessage"
          ]
        }
      }
    },
    {
      "displayName": "Message",
      "name": "message",
      "type": "string",
      "default": "",
      "description": "The message to be sent",
      "displayOptions": {
        "show": {
          "sendInputData": [
            false
          ]
        }
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Alternate Exchange",
          "name": "alternateExchange",
          "type": "string",
          "displayOptions": {
            "show": {
              "/mode": [
                "exchange"
              ]
            }
          },
          "default": "",
          "description": "An exchange to send messages to if this exchange can’t route them to any queues"
        },
        {
          "displayName": "Arguments",
          "name": "arguments",
          "placeholder": "Add Argument",
          "description": "Arguments to add, See <a href=\"https://amqp-node.github.io/amqplib/channel_api.html#channel_publish\" target=\"_blank\">here</a> for valid options",
          "type": "fixedCollection",
          "typeOptions": {
            "multipleValues": true
          },
          "default": {},
          "options": [
            {
              "name": "argument",
              "displayName": "Argument",
              "values": [
                {
                  "displayName": "Key",
                  "name": "key",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Value",
                  "name": "value",
                  "type": "string",
                  "default": ""
                }
              ]
            }
          ]
        },
        {
          "displayName": "Auto Delete Queue",
          "name": "autoDelete",
          "type": "boolean",
          "default": false,
          "description": "Whether the queue will be deleted when the number of consumers drops to zero"
        },
        {
          "displayName": "Durable",
          "name": "durable",
          "type": "boolean",
          "default": true,
          "description": "Whether the queue will survive broker restarts"
        },
        {
          "displayName": "Exclusive",
          "name": "exclusive",
          "type": "boolean",
          "displayOptions": {
            "show": {
              "/mode": [
                "queue"
              ]
            }
          },
          "default": false,
          "description": "Whether to scope the queue to the connection"
        },
        {
          "displayName": "Headers",
          "name": "headers",
          "placeholder": "Add Header",
          "description": "Headers to add",
          "type": "fixedCollection",
          "typeOptions": {
            "multipleValues": true
          },
          "default": {},
          "options": [
            {
              "name": "header",
              "displayName": "Header",
              "values": [
                {
                  "displayName": "Key",
                  "name": "key",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Value",
                  "name": "value",
                  "type": "string",
                  "default": ""
                }
              ]
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "sendMessage"
          ]
        }
      }
    }
  ]

operations:
  [
    {
      "operation": "sendMessage",
      "name": "Send a Message to RabbitMQ"
    },
    {
      "operation": "deleteMessage",
      "name": "Delete From Queue"
    },
    {
      "operation": "sendMessage",
      "name": "Send a Message to RabbitMQ"
    },
    {
      "operation": "deleteMessage",
      "name": "Delete From Queue"
    }
  ]


node_type: nodes-base.rabbitmqTrigger
package_name: n8n-nodes-base
display_name: RabbitMQ Trigger
description: Listens to RabbitMQ messages
category: trigger
development_style: programmatic
version: 1
operations: []
credentials_required:
  [
  {
  "name": "rabbitmq",
  "required": true
  }
  ]

outputs:
  [
  "main"
  ]

updated_at: 2026-04-16 09:43:09
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: RabbitMQ Trigger node documentation
  description: Learn how to use the RabbitMQ Trigger node in n8n. Follow technical documentation to integrate RabbitMQ Trigger node into your workflows.
  contentType: [integration, reference]
  priority: medium
  ---

  # RabbitMQ Trigger node

  [RabbitMQ](https://www.rabbitmq.com){:target=_blank .external-link} is an open-source message broker that accepts and forwards messages.

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

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

  ## Related resources

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

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

properties_schema:
  [
    {
      "displayName": "Queue / Topic",
      "name": "queue",
      "type": "string",
      "default": "",
      "description": "The name of the queue to read from"
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Arguments",
          "name": "arguments",
          "placeholder": "Add Argument",
          "description": "Arguments to add",
          "type": "fixedCollection",
          "typeOptions": {
            "multipleValues": true
          },
          "default": {},
          "options": [
            {
              "name": "argument",
              "displayName": "Argument",
              "values": [
                {
                  "displayName": "Key",
                  "name": "key",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Value",
                  "name": "value",
                  "type": "string",
                  "default": ""
                }
              ]
            }
          ]
        },
        {
          "displayName": "Assert Exchange",
          "name": "assertExchange",
          "type": "boolean",
          "default": true,
          "description": "Whether to assert the exchange exists before sending"
        },
        {
          "displayName": "Assert Queue",
          "name": "assertQueue",
          "type": "boolean",
          "default": true,
          "description": "Whether to assert the queue exists before sending"
        },
        {
          "displayName": "Auto Delete Queue",
          "name": "autoDelete",
          "type": "boolean",
          "default": false,
          "description": "Whether the queue will be deleted when the number of consumers drops to zero"
        },
        {
          "displayName": "Binding",
          "name": "binding",
          "placeholder": "Add Binding",
          "description": "Add binding to queu",
          "type": "fixedCollection",
          "typeOptions": {
            "multipleValues": true
          },
          "default": {},
          "options": [
            {
              "name": "bindings",
              "displayName": "Binding",
              "values": [
                {
                  "displayName": "Exchange",
                  "name": "exchange",
                  "type": "string",
                  "default": "",
                  "placeholder": "exchange"
                },
                {
                  "displayName": "RoutingKey",
                  "name": "routingKey",
                  "type": "string",
                  "default": "",
                  "placeholder": "routing-key"
                }
              ]
            }
          ]
        },
        {
          "displayName": "Content Is Binary",
          "name": "contentIsBinary",
          "type": "boolean",
          "default": false,
          "description": "Whether to save the content as binary"
        },
        {
          "displayName": "Delete From Queue When",
          "name": "acknowledge",
          "type": "options",
          "options": [
            {
              "name": "Execution Finishes",
              "value": "executionFinishes",
              "description": "After the workflow execution finished. No matter if the execution was successful or not."
            },
            {
              "name": "Execution Finishes Successfully",
              "value": "executionFinishesSuccessfully",
              "description": "After the workflow execution finished successfully"
            },
            {
              "name": "Immediately",
              "value": "immediately",
              "description": "As soon as the message got received"
            },
            {
              "name": "Specified Later in Workflow",
              "value": "laterMessageNode",
              "description": "Using a RabbitMQ node to remove the item from the queue"
            }
          ],
          "default": "immediately",
          "description": "When to acknowledge the message"
        },
        {
          "displayName": "Durable",
          "name": "durable",
          "type": "boolean",
          "default": true,
          "description": "Whether the queue will survive broker restarts"
        },
        {
          "displayName": "Exclusive",
          "name": "exclusive",
          "type": "boolean",
          "default": false,
          "description": "Whether to scope the queue to the connection"
        },
        {
          "displayName": "Headers",
          "name": "headers",
          "placeholder": "Add Header",
          "description": "Headers to add",
          "type": "fixedCollection",
          "typeOptions": {
            "multipleValues": true
          },
          "default": {},
          "options": [
            {
              "name": "header",
              "displayName": "Header",
              "values": [
                {
                  "displayName": "Key",
                  "name": "key",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Value",
                  "name": "value",
                  "type": "string",
                  "default": ""
                }
              ]
            }
          ]
        },
        {
          "displayName": "JSON Parse Body",
          "name": "jsonParseBody",
          "type": "boolean",
          "displayOptions": {
            "hide": {
              "contentIsBinary": [
                true
              ]
            }
          },
          "default": false,
          "description": "Whether to parse the body to an object"
        },
        {
          "displayName": "Only Content",
          "name": "onlyContent",
          "type": "boolean",
          "displayOptions": {
            "hide": {
              "contentIsBinary": [
                true
              ]
            }
          },
          "default": false,
          "description": "Whether to return only the content property"
        },
        {
          "displayName": "Parallel Message Processing Limit",
          "name": "parallelMessages",
          "type": "number",
          "default": -1,
          "displayOptions": {
            "hide": {
              "acknowledge": [
                "immediately"
              ]
            }
          },
          "description": "Max number of executions at a time. Use -1 for no limit."
        }
      ]
    },
    {
      "displayName": "To delete an item from the queue, insert a RabbitMQ node later in the workflow and use the 'Delete from queue' operation",
      "name": "laterMessageNode",
      "type": "notice",
      "default": "",
      "displayOptions": {
        "show": {
          "/options.acknowledge": [
            "laterMessageNode"
          ]
        }
      }
    }
  ]


node_type: nodes-base.raindropTool
package_name: n8n-nodes-base
display_name: Raindrop Tool
description: Consume the Raindrop API (AI Tool variant for use with AI Agents)
category: transform
development_style: programmatic
version: 1
credentials_required:
  [
  {
  "name": "raindropOAuth2Api",
  "required": true
  }
  ]

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

output_names:
  [
  "Tool"
  ]

updated_at: 2026-04-16 09:43:09
tool_variant_of: nodes-base.raindrop
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: Raindrop node documentation
  description: Learn how to use the Raindrop node in n8n. Follow technical documentation to integrate Raindrop node into your workflows.
  contentType: [integration, reference]
  ---

  # Raindrop node

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

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

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

  ## Operations

  * Bookmark
      * Create
      * Delete
      * Get
      * Get All
      * Update
  * Collection
      * Create
      * Delete
      * Get
      * Get All
      * Update
  * Tag
      * Delete
      * Get All
  * User
      * Get

  ## Templates and examples

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

  --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 Raindrop"
    },
    {
      "displayName": "Resource",
      "name": "resource",
      "type": "options",
      "default": "collection",
      "options": [
        {
          "name": "Bookmark",
          "value": "bookmark"
        },
        {
          "name": "Collection",
          "value": "collection"
        },
        {
          "name": "Tag",
          "value": "tag"
        },
        {
          "name": "User",
          "value": "user"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "get",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "action": "Create a bookmark"
        },
        {
          "name": "Delete",
          "value": "delete",
          "action": "Delete a bookmark"
        },
        {
          "name": "Get",
          "value": "get",
          "action": "Get a bookmark"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "action": "Get many bookmarks"
        },
        {
          "name": "Update",
          "value": "update",
          "action": "Update a bookmark"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "bookmark"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Collection Name or ID",
      "name": "collectionId",
      "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": [
            "bookmark"
          ],
          "operation": [
            "create"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getCollections"
      }
    },
    {
      "displayName": "Link",
      "name": "link",
      "type": "string",
      "default": "",
      "description": "Link of the bookmark to be created",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "bookmark"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Important",
          "name": "important",
          "type": "boolean",
          "default": false,
          "description": "Whether this bookmark is marked as favorite"
        },
        {
          "displayName": "Order",
          "name": "order",
          "type": "number",
          "default": 0,
          "description": "Sort order for the bookmark. For example, to move it to first place, enter 0."
        },
        {
          "displayName": "Parse Metadata",
          "name": "pleaseParse",
          "type": "boolean",
          "default": false,
          "description": "Whether Raindrop should load cover, description and HTML for the URL"
        },
        {
          "displayName": "Tags",
          "name": "tags",
          "type": "string",
          "default": "",
          "description": "Bookmark tags. Multiple tags can be set separated by comma."
        },
        {
          "displayName": "Title",
          "name": "title",
          "type": "string",
          "default": "",
          "description": "Title of the bookmark to create"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "bookmark"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Bookmark ID",
      "name": "bookmarkId",
      "type": "string",
      "default": "",
      "description": "The ID of the bookmark to delete",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "bookmark"
          ],
          "operation": [
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "Bookmark ID",
      "name": "bookmarkId",
      "type": "string",
      "default": "",
      "description": "The ID of the bookmark to retrieve",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "bookmark"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Collection Name or ID",
      "name": "collectionId",
      "type": "options",
      "default": [],
      "description": "The ID of the collection from which to retrieve all bookmarks. 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": [
            "bookmark"
          ],
          "operation": [
            "getAll"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getCollections"
      }
    },
    {
      "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": [
            "bookmark"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 5,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "bookmark"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 10
      }
    },
    {
      "displayName": "Bookmark ID",
      "name": "bookmarkId",
      "type": "string",
      "default": "",
      "description": "The ID of the bookmark to update",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "bookmark"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Update Fields",
      "name": "updateFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Collection Name or ID",
          "name": "collectionId",
          "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": "getCollections"
          },
          "default": ""
        },
        {
          "displayName": "Important",
          "name": "important",
          "type": "boolean",
          "default": false,
          "description": "Whether this bookmark is marked as favorite"
        },
        {
          "displayName": "Order",
          "name": "order",
          "type": "number",
          "default": 0,
          "description": "For example if you want to move bookmark to the first place set this field to 0"
        },
        {
          "displayName": "Parse Metadata",
          "name": "pleaseParse",
          "type": "boolean",
          "default": false,
          "description": "Whether Raindrop should reload cover, description and HTML for the URL"
        },
        {
          "displayName": "Tags",
          "name": "tags",
          "type": "string",
          "default": "",
          "description": "Bookmark tags. Multiple tags can be set separated by comma."
        },
        {
          "displayName": "Title",
          "name": "title",
          "type": "string",
          "default": "",
          "description": "Title of the bookmark to be created"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "bookmark"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "get",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "action": "Create a collection"
        },
        {
          "name": "Delete",
          "value": "delete",
          "action": "Delete a collection"
        },
        {
          "name": "Get",
          "value": "get",
          "action": "Get a collection"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "action": "Get many collections"
        },
        {
          "name": "Update",
          "value": "update",
          "action": "Update a collection"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "collection"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Title",
      "name": "title",
      "type": "string",
      "default": "",
      "description": "Title of the collection to create",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "collection"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Cover",
          "name": "cover",
          "type": "string",
          "default": "",
          "description": "URL of an image to use as cover for the collection"
        },
        {
          "displayName": "Public",
          "name": "public",
          "type": "boolean",
          "default": false,
          "description": "Whether the collection will be accessible without authentication"
        },
        {
          "displayName": "Parent ID",
          "name": "parentId",
          "type": "string",
          "default": "",
          "description": "ID of this collection's parent collection, if it is a child collection"
        },
        {
          "displayName": "Sort Order",
          "name": "sort",
          "type": "number",
          "default": 1,
          "description": "Descending sort order of this collection. The number is the position of the collection among all the collections with the same parent ID."
        },
        {
          "displayName": "View",
          "name": "view",
          "type": "options",
          "default": "list",
          "description": "View style of this collection",
          "options": [
            {
              "name": "List",
              "value": "list"
            },
            {
              "name": "Simple",
              "value": "simple"
            },
            {
              "name": "Grid",
              "value": "grid"
            },
            {
              "name": "Masonry",
              "value": "Masonry"
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "collection"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Collection ID",
      "name": "collectionId",
      "type": "string",
      "default": "",
      "description": "The ID of the collection to delete",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "collection"
          ],
          "operation": [
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "Collection ID",
      "name": "collectionId",
      "type": "string",
      "default": "",
      "description": "The ID of the collection to retrieve",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "collection"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Type",
      "name": "type",
      "type": "options",
      "default": "parent",
      "options": [
        {
          "name": "Parent",
          "value": "parent",
          "description": "Root-level collections"
        },
        {
          "name": "Children",
          "value": "children",
          "description": "Nested collections"
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "collection"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Return All",
      "name": "returnAll",
      "type": "boolean",
      "default": false,
      "description": "Whether to return all results or only up to a given limit",
      "displayOptions": {
        "show": {
          "resource": [
            "collection"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 5,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "collection"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 10
      }
    },
    {
      "displayName": "Collection ID",
      "name": "collectionId",
      "type": "string",
      "default": "",
      "description": "The ID of the collection to update",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "collection"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Update Fields",
      "name": "updateFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Cover",
          "name": "cover",
          "type": "string",
          "default": "data",
          "placeholder": "",
          "description": "Name of the binary property containing the data for the image to upload as a cover"
        },
        {
          "displayName": "Public",
          "name": "public",
          "type": "boolean",
          "default": false,
          "description": "Whether the collection will be accessible without authentication"
        },
        {
          "displayName": "Parent ID",
          "name": "parentId",
          "type": "string",
          "default": "",
          "description": "ID of this collection's parent collection, if it is a child collection"
        },
        {
          "displayName": "Sort Order",
          "name": "sort",
          "type": "number",
          "default": 1,
          "description": "Descending sort order of this collection. The number is the position of the collection among all the collections with the same parent ID."
        },
        {
          "displayName": "Title",
          "name": "title",
          "type": "string",
          "default": "",
          "description": "Title of the collection to update"
        },
        {
          "displayName": "View",
          "name": "view",
          "type": "options",
          "default": "list",
          "description": "View style of this collection",
          "options": [
            {
              "name": "List",
              "value": "list"
            },
            {
              "name": "Simple",
              "value": "simple"
            },
            {
              "name": "Grid",
              "value": "grid"
            },
            {
              "name": "Masonry",
              "value": "Masonry"
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "collection"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "get",
      "options": [
        {
          "name": "Delete",
          "value": "delete",
          "action": "Delete a tag"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "action": "Get many tags"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "tag"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Tags",
      "name": "tags",
      "type": "string",
      "default": "",
      "description": "One or more tags to delete. Enter comma-separated values to delete multiple tags.",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "tag"
          ],
          "operation": [
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Collection Name or ID",
          "name": "collectionId",
          "type": "options",
          "typeOptions": {
            "loadOptionsMethod": "getCollections"
          },
          "default": "",
          "description": "It's possible to restrict remove action to just one collection. It's optional. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "tag"
          ],
          "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": [
            "tag"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 5,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "tag"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 10
      }
    },
    {
      "displayName": "Filters",
      "name": "filters",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Collection Name or ID",
          "name": "collectionId",
          "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": "getCollections"
          },
          "default": ""
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "tag"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "get",
      "options": [
        {
          "name": "Get",
          "value": "get",
          "action": "Get a user"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Self",
      "name": "self",
      "type": "boolean",
      "default": true,
      "description": "Whether to return details on the logged-in user",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "User ID",
      "name": "userId",
      "type": "string",
      "default": "",
      "description": "The ID of the user to retrieve",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "get"
          ],
          "self": [
            false
          ]
        }
      }
    }
  ]

operations:
  [
    {
      "operation": "create",
      "name": "Create",
      "resource": "bookmark"
    },
    {
      "operation": "delete",
      "name": "Delete",
      "resource": "bookmark"
    },
    {
      "operation": "get",
      "name": "Get",
      "resource": "bookmark"
    },
    {
      "operation": "getAll",
      "name": "Get Many",
      "resource": "bookmark"
    },
    {
      "operation": "update",
      "name": "Update",
      "resource": "bookmark"
    },
    {
      "operation": "create",
      "name": "Create",
      "resource": "collection"
    },
    {
      "operation": "delete",
      "name": "Delete",
      "resource": "collection"
    },
    {
      "operation": "get",
      "name": "Get",
      "resource": "collection"
    },
    {
      "operation": "getAll",
      "name": "Get Many",
      "resource": "collection"
    },
    {
      "operation": "update",
      "name": "Update",
      "resource": "collection"
    },
    {
      "operation": "delete",
      "name": "Delete",
      "resource": "tag"
    },
    {
      "operation": "getAll",
      "name": "Get Many",
      "resource": "tag"
    },
    {
      "operation": "get",
      "name": "Get",
      "resource": "user"
    }
  ]


node_type: nodes-base.raindrop
package_name: n8n-nodes-base
display_name: Raindrop
description: Consume the Raindrop API
category: transform
development_style: programmatic
version: 1
credentials_required:
  [
  {
  "name": "raindropOAuth2Api",
  "required": true
  }
  ]

outputs:
  [
  "main"
  ]

updated_at: 2026-04-16 09:43:09
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: Raindrop node documentation
  description: Learn how to use the Raindrop node in n8n. Follow technical documentation to integrate Raindrop node into your workflows.
  contentType: [integration, reference]
  ---

  # Raindrop node

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

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

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

  ## Operations

  * Bookmark
      * Create
      * Delete
      * Get
      * Get All
      * Update
  * Collection
      * Create
      * Delete
      * Get
      * Get All
      * Update
  * Tag
      * Delete
      * Get All
  * User
      * Get

  ## Templates and examples

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

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

properties_schema:
  [
    {
      "displayName": "Resource",
      "name": "resource",
      "type": "options",
      "default": "collection",
      "options": [
        {
          "name": "Bookmark",
          "value": "bookmark"
        },
        {
          "name": "Collection",
          "value": "collection"
        },
        {
          "name": "Tag",
          "value": "tag"
        },
        {
          "name": "User",
          "value": "user"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "get",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "action": "Create a bookmark"
        },
        {
          "name": "Delete",
          "value": "delete",
          "action": "Delete a bookmark"
        },
        {
          "name": "Get",
          "value": "get",
          "action": "Get a bookmark"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "action": "Get many bookmarks"
        },
        {
          "name": "Update",
          "value": "update",
          "action": "Update a bookmark"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "bookmark"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Collection Name or ID",
      "name": "collectionId",
      "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": [
            "bookmark"
          ],
          "operation": [
            "create"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getCollections"
      }
    },
    {
      "displayName": "Link",
      "name": "link",
      "type": "string",
      "default": "",
      "description": "Link of the bookmark to be created",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "bookmark"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Important",
          "name": "important",
          "type": "boolean",
          "default": false,
          "description": "Whether this bookmark is marked as favorite"
        },
        {
          "displayName": "Order",
          "name": "order",
          "type": "number",
          "default": 0,
          "description": "Sort order for the bookmark. For example, to move it to first place, enter 0."
        },
        {
          "displayName": "Parse Metadata",
          "name": "pleaseParse",
          "type": "boolean",
          "default": false,
          "description": "Whether Raindrop should load cover, description and HTML for the URL"
        },
        {
          "displayName": "Tags",
          "name": "tags",
          "type": "string",
          "default": "",
          "description": "Bookmark tags. Multiple tags can be set separated by comma."
        },
        {
          "displayName": "Title",
          "name": "title",
          "type": "string",
          "default": "",
          "description": "Title of the bookmark to create"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "bookmark"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Bookmark ID",
      "name": "bookmarkId",
      "type": "string",
      "default": "",
      "description": "The ID of the bookmark to delete",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "bookmark"
          ],
          "operation": [
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "Bookmark ID",
      "name": "bookmarkId",
      "type": "string",
      "default": "",
      "description": "The ID of the bookmark to retrieve",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "bookmark"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Collection Name or ID",
      "name": "collectionId",
      "type": "options",
      "default": [],
      "description": "The ID of the collection from which to retrieve all bookmarks. 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": [
            "bookmark"
          ],
          "operation": [
            "getAll"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getCollections"
      }
    },
    {
      "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": [
            "bookmark"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 5,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "bookmark"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 10
      }
    },
    {
      "displayName": "Bookmark ID",
      "name": "bookmarkId",
      "type": "string",
      "default": "",
      "description": "The ID of the bookmark to update",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "bookmark"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Update Fields",
      "name": "updateFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Collection Name or ID",
          "name": "collectionId",
          "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": "getCollections"
          },
          "default": ""
        },
        {
          "displayName": "Important",
          "name": "important",
          "type": "boolean",
          "default": false,
          "description": "Whether this bookmark is marked as favorite"
        },
        {
          "displayName": "Order",
          "name": "order",
          "type": "number",
          "default": 0,
          "description": "For example if you want to move bookmark to the first place set this field to 0"
        },
        {
          "displayName": "Parse Metadata",
          "name": "pleaseParse",
          "type": "boolean",
          "default": false,
          "description": "Whether Raindrop should reload cover, description and HTML for the URL"
        },
        {
          "displayName": "Tags",
          "name": "tags",
          "type": "string",
          "default": "",
          "description": "Bookmark tags. Multiple tags can be set separated by comma."
        },
        {
          "displayName": "Title",
          "name": "title",
          "type": "string",
          "default": "",
          "description": "Title of the bookmark to be created"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "bookmark"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "get",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "action": "Create a collection"
        },
        {
          "name": "Delete",
          "value": "delete",
          "action": "Delete a collection"
        },
        {
          "name": "Get",
          "value": "get",
          "action": "Get a collection"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "action": "Get many collections"
        },
        {
          "name": "Update",
          "value": "update",
          "action": "Update a collection"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "collection"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Title",
      "name": "title",
      "type": "string",
      "default": "",
      "description": "Title of the collection to create",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "collection"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Cover",
          "name": "cover",
          "type": "string",
          "default": "",
          "description": "URL of an image to use as cover for the collection"
        },
        {
          "displayName": "Public",
          "name": "public",
          "type": "boolean",
          "default": false,
          "description": "Whether the collection will be accessible without authentication"
        },
        {
          "displayName": "Parent ID",
          "name": "parentId",
          "type": "string",
          "default": "",
          "description": "ID of this collection's parent collection, if it is a child collection"
        },
        {
          "displayName": "Sort Order",
          "name": "sort",
          "type": "number",
          "default": 1,
          "description": "Descending sort order of this collection. The number is the position of the collection among all the collections with the same parent ID."
        },
        {
          "displayName": "View",
          "name": "view",
          "type": "options",
          "default": "list",
          "description": "View style of this collection",
          "options": [
            {
              "name": "List",
              "value": "list"
            },
            {
              "name": "Simple",
              "value": "simple"
            },
            {
              "name": "Grid",
              "value": "grid"
            },
            {
              "name": "Masonry",
              "value": "Masonry"
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "collection"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Collection ID",
      "name": "collectionId",
      "type": "string",
      "default": "",
      "description": "The ID of the collection to delete",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "collection"
          ],
          "operation": [
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "Collection ID",
      "name": "collectionId",
      "type": "string",
      "default": "",
      "description": "The ID of the collection to retrieve",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "collection"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Type",
      "name": "type",
      "type": "options",
      "default": "parent",
      "options": [
        {
          "name": "Parent",
          "value": "parent",
          "description": "Root-level collections"
        },
        {
          "name": "Children",
          "value": "children",
          "description": "Nested collections"
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "collection"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Return All",
      "name": "returnAll",
      "type": "boolean",
      "default": false,
      "description": "Whether to return all results or only up to a given limit",
      "displayOptions": {
        "show": {
          "resource": [
            "collection"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 5,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "collection"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 10
      }
    },
    {
      "displayName": "Collection ID",
      "name": "collectionId",
      "type": "string",
      "default": "",
      "description": "The ID of the collection to update",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "collection"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Update Fields",
      "name": "updateFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Cover",
          "name": "cover",
          "type": "string",
          "default": "data",
          "placeholder": "",
          "description": "Name of the binary property containing the data for the image to upload as a cover"
        },
        {
          "displayName": "Public",
          "name": "public",
          "type": "boolean",
          "default": false,
          "description": "Whether the collection will be accessible without authentication"
        },
        {
          "displayName": "Parent ID",
          "name": "parentId",
          "type": "string",
          "default": "",
          "description": "ID of this collection's parent collection, if it is a child collection"
        },
        {
          "displayName": "Sort Order",
          "name": "sort",
          "type": "number",
          "default": 1,
          "description": "Descending sort order of this collection. The number is the position of the collection among all the collections with the same parent ID."
        },
        {
          "displayName": "Title",
          "name": "title",
          "type": "string",
          "default": "",
          "description": "Title of the collection to update"
        },
        {
          "displayName": "View",
          "name": "view",
          "type": "options",
          "default": "list",
          "description": "View style of this collection",
          "options": [
            {
              "name": "List",
              "value": "list"
            },
            {
              "name": "Simple",
              "value": "simple"
            },
            {
              "name": "Grid",
              "value": "grid"
            },
            {
              "name": "Masonry",
              "value": "Masonry"
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "collection"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "get",
      "options": [
        {
          "name": "Delete",
          "value": "delete",
          "action": "Delete a tag"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "action": "Get many tags"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "tag"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Tags",
      "name": "tags",
      "type": "string",
      "default": "",
      "description": "One or more tags to delete. Enter comma-separated values to delete multiple tags.",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "tag"
          ],
          "operation": [
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Collection Name or ID",
          "name": "collectionId",
          "type": "options",
          "typeOptions": {
            "loadOptionsMethod": "getCollections"
          },
          "default": "",
          "description": "It's possible to restrict remove action to just one collection. It's optional. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "tag"
          ],
          "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": [
            "tag"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 5,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "tag"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 10
      }
    },
    {
      "displayName": "Filters",
      "name": "filters",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Collection Name or ID",
          "name": "collectionId",
          "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": "getCollections"
          },
          "default": ""
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "tag"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "get",
      "options": [
        {
          "name": "Get",
          "value": "get",
          "action": "Get a user"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Self",
      "name": "self",
      "type": "boolean",
      "default": true,
      "description": "Whether to return details on the logged-in user",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "User ID",
      "name": "userId",
      "type": "string",
      "default": "",
      "description": "The ID of the user to retrieve",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "get"
          ],
          "self": [
            false
          ]
        }
      }
    }
  ]

operations:
  [
    {
      "operation": "create",
      "name": "Create",
      "resource": "bookmark"
    },
    {
      "operation": "delete",
      "name": "Delete",
      "resource": "bookmark"
    },
    {
      "operation": "get",
      "name": "Get",
      "resource": "bookmark"
    },
    {
      "operation": "getAll",
      "name": "Get Many",
      "resource": "bookmark"
    },
    {
      "operation": "update",
      "name": "Update",
      "resource": "bookmark"
    },
    {
      "operation": "create",
      "name": "Create",
      "resource": "collection"
    },
    {
      "operation": "delete",
      "name": "Delete",
      "resource": "collection"
    },
    {
      "operation": "get",
      "name": "Get",
      "resource": "collection"
    },
    {
      "operation": "getAll",
      "name": "Get Many",
      "resource": "collection"
    },
    {
      "operation": "update",
      "name": "Update",
      "resource": "collection"
    },
    {
      "operation": "delete",
      "name": "Delete",
      "resource": "tag"
    },
    {
      "operation": "getAll",
      "name": "Get Many",
      "resource": "tag"
    },
    {
      "operation": "get",
      "name": "Get",
      "resource": "user"
    }
  ]


node_type: nodes-base.readBinaryFile
package_name: n8n-nodes-base
display_name: Read Binary File
description: Reads a binary file from disk
category: input
development_style: programmatic
version: 1
operations: []
credentials_required: []
outputs:
  [
  "main"
  ]

updated_at: 2026-04-16 09:43:09
properties_schema:
  [
    {
      "displayName": "File Path",
      "name": "filePath",
      "type": "string",
      "default": "",
      "description": "Path of the file to read",
      "required": true
    },
    {
      "displayName": "Property Name",
      "name": "dataPropertyName",
      "type": "string",
      "default": "data",
      "description": "Name of the binary property to which to write the data of the read file",
      "required": true
    }
  ]


node_type: nodes-base.readBinaryFiles
package_name: n8n-nodes-base
display_name: Read Binary Files
description: Reads binary files from disk
category: input
development_style: programmatic
version: 1
operations: []
credentials_required: []
outputs:
  [
  "main"
  ]

updated_at: 2026-04-16 09:43:09
properties_schema:
  [
    {
      "displayName": "File Selector",
      "name": "fileSelector",
      "type": "string",
      "default": "",
      "description": "Pattern for files to read",
      "required": true
    },
    {
      "displayName": "Property Name",
      "name": "dataPropertyName",
      "type": "string",
      "default": "data",
      "description": "Name of the binary property to which to write the data of the read files",
      "required": true
    }
  ]


node_type: nodes-base.readPDF
package_name: n8n-nodes-base
display_name: Read PDF
description: Reads a PDF and extracts its content
category: input
development_style: programmatic
version: 1
operations: []
credentials_required: []
outputs:
  [
  "main"
  ]

updated_at: 2026-04-16 09:43:09
properties_schema:
  [
    {
      "displayName": "Input Binary Field",
      "name": "binaryPropertyName",
      "type": "string",
      "default": "data",
      "description": "Name of the binary property from which to read the PDF file",
      "required": true
    },
    {
      "displayName": "Encrypted",
      "name": "encrypted",
      "type": "boolean",
      "default": false,
      "required": true
    },
    {
      "displayName": "Password",
      "name": "password",
      "type": "string",
      "default": "",
      "description": "Password to decrypt the PDF file with",
      "displayOptions": {
        "show": {
          "encrypted": [
            true
          ]
        }
      },
      "typeOptions": {
        "password": true
      }
    }
  ]


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

output_names:
  [
  "Tool"
  ]

updated_at: 2026-04-16 09:43:09
tool_variant_of: nodes-base.reddit
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: Reddit node documentation
  description: Learn how to use the Reddit node in n8n. Follow technical documentation to integrate Reddit node into your workflows.
  contentType: [integration, reference]
  ---

  # Reddit node

  Use the Reddit node to automate work in Reddit, and integrate Reddit with other applications. n8n has built-in support for a wide range of Reddit features, including getting profiles, and users, retrieving post comments and subreddit, as well as submitting, getting, and deleting posts. 

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

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

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

  ## Operations

  * Post
      * Submit a post to a subreddit
      * Delete a post from a subreddit
      * Get a post from a subreddit
      * Get all posts from a subreddit
      * Search posts in a subreddit or in all of Reddit.
  * Post Comment
      * Create a top-level comment in a post
      * Retrieve all comments in a post
      * Remove a comment from a post
      * Write a reply to a comment in a post
  * Profile
      * Get
  * Subreddit
      * Retrieve background information about a subreddit.
      * Retrieve information about subreddits from all of Reddit.
  * User
      * Get

  ## Templates and examples

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

  --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 Reddit"
    },
    {
      "displayName": "Resource",
      "name": "resource",
      "type": "options",
      "default": "post",
      "options": [
        {
          "name": "Post",
          "value": "post"
        },
        {
          "name": "Post Comment",
          "value": "postComment"
        },
        {
          "name": "Profile",
          "value": "profile"
        },
        {
          "name": "Subreddit",
          "value": "subreddit"
        },
        {
          "name": "User",
          "value": "user"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create a top-level comment in a post",
          "action": "Create a comment in a post"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Retrieve many comments in a post",
          "action": "Get many comments in a post"
        },
        {
          "name": "Delete",
          "value": "delete",
          "description": "Remove a comment from a post",
          "action": "Delete a comment from a post"
        },
        {
          "name": "Reply",
          "value": "reply",
          "description": "Write a reply to a comment in a post",
          "action": "Reply to a comment in a post"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "postComment"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Post ID",
      "name": "postId",
      "type": "string",
      "default": "",
      "description": "ID of the post to write the comment to. Found in the post URL: <code>/r/[subreddit_name]/comments/[post_id]/[post_title]</code>",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "postComment"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Comment Text",
      "name": "commentText",
      "type": "string",
      "default": "",
      "description": "Text of the comment. Markdown supported.",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "postComment"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Subreddit",
      "name": "subreddit",
      "type": "string",
      "default": "",
      "description": "The name of subreddit where the post is",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "postComment"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Post ID",
      "name": "postId",
      "type": "string",
      "default": "",
      "description": "ID of the post to get all comments from. Found in the post URL: <code>/r/[subreddit_name]/comments/[post_id]/[post_title]</code>",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "postComment"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Return All",
      "name": "returnAll",
      "type": "boolean",
      "default": false,
      "description": "Whether to return all results or only up to a given limit",
      "displayOptions": {
        "show": {
          "resource": [
            "postComment"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 100,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "postComment"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 100
      }
    },
    {
      "displayName": "Comment ID",
      "name": "commentId",
      "type": "string",
      "default": "",
      "description": "ID of the comment to remove. Found in the comment URL:<code>/r/[subreddit_name]/comments/[post_id]/[post_title]/[comment_id]</code>",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "postComment"
          ],
          "operation": [
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "Comment ID",
      "name": "commentId",
      "type": "string",
      "default": "",
      "description": "ID of the comment to reply to. To be found in the comment URL: <code>www.reddit.com/r/[subreddit_name]/comments/[post_id]/[post_title]/[comment_id]</code>",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "postComment"
          ],
          "operation": [
            "reply"
          ]
        }
      }
    },
    {
      "displayName": "Reply Text",
      "name": "replyText",
      "type": "string",
      "default": "",
      "description": "Text of the reply. Markdown supported.",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "postComment"
          ],
          "operation": [
            "reply"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "get",
      "options": [
        {
          "name": "Get",
          "value": "get",
          "action": "Get a profile"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "profile"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Details",
      "name": "details",
      "type": "options",
      "default": "identity",
      "description": "Details of my account to retrieve",
      "options": [
        {
          "name": "Blocked Users",
          "value": "blockedUsers",
          "description": "Return the blocked users of the logged-in user"
        },
        {
          "name": "Friends",
          "value": "friends",
          "description": "Return the friends of the logged-in user"
        },
        {
          "name": "Identity",
          "value": "identity",
          "description": "Return the identity of the logged-in user"
        },
        {
          "name": "Karma",
          "value": "karma",
          "description": "Return the subreddit karma for the logged-in user"
        },
        {
          "name": "Preferences",
          "value": "prefs",
          "description": "Return the settings preferences of the logged-in user"
        },
        {
          "name": "Saved",
          "value": "saved",
          "description": "Return the saved posts for the user"
        },
        {
          "name": "Trophies",
          "value": "trophies",
          "description": "Return the trophies of the logged-in user"
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "profile"
          ],
          "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": [
            "profile"
          ],
          "operation": [
            "get"
          ],
          "details": [
            "saved"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 100,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "profile"
          ],
          "operation": [
            "get"
          ],
          "details": [
            "saved"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 100
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "get",
      "options": [
        {
          "name": "Get",
          "value": "get",
          "description": "Retrieve background information about a subreddit",
          "action": "Get a subreddit"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Retrieve information about many subreddits",
          "action": "Get many subreddits"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "subreddit"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Content",
      "name": "content",
      "type": "options",
      "default": "about",
      "description": "Subreddit content to retrieve",
      "options": [
        {
          "name": "About",
          "value": "about"
        },
        {
          "name": "Rules",
          "value": "rules"
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "subreddit"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Subreddit",
      "name": "subreddit",
      "type": "string",
      "default": "",
      "description": "The name of subreddit to retrieve the content from",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "subreddit"
          ],
          "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": [
            "subreddit"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 100,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "subreddit"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 100
      }
    },
    {
      "displayName": "Filters",
      "name": "filters",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Keyword",
          "name": "keyword",
          "type": "string",
          "default": "",
          "description": "The keyword for the subreddit search"
        },
        {
          "displayName": "Trending",
          "name": "trending",
          "type": "boolean",
          "default": false,
          "description": "Whether to fetch currently trending subreddits in all of Reddit"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "subreddit"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Submit a post to a subreddit",
          "action": "Create a post"
        },
        {
          "name": "Delete",
          "value": "delete",
          "description": "Delete a post from a subreddit",
          "action": "Delete a post"
        },
        {
          "name": "Get",
          "value": "get",
          "description": "Get a post from a subreddit",
          "action": "Get a post"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get many posts from a subreddit",
          "action": "Get many posts"
        },
        {
          "name": "Search",
          "value": "search",
          "description": "Search posts in a subreddit or in all of Reddit",
          "action": "Search for a post"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "post"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Subreddit",
      "name": "subreddit",
      "type": "string",
      "default": "",
      "description": "Subreddit to create the post in",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "post"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Kind",
      "name": "kind",
      "type": "options",
      "default": "self",
      "description": "The kind of the post to create",
      "options": [
        {
          "name": "Text Post",
          "value": "self"
        },
        {
          "name": "Link Post",
          "value": "link"
        },
        {
          "name": "Image Post",
          "value": "image"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "post"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Title",
      "name": "title",
      "type": "string",
      "default": "",
      "description": "Title of the post, up to 300 characters long",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "post"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "URL",
      "name": "url",
      "type": "string",
      "default": "",
      "description": "URL of the post",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "post"
          ],
          "operation": [
            "create"
          ],
          "kind": [
            "link",
            "image"
          ]
        }
      }
    },
    {
      "displayName": "Text",
      "name": "text",
      "type": "string",
      "default": "",
      "description": "Text of the post. Markdown supported.",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "post"
          ],
          "operation": [
            "create"
          ],
          "kind": [
            "self"
          ]
        }
      }
    },
    {
      "displayName": "Resubmit",
      "name": "resubmit",
      "type": "boolean",
      "default": false,
      "description": "Whether the URL will be posted even if it was already posted to the subreddit before. Otherwise, the re-posting will trigger an error.",
      "displayOptions": {
        "show": {
          "resource": [
            "post"
          ],
          "operation": [
            "create"
          ],
          "kind": [
            "link",
            "image"
          ]
        }
      }
    },
    {
      "displayName": "Post ID",
      "name": "postId",
      "type": "string",
      "default": "",
      "description": "ID of the post to delete. Found in the post URL: <code>/r/[subreddit_name]/comments/[post_id]/[post_title]</code>",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "post"
          ],
          "operation": [
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "Subreddit",
      "name": "subreddit",
      "type": "string",
      "default": "",
      "description": "The name of subreddit to retrieve the post from",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "post"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Post ID",
      "name": "postId",
      "type": "string",
      "default": "",
      "description": "ID of the post to retrieve. Found in the post URL: <code>/r/[subreddit_name]/comments/[post_id]/[post_title]</code>",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "post"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Subreddit",
      "name": "subreddit",
      "type": "string",
      "default": "",
      "description": "The name of subreddit to retrieve the posts from",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "post"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Return All",
      "name": "returnAll",
      "type": "boolean",
      "default": false,
      "description": "Whether to return all results or only up to a given limit",
      "displayOptions": {
        "show": {
          "resource": [
            "post"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 100,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "post"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 100
      }
    },
    {
      "displayName": "Filters",
      "name": "filters",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Category",
          "name": "category",
          "type": "options",
          "default": "top",
          "description": "Category of the posts to retrieve",
          "options": [
            {
              "name": "Top Posts",
              "value": "top"
            },
            {
              "name": "Hot Posts",
              "value": "hot"
            },
            {
              "name": "New Posts",
              "value": "new"
            },
            {
              "name": "Rising Posts",
              "value": "rising"
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "post"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Location",
      "name": "location",
      "type": "options",
      "default": "subreddit",
      "description": "Location where to search for posts",
      "options": [
        {
          "name": "All Reddit",
          "value": "allReddit",
          "description": "Search for posts in all of Reddit"
        },
        {
          "name": "Subreddit",
          "value": "subreddit",
          "description": "Search for posts in a specific subreddit"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "post"
          ],
          "operation": [
            "search"
          ]
        }
      }
    },
    {
      "displayName": "Subreddit",
      "name": "subreddit",
      "type": "string",
      "default": "",
      "description": "The name of subreddit to search in",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "post"
          ],
          "operation": [
            "search"
          ],
          "location": [
            "subreddit"
          ]
        }
      }
    },
    {
      "displayName": "Keyword",
      "name": "keyword",
      "type": "string",
      "default": "",
      "description": "The keyword for the search",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "post"
          ],
          "operation": [
            "search"
          ]
        }
      }
    },
    {
      "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": [
            "post"
          ],
          "operation": [
            "search"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 100,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "post"
          ],
          "operation": [
            "search"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 100
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Sort",
          "name": "sort",
          "placeholder": "",
          "type": "options",
          "default": "relevance",
          "description": "The category to sort results by",
          "options": [
            {
              "name": "Comments",
              "value": "comments"
            },
            {
              "name": "Hot",
              "value": "hot"
            },
            {
              "name": "New",
              "value": "new"
            },
            {
              "name": "Relevance",
              "value": "relevance"
            },
            {
              "name": "Top",
              "value": "top"
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "post"
          ],
          "operation": [
            "search"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "get",
      "options": [
        {
          "name": "Get",
          "value": "get",
          "action": "Get a user"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Username",
      "name": "username",
      "type": "string",
      "default": "",
      "description": "Reddit ID of the user to retrieve",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Details",
      "name": "details",
      "type": "options",
      "default": "about",
      "description": "Details of the user to retrieve",
      "options": [
        {
          "name": "About",
          "value": "about"
        },
        {
          "name": "Comments",
          "value": "comments"
        },
        {
          "name": "Gilded",
          "value": "gilded"
        },
        {
          "name": "Overview",
          "value": "overview"
        },
        {
          "name": "Submitted",
          "value": "submitted"
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "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": [
            "user"
          ],
          "operation": [
            "get"
          ],
          "details": [
            "overview",
            "submitted",
            "comments",
            "gilded"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 100,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "get"
          ],
          "details": [
            "comments",
            "gilded",
            "overview",
            "submitted"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 100
      }
    }
  ]

operations:
  [
    {
      "operation": "create",
      "name": "Create",
      "description": "Create a top-level comment in a post",
      "resource": "postComment"
    },
    {
      "operation": "getAll",
      "name": "Get Many",
      "description": "Retrieve many comments in a post",
      "resource": "postComment"
    },
    {
      "operation": "delete",
      "name": "Delete",
      "description": "Remove a comment from a post",
      "resource": "postComment"
    },
    {
      "operation": "reply",
      "name": "Reply",
      "description": "Write a reply to a comment in a post",
      "resource": "postComment"
    },
    {
      "operation": "get",
      "name": "Get",
      "resource": "profile"
    },
    {
      "operation": "get",
      "name": "Get",
      "description": "Retrieve background information about a subreddit",
      "resource": "subreddit"
    },
    {
      "operation": "getAll",
      "name": "Get Many",
      "description": "Retrieve information about many subreddits",
      "resource": "subreddit"
    },
    {
      "operation": "create",
      "name": "Create",
      "description": "Submit a post to a subreddit",
      "resource": "post"
    },
    {
      "operation": "delete",
      "name": "Delete",
      "description": "Delete a post from a subreddit",
      "resource": "post"
    },
    {
      "operation": "get",
      "name": "Get",
      "description": "Get a post from a subreddit",
      "resource": "post"
    },
    {
      "operation": "getAll",
      "name": "Get Many",
      "description": "Get many posts from a subreddit",
      "resource": "post"
    },
    {
      "operation": "search",
      "name": "Search",
      "description": "Search posts in a subreddit or in all of Reddit",
      "resource": "post"
    },
    {
      "operation": "get",
      "name": "Get",
      "resource": "user"
    }
  ]

credentials_required:
  [
    {
      "name": "redditOAuth2Api",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "postComment",
            "post",
            "profile"
          ]
        }
      }
    }
  ]


node_type: nodes-base.reddit
package_name: n8n-nodes-base
display_name: Reddit
description: Consume the Reddit API
category: transform
development_style: programmatic
version: 1
outputs:
  [
  "main"
  ]

updated_at: 2026-04-16 09:43:09
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: Reddit node documentation
  description: Learn how to use the Reddit node in n8n. Follow technical documentation to integrate Reddit node into your workflows.
  contentType: [integration, reference]
  ---

  # Reddit node

  Use the Reddit node to automate work in Reddit, and integrate Reddit with other applications. n8n has built-in support for a wide range of Reddit features, including getting profiles, and users, retrieving post comments and subreddit, as well as submitting, getting, and deleting posts. 

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

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

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

  ## Operations

  * Post
      * Submit a post to a subreddit
      * Delete a post from a subreddit
      * Get a post from a subreddit
      * Get all posts from a subreddit
      * Search posts in a subreddit or in all of Reddit.
  * Post Comment
      * Create a top-level comment in a post
      * Retrieve all comments in a post
      * Remove a comment from a post
      * Write a reply to a comment in a post
  * Profile
      * Get
  * Subreddit
      * Retrieve background information about a subreddit.
      * Retrieve information about subreddits from all of Reddit.
  * User
      * Get

  ## Templates and examples

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

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

properties_schema:
  [
    {
      "displayName": "Resource",
      "name": "resource",
      "type": "options",
      "default": "post",
      "options": [
        {
          "name": "Post",
          "value": "post"
        },
        {
          "name": "Post Comment",
          "value": "postComment"
        },
        {
          "name": "Profile",
          "value": "profile"
        },
        {
          "name": "Subreddit",
          "value": "subreddit"
        },
        {
          "name": "User",
          "value": "user"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create a top-level comment in a post",
          "action": "Create a comment in a post"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Retrieve many comments in a post",
          "action": "Get many comments in a post"
        },
        {
          "name": "Delete",
          "value": "delete",
          "description": "Remove a comment from a post",
          "action": "Delete a comment from a post"
        },
        {
          "name": "Reply",
          "value": "reply",
          "description": "Write a reply to a comment in a post",
          "action": "Reply to a comment in a post"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "postComment"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Post ID",
      "name": "postId",
      "type": "string",
      "default": "",
      "description": "ID of the post to write the comment to. Found in the post URL: <code>/r/[subreddit_name]/comments/[post_id]/[post_title]</code>",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "postComment"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Comment Text",
      "name": "commentText",
      "type": "string",
      "default": "",
      "description": "Text of the comment. Markdown supported.",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "postComment"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Subreddit",
      "name": "subreddit",
      "type": "string",
      "default": "",
      "description": "The name of subreddit where the post is",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "postComment"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Post ID",
      "name": "postId",
      "type": "string",
      "default": "",
      "description": "ID of the post to get all comments from. Found in the post URL: <code>/r/[subreddit_name]/comments/[post_id]/[post_title]</code>",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "postComment"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Return All",
      "name": "returnAll",
      "type": "boolean",
      "default": false,
      "description": "Whether to return all results or only up to a given limit",
      "displayOptions": {
        "show": {
          "resource": [
            "postComment"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 100,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "postComment"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 100
      }
    },
    {
      "displayName": "Comment ID",
      "name": "commentId",
      "type": "string",
      "default": "",
      "description": "ID of the comment to remove. Found in the comment URL:<code>/r/[subreddit_name]/comments/[post_id]/[post_title]/[comment_id]</code>",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "postComment"
          ],
          "operation": [
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "Comment ID",
      "name": "commentId",
      "type": "string",
      "default": "",
      "description": "ID of the comment to reply to. To be found in the comment URL: <code>www.reddit.com/r/[subreddit_name]/comments/[post_id]/[post_title]/[comment_id]</code>",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "postComment"
          ],
          "operation": [
            "reply"
          ]
        }
      }
    },
    {
      "displayName": "Reply Text",
      "name": "replyText",
      "type": "string",
      "default": "",
      "description": "Text of the reply. Markdown supported.",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "postComment"
          ],
          "operation": [
            "reply"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "get",
      "options": [
        {
          "name": "Get",
          "value": "get",
          "action": "Get a profile"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "profile"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Details",
      "name": "details",
      "type": "options",
      "default": "identity",
      "description": "Details of my account to retrieve",
      "options": [
        {
          "name": "Blocked Users",
          "value": "blockedUsers",
          "description": "Return the blocked users of the logged-in user"
        },
        {
          "name": "Friends",
          "value": "friends",
          "description": "Return the friends of the logged-in user"
        },
        {
          "name": "Identity",
          "value": "identity",
          "description": "Return the identity of the logged-in user"
        },
        {
          "name": "Karma",
          "value": "karma",
          "description": "Return the subreddit karma for the logged-in user"
        },
        {
          "name": "Preferences",
          "value": "prefs",
          "description": "Return the settings preferences of the logged-in user"
        },
        {
          "name": "Saved",
          "value": "saved",
          "description": "Return the saved posts for the user"
        },
        {
          "name": "Trophies",
          "value": "trophies",
          "description": "Return the trophies of the logged-in user"
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "profile"
          ],
          "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": [
            "profile"
          ],
          "operation": [
            "get"
          ],
          "details": [
            "saved"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 100,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "profile"
          ],
          "operation": [
            "get"
          ],
          "details": [
            "saved"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 100
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "get",
      "options": [
        {
          "name": "Get",
          "value": "get",
          "description": "Retrieve background information about a subreddit",
          "action": "Get a subreddit"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Retrieve information about many subreddits",
          "action": "Get many subreddits"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "subreddit"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Content",
      "name": "content",
      "type": "options",
      "default": "about",
      "description": "Subreddit content to retrieve",
      "options": [
        {
          "name": "About",
          "value": "about"
        },
        {
          "name": "Rules",
          "value": "rules"
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "subreddit"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Subreddit",
      "name": "subreddit",
      "type": "string",
      "default": "",
      "description": "The name of subreddit to retrieve the content from",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "subreddit"
          ],
          "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": [
            "subreddit"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 100,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "subreddit"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 100
      }
    },
    {
      "displayName": "Filters",
      "name": "filters",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Keyword",
          "name": "keyword",
          "type": "string",
          "default": "",
          "description": "The keyword for the subreddit search"
        },
        {
          "displayName": "Trending",
          "name": "trending",
          "type": "boolean",
          "default": false,
          "description": "Whether to fetch currently trending subreddits in all of Reddit"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "subreddit"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Submit a post to a subreddit",
          "action": "Create a post"
        },
        {
          "name": "Delete",
          "value": "delete",
          "description": "Delete a post from a subreddit",
          "action": "Delete a post"
        },
        {
          "name": "Get",
          "value": "get",
          "description": "Get a post from a subreddit",
          "action": "Get a post"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get many posts from a subreddit",
          "action": "Get many posts"
        },
        {
          "name": "Search",
          "value": "search",
          "description": "Search posts in a subreddit or in all of Reddit",
          "action": "Search for a post"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "post"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Subreddit",
      "name": "subreddit",
      "type": "string",
      "default": "",
      "description": "Subreddit to create the post in",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "post"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Kind",
      "name": "kind",
      "type": "options",
      "default": "self",
      "description": "The kind of the post to create",
      "options": [
        {
          "name": "Text Post",
          "value": "self"
        },
        {
          "name": "Link Post",
          "value": "link"
        },
        {
          "name": "Image Post",
          "value": "image"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "post"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Title",
      "name": "title",
      "type": "string",
      "default": "",
      "description": "Title of the post, up to 300 characters long",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "post"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "URL",
      "name": "url",
      "type": "string",
      "default": "",
      "description": "URL of the post",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "post"
          ],
          "operation": [
            "create"
          ],
          "kind": [
            "link",
            "image"
          ]
        }
      }
    },
    {
      "displayName": "Text",
      "name": "text",
      "type": "string",
      "default": "",
      "description": "Text of the post. Markdown supported.",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "post"
          ],
          "operation": [
            "create"
          ],
          "kind": [
            "self"
          ]
        }
      }
    },
    {
      "displayName": "Resubmit",
      "name": "resubmit",
      "type": "boolean",
      "default": false,
      "description": "Whether the URL will be posted even if it was already posted to the subreddit before. Otherwise, the re-posting will trigger an error.",
      "displayOptions": {
        "show": {
          "resource": [
            "post"
          ],
          "operation": [
            "create"
          ],
          "kind": [
            "link",
            "image"
          ]
        }
      }
    },
    {
      "displayName": "Post ID",
      "name": "postId",
      "type": "string",
      "default": "",
      "description": "ID of the post to delete. Found in the post URL: <code>/r/[subreddit_name]/comments/[post_id]/[post_title]</code>",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "post"
          ],
          "operation": [
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "Subreddit",
      "name": "subreddit",
      "type": "string",
      "default": "",
      "description": "The name of subreddit to retrieve the post from",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "post"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Post ID",
      "name": "postId",
      "type": "string",
      "default": "",
      "description": "ID of the post to retrieve. Found in the post URL: <code>/r/[subreddit_name]/comments/[post_id]/[post_title]</code>",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "post"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Subreddit",
      "name": "subreddit",
      "type": "string",
      "default": "",
      "description": "The name of subreddit to retrieve the posts from",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "post"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Return All",
      "name": "returnAll",
      "type": "boolean",
      "default": false,
      "description": "Whether to return all results or only up to a given limit",
      "displayOptions": {
        "show": {
          "resource": [
            "post"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 100,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "post"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 100
      }
    },
    {
      "displayName": "Filters",
      "name": "filters",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Category",
          "name": "category",
          "type": "options",
          "default": "top",
          "description": "Category of the posts to retrieve",
          "options": [
            {
              "name": "Top Posts",
              "value": "top"
            },
            {
              "name": "Hot Posts",
              "value": "hot"
            },
            {
              "name": "New Posts",
              "value": "new"
            },
            {
              "name": "Rising Posts",
              "value": "rising"
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "post"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Location",
      "name": "location",
      "type": "options",
      "default": "subreddit",
      "description": "Location where to search for posts",
      "options": [
        {
          "name": "All Reddit",
          "value": "allReddit",
          "description": "Search for posts in all of Reddit"
        },
        {
          "name": "Subreddit",
          "value": "subreddit",
          "description": "Search for posts in a specific subreddit"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "post"
          ],
          "operation": [
            "search"
          ]
        }
      }
    },
    {
      "displayName": "Subreddit",
      "name": "subreddit",
      "type": "string",
      "default": "",
      "description": "The name of subreddit to search in",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "post"
          ],
          "operation": [
            "search"
          ],
          "location": [
            "subreddit"
          ]
        }
      }
    },
    {
      "displayName": "Keyword",
      "name": "keyword",
      "type": "string",
      "default": "",
      "description": "The keyword for the search",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "post"
          ],
          "operation": [
            "search"
          ]
        }
      }
    },
    {
      "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": [
            "post"
          ],
          "operation": [
            "search"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 100,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "post"
          ],
          "operation": [
            "search"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 100
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Sort",
          "name": "sort",
          "placeholder": "",
          "type": "options",
          "default": "relevance",
          "description": "The category to sort results by",
          "options": [
            {
              "name": "Comments",
              "value": "comments"
            },
            {
              "name": "Hot",
              "value": "hot"
            },
            {
              "name": "New",
              "value": "new"
            },
            {
              "name": "Relevance",
              "value": "relevance"
            },
            {
              "name": "Top",
              "value": "top"
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "post"
          ],
          "operation": [
            "search"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "get",
      "options": [
        {
          "name": "Get",
          "value": "get",
          "action": "Get a user"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Username",
      "name": "username",
      "type": "string",
      "default": "",
      "description": "Reddit ID of the user to retrieve",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Details",
      "name": "details",
      "type": "options",
      "default": "about",
      "description": "Details of the user to retrieve",
      "options": [
        {
          "name": "About",
          "value": "about"
        },
        {
          "name": "Comments",
          "value": "comments"
        },
        {
          "name": "Gilded",
          "value": "gilded"
        },
        {
          "name": "Overview",
          "value": "overview"
        },
        {
          "name": "Submitted",
          "value": "submitted"
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "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": [
            "user"
          ],
          "operation": [
            "get"
          ],
          "details": [
            "overview",
            "submitted",
            "comments",
            "gilded"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 100,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "get"
          ],
          "details": [
            "comments",
            "gilded",
            "overview",
            "submitted"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 100
      }
    }
  ]

operations:
  [
    {
      "operation": "create",
      "name": "Create",
      "description": "Create a top-level comment in a post",
      "resource": "postComment"
    },
    {
      "operation": "getAll",
      "name": "Get Many",
      "description": "Retrieve many comments in a post",
      "resource": "postComment"
    },
    {
      "operation": "delete",
      "name": "Delete",
      "description": "Remove a comment from a post",
      "resource": "postComment"
    },
    {
      "operation": "reply",
      "name": "Reply",
      "description": "Write a reply to a comment in a post",
      "resource": "postComment"
    },
    {
      "operation": "get",
      "name": "Get",
      "resource": "profile"
    },
    {
      "operation": "get",
      "name": "Get",
      "description": "Retrieve background information about a subreddit",
      "resource": "subreddit"
    },
    {
      "operation": "getAll",
      "name": "Get Many",
      "description": "Retrieve information about many subreddits",
      "resource": "subreddit"
    },
    {
      "operation": "create",
      "name": "Create",
      "description": "Submit a post to a subreddit",
      "resource": "post"
    },
    {
      "operation": "delete",
      "name": "Delete",
      "description": "Delete a post from a subreddit",
      "resource": "post"
    },
    {
      "operation": "get",
      "name": "Get",
      "description": "Get a post from a subreddit",
      "resource": "post"
    },
    {
      "operation": "getAll",
      "name": "Get Many",
      "description": "Get many posts from a subreddit",
      "resource": "post"
    },
    {
      "operation": "search",
      "name": "Search",
      "description": "Search posts in a subreddit or in all of Reddit",
      "resource": "post"
    },
    {
      "operation": "get",
      "name": "Get",
      "resource": "user"
    }
  ]

credentials_required:
  [
    {
      "name": "redditOAuth2Api",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "postComment",
            "post",
            "profile"
          ]
        }
      }
    }
  ]


node_type: nodes-base.redisTool
package_name: n8n-nodes-base
display_name: Redis Tool
description: Get, send and update data in Redis (AI Tool variant for use with AI Agents)
category: input
development_style: programmatic
version: 1
credentials_required:
  [
  {
  "name": "redis",
  "required": true,
  "testedBy": "redisConnectionTest"
  }
  ]

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

output_names:
  [
  "Tool"
  ]

updated_at: 2026-04-16 09:43:09
tool_variant_of: nodes-base.redis
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: Redis node documentation
  description: Learn how to use the Redis node in n8n. Follow technical documentation to integrate Redis node into your workflows.
  contentType: [integration, reference]
  priority: medium
  ---

  # Redis node

  Use the Redis node to automate work in Redis, and integrate Redis with other applications. n8n has built-in support for a wide range of Redis features, including deleting keys, getting key values, setting key value, and publishing messages to the Redis channel.  

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

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

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

  ## Operations

  * Delete a key from Redis.
  * Get the value of a key from Redis.
  * Returns generic information about the Redis instance.
  * Atomically increments a key by 1. Creates the key if it doesn't exist.
  * Returns all the keys matching a pattern.
  * Set the value of a key in Redis.
  * Publish message to Redis channel.

  ## Templates and examples

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

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 Redis"
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "info",
      "options": [
        {
          "name": "Delete",
          "value": "delete",
          "description": "Delete a key from Redis",
          "action": "Delete a key from Redis"
        },
        {
          "name": "Get",
          "value": "get",
          "description": "Get the value of a key from Redis",
          "action": "Get the value of a key from Redis"
        },
        {
          "name": "Increment",
          "value": "incr",
          "description": "Atomically increments a key by 1. Creates the key if it does not exist.",
          "action": "Atomically increment a key by 1. Creates the key if it does not exist."
        },
        {
          "name": "Info",
          "value": "info",
          "description": "Returns generic information about the Redis instance",
          "action": "Return generic information about the Redis instance"
        },
        {
          "name": "Keys",
          "value": "keys",
          "description": "Returns all the keys matching a pattern",
          "action": "Return all keys matching a pattern"
        },
        {
          "name": "List Length",
          "value": "llen",
          "description": "Returns the length of a list",
          "action": "Return the length of a list"
        },
        {
          "name": "Pop",
          "value": "pop",
          "description": "Pop data from a redis list",
          "action": "Pop data from a redis list"
        },
        {
          "name": "Publish",
          "value": "publish",
          "description": "Publish message to redis channel",
          "action": "Publish message to redis channel"
        },
        {
          "name": "Push",
          "value": "push",
          "description": "Push data to a redis list",
          "action": "Push data to a redis list"
        },
        {
          "name": "Set",
          "value": "set",
          "description": "Set the value of a key in redis",
          "action": "Set the value of a key in redis"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "Key",
      "name": "key",
      "type": "string",
      "default": "",
      "description": "Name of the key to delete from Redis",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "Name",
      "name": "propertyName",
      "type": "string",
      "default": "propertyName",
      "description": "Name of the property to write received data to. Supports dot-notation. Example: \"data.person[0].name\".",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Key",
      "name": "key",
      "type": "string",
      "default": "",
      "description": "Name of the key to get from Redis",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Key Type",
      "name": "keyType",
      "type": "options",
      "default": "automatic",
      "description": "The type of the key to get",
      "options": [
        {
          "name": "Automatic",
          "value": "automatic",
          "description": "Requests the type before requesting the data (slower)"
        },
        {
          "name": "Hash",
          "value": "hash",
          "description": "Data in key is of type 'hash'"
        },
        {
          "name": "List",
          "value": "list",
          "description": "Data in key is of type 'lists'"
        },
        {
          "name": "Sets",
          "value": "sets",
          "description": "Data in key is of type 'sets'"
        },
        {
          "name": "String",
          "value": "string",
          "description": "Data in key is of type 'string'"
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Dot Notation",
          "name": "dotNotation",
          "type": "boolean",
          "default": true,
          "description": "<p>By default, dot-notation is used in property names. This means that \"a.b\" will set the property \"b\" underneath \"a\" so { \"a\": { \"b\": value} }.<p></p>If that is not intended this can be deactivated, it will then set { \"a.b\": value } instead.</p>."
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Key",
      "name": "key",
      "type": "string",
      "default": "",
      "description": "Name of the key to increment",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "incr"
          ]
        }
      }
    },
    {
      "displayName": "Expire",
      "name": "expire",
      "type": "boolean",
      "default": false,
      "description": "Whether to set a timeout on key",
      "displayOptions": {
        "show": {
          "operation": [
            "incr"
          ]
        }
      }
    },
    {
      "displayName": "TTL",
      "name": "ttl",
      "type": "number",
      "default": 60,
      "description": "Number of seconds before key expiration",
      "displayOptions": {
        "show": {
          "operation": [
            "incr"
          ],
          "expire": [
            true
          ]
        }
      },
      "typeOptions": {
        "minValue": 1
      }
    },
    {
      "displayName": "Key Pattern",
      "name": "keyPattern",
      "type": "string",
      "default": "",
      "description": "The key pattern for the keys to return",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "keys"
          ]
        }
      }
    },
    {
      "displayName": "Get Values",
      "name": "getValues",
      "type": "boolean",
      "default": true,
      "description": "Whether to get the value of matching keys",
      "displayOptions": {
        "show": {
          "operation": [
            "keys"
          ]
        }
      }
    },
    {
      "displayName": "List",
      "name": "list",
      "type": "string",
      "default": "",
      "description": "Name of the list in Redis",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "llen"
          ]
        }
      }
    },
    {
      "displayName": "List",
      "name": "list",
      "type": "string",
      "default": "",
      "description": "Name of the list in Redis",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "llen"
          ]
        }
      }
    },
    {
      "displayName": "Key",
      "name": "key",
      "type": "string",
      "default": "",
      "description": "Name of the key to set in Redis",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "set"
          ]
        }
      }
    },
    {
      "displayName": "Value",
      "name": "value",
      "type": "string",
      "default": "",
      "description": "The value to write in Redis",
      "displayOptions": {
        "show": {
          "operation": [
            "set"
          ]
        }
      }
    },
    {
      "displayName": "Key Type",
      "name": "keyType",
      "type": "options",
      "default": "automatic",
      "description": "The type of the key to set",
      "options": [
        {
          "name": "Automatic",
          "value": "automatic",
          "description": "Tries to figure out the type automatically depending on the data"
        },
        {
          "name": "Hash",
          "value": "hash",
          "description": "Data in key is of type 'hash'"
        },
        {
          "name": "List",
          "value": "list",
          "description": "Data in key is of type 'lists'"
        },
        {
          "name": "Sets",
          "value": "sets",
          "description": "Data in key is of type 'sets'"
        },
        {
          "name": "String",
          "value": "string",
          "description": "Data in key is of type 'string'"
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "set"
          ]
        }
      }
    },
    {
      "displayName": "Value Is JSON",
      "name": "valueIsJSON",
      "type": "boolean",
      "default": true,
      "description": "Whether the value is JSON or key value pairs",
      "displayOptions": {
        "show": {
          "keyType": [
            "hash"
          ]
        }
      }
    },
    {
      "displayName": "Expire",
      "name": "expire",
      "type": "boolean",
      "default": false,
      "description": "Whether to set a timeout on key",
      "displayOptions": {
        "show": {
          "operation": [
            "set"
          ]
        }
      }
    },
    {
      "displayName": "TTL",
      "name": "ttl",
      "type": "number",
      "default": 60,
      "description": "Number of seconds before key expiration",
      "displayOptions": {
        "show": {
          "operation": [
            "set"
          ],
          "expire": [
            true
          ]
        }
      },
      "typeOptions": {
        "minValue": 1
      }
    },
    {
      "displayName": "Channel",
      "name": "channel",
      "type": "string",
      "default": "",
      "description": "Channel name",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "publish"
          ]
        }
      }
    },
    {
      "displayName": "Data",
      "name": "messageData",
      "type": "string",
      "default": "",
      "description": "Data to publish",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "publish"
          ]
        }
      }
    },
    {
      "displayName": "List",
      "name": "list",
      "type": "string",
      "default": "",
      "description": "Name of the list in Redis",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "push",
            "pop"
          ]
        }
      }
    },
    {
      "displayName": "Data",
      "name": "messageData",
      "type": "string",
      "default": "",
      "description": "Data to push",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "push"
          ]
        }
      }
    },
    {
      "displayName": "Tail",
      "name": "tail",
      "type": "boolean",
      "default": false,
      "description": "Whether to push or pop data from the end of the list",
      "displayOptions": {
        "show": {
          "operation": [
            "push",
            "pop"
          ]
        }
      }
    },
    {
      "displayName": "Name",
      "name": "propertyName",
      "type": "string",
      "default": "propertyName",
      "description": "Optional name of the property to write received data to. Supports dot-notation. Example: \"data.person[0].name\".",
      "displayOptions": {
        "show": {
          "operation": [
            "pop"
          ]
        }
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Dot Notation",
          "name": "dotNotation",
          "type": "boolean",
          "default": true,
          "description": "<p>By default, dot-notation is used in property names. This means that \"a.b\" will set the property \"b\" underneath \"a\" so { \"a\": { \"b\": value} }.<p></p>If that is not intended this can be deactivated, it will then set { \"a.b\": value } instead.</p>."
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "pop"
          ]
        }
      }
    }
  ]

operations:
  [
    {
      "operation": "delete",
      "name": "Delete",
      "description": "Delete a key from Redis"
    },
    {
      "operation": "get",
      "name": "Get",
      "description": "Get the value of a key from Redis"
    },
    {
      "operation": "incr",
      "name": "Increment",
      "description": "Atomically increments a key by 1. Creates the key if it does not exist."
    },
    {
      "operation": "info",
      "name": "Info",
      "description": "Returns generic information about the Redis instance"
    },
    {
      "operation": "keys",
      "name": "Keys",
      "description": "Returns all the keys matching a pattern"
    },
    {
      "operation": "llen",
      "name": "List Length",
      "description": "Returns the length of a list"
    },
    {
      "operation": "pop",
      "name": "Pop",
      "description": "Pop data from a redis list"
    },
    {
      "operation": "publish",
      "name": "Publish",
      "description": "Publish message to redis channel"
    },
    {
      "operation": "push",
      "name": "Push",
      "description": "Push data to a redis list"
    },
    {
      "operation": "set",
      "name": "Set",
      "description": "Set the value of a key in redis"
    }
  ]


node_type: nodes-base.redis
package_name: n8n-nodes-base
display_name: Redis
description: Get, send and update data in Redis
category: input
development_style: programmatic
version: 1
credentials_required:
  [
  {
  "name": "redis",
  "required": true,
  "testedBy": "redisConnectionTest"
  }
  ]

outputs:
  [
  "main"
  ]

updated_at: 2026-04-16 09:43:09
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: Redis node documentation
  description: Learn how to use the Redis node in n8n. Follow technical documentation to integrate Redis node into your workflows.
  contentType: [integration, reference]
  priority: medium
  ---

  # Redis node

  Use the Redis node to automate work in Redis, and integrate Redis with other applications. n8n has built-in support for a wide range of Redis features, including deleting keys, getting key values, setting key value, and publishing messages to the Redis channel.  

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

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

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

  ## Operations

  * Delete a key from Redis.
  * Get the value of a key from Redis.
  * Returns generic information about the Redis instance.
  * Atomically increments a key by 1. Creates the key if it doesn't exist.
  * Returns all the keys matching a pattern.
  * Set the value of a key in Redis.
  * Publish message to Redis channel.

  ## Templates and examples

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

properties_schema:
  [
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "info",
      "options": [
        {
          "name": "Delete",
          "value": "delete",
          "description": "Delete a key from Redis",
          "action": "Delete a key from Redis"
        },
        {
          "name": "Get",
          "value": "get",
          "description": "Get the value of a key from Redis",
          "action": "Get the value of a key from Redis"
        },
        {
          "name": "Increment",
          "value": "incr",
          "description": "Atomically increments a key by 1. Creates the key if it does not exist.",
          "action": "Atomically increment a key by 1. Creates the key if it does not exist."
        },
        {
          "name": "Info",
          "value": "info",
          "description": "Returns generic information about the Redis instance",
          "action": "Return generic information about the Redis instance"
        },
        {
          "name": "Keys",
          "value": "keys",
          "description": "Returns all the keys matching a pattern",
          "action": "Return all keys matching a pattern"
        },
        {
          "name": "List Length",
          "value": "llen",
          "description": "Returns the length of a list",
          "action": "Return the length of a list"
        },
        {
          "name": "Pop",
          "value": "pop",
          "description": "Pop data from a redis list",
          "action": "Pop data from a redis list"
        },
        {
          "name": "Publish",
          "value": "publish",
          "description": "Publish message to redis channel",
          "action": "Publish message to redis channel"
        },
        {
          "name": "Push",
          "value": "push",
          "description": "Push data to a redis list",
          "action": "Push data to a redis list"
        },
        {
          "name": "Set",
          "value": "set",
          "description": "Set the value of a key in redis",
          "action": "Set the value of a key in redis"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "Key",
      "name": "key",
      "type": "string",
      "default": "",
      "description": "Name of the key to delete from Redis",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "Name",
      "name": "propertyName",
      "type": "string",
      "default": "propertyName",
      "description": "Name of the property to write received data to. Supports dot-notation. Example: \"data.person[0].name\".",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Key",
      "name": "key",
      "type": "string",
      "default": "",
      "description": "Name of the key to get from Redis",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Key Type",
      "name": "keyType",
      "type": "options",
      "default": "automatic",
      "description": "The type of the key to get",
      "options": [
        {
          "name": "Automatic",
          "value": "automatic",
          "description": "Requests the type before requesting the data (slower)"
        },
        {
          "name": "Hash",
          "value": "hash",
          "description": "Data in key is of type 'hash'"
        },
        {
          "name": "List",
          "value": "list",
          "description": "Data in key is of type 'lists'"
        },
        {
          "name": "Sets",
          "value": "sets",
          "description": "Data in key is of type 'sets'"
        },
        {
          "name": "String",
          "value": "string",
          "description": "Data in key is of type 'string'"
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Dot Notation",
          "name": "dotNotation",
          "type": "boolean",
          "default": true,
          "description": "<p>By default, dot-notation is used in property names. This means that \"a.b\" will set the property \"b\" underneath \"a\" so { \"a\": { \"b\": value} }.<p></p>If that is not intended this can be deactivated, it will then set { \"a.b\": value } instead.</p>."
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Key",
      "name": "key",
      "type": "string",
      "default": "",
      "description": "Name of the key to increment",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "incr"
          ]
        }
      }
    },
    {
      "displayName": "Expire",
      "name": "expire",
      "type": "boolean",
      "default": false,
      "description": "Whether to set a timeout on key",
      "displayOptions": {
        "show": {
          "operation": [
            "incr"
          ]
        }
      }
    },
    {
      "displayName": "TTL",
      "name": "ttl",
      "type": "number",
      "default": 60,
      "description": "Number of seconds before key expiration",
      "displayOptions": {
        "show": {
          "operation": [
            "incr"
          ],
          "expire": [
            true
          ]
        }
      },
      "typeOptions": {
        "minValue": 1
      }
    },
    {
      "displayName": "Key Pattern",
      "name": "keyPattern",
      "type": "string",
      "default": "",
      "description": "The key pattern for the keys to return",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "keys"
          ]
        }
      }
    },
    {
      "displayName": "Get Values",
      "name": "getValues",
      "type": "boolean",
      "default": true,
      "description": "Whether to get the value of matching keys",
      "displayOptions": {
        "show": {
          "operation": [
            "keys"
          ]
        }
      }
    },
    {
      "displayName": "List",
      "name": "list",
      "type": "string",
      "default": "",
      "description": "Name of the list in Redis",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "llen"
          ]
        }
      }
    },
    {
      "displayName": "List",
      "name": "list",
      "type": "string",
      "default": "",
      "description": "Name of the list in Redis",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "llen"
          ]
        }
      }
    },
    {
      "displayName": "Key",
      "name": "key",
      "type": "string",
      "default": "",
      "description": "Name of the key to set in Redis",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "set"
          ]
        }
      }
    },
    {
      "displayName": "Value",
      "name": "value",
      "type": "string",
      "default": "",
      "description": "The value to write in Redis",
      "displayOptions": {
        "show": {
          "operation": [
            "set"
          ]
        }
      }
    },
    {
      "displayName": "Key Type",
      "name": "keyType",
      "type": "options",
      "default": "automatic",
      "description": "The type of the key to set",
      "options": [
        {
          "name": "Automatic",
          "value": "automatic",
          "description": "Tries to figure out the type automatically depending on the data"
        },
        {
          "name": "Hash",
          "value": "hash",
          "description": "Data in key is of type 'hash'"
        },
        {
          "name": "List",
          "value": "list",
          "description": "Data in key is of type 'lists'"
        },
        {
          "name": "Sets",
          "value": "sets",
          "description": "Data in key is of type 'sets'"
        },
        {
          "name": "String",
          "value": "string",
          "description": "Data in key is of type 'string'"
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "set"
          ]
        }
      }
    },
    {
      "displayName": "Value Is JSON",
      "name": "valueIsJSON",
      "type": "boolean",
      "default": true,
      "description": "Whether the value is JSON or key value pairs",
      "displayOptions": {
        "show": {
          "keyType": [
            "hash"
          ]
        }
      }
    },
    {
      "displayName": "Expire",
      "name": "expire",
      "type": "boolean",
      "default": false,
      "description": "Whether to set a timeout on key",
      "displayOptions": {
        "show": {
          "operation": [
            "set"
          ]
        }
      }
    },
    {
      "displayName": "TTL",
      "name": "ttl",
      "type": "number",
      "default": 60,
      "description": "Number of seconds before key expiration",
      "displayOptions": {
        "show": {
          "operation": [
            "set"
          ],
          "expire": [
            true
          ]
        }
      },
      "typeOptions": {
        "minValue": 1
      }
    },
    {
      "displayName": "Channel",
      "name": "channel",
      "type": "string",
      "default": "",
      "description": "Channel name",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "publish"
          ]
        }
      }
    },
    {
      "displayName": "Data",
      "name": "messageData",
      "type": "string",
      "default": "",
      "description": "Data to publish",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "publish"
          ]
        }
      }
    },
    {
      "displayName": "List",
      "name": "list",
      "type": "string",
      "default": "",
      "description": "Name of the list in Redis",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "push",
            "pop"
          ]
        }
      }
    },
    {
      "displayName": "Data",
      "name": "messageData",
      "type": "string",
      "default": "",
      "description": "Data to push",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "push"
          ]
        }
      }
    },
    {
      "displayName": "Tail",
      "name": "tail",
      "type": "boolean",
      "default": false,
      "description": "Whether to push or pop data from the end of the list",
      "displayOptions": {
        "show": {
          "operation": [
            "push",
            "pop"
          ]
        }
      }
    },
    {
      "displayName": "Name",
      "name": "propertyName",
      "type": "string",
      "default": "propertyName",
      "description": "Optional name of the property to write received data to. Supports dot-notation. Example: \"data.person[0].name\".",
      "displayOptions": {
        "show": {
          "operation": [
            "pop"
          ]
        }
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Dot Notation",
          "name": "dotNotation",
          "type": "boolean",
          "default": true,
          "description": "<p>By default, dot-notation is used in property names. This means that \"a.b\" will set the property \"b\" underneath \"a\" so { \"a\": { \"b\": value} }.<p></p>If that is not intended this can be deactivated, it will then set { \"a.b\": value } instead.</p>."
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "pop"
          ]
        }
      }
    }
  ]

operations:
  [
    {
      "operation": "delete",
      "name": "Delete",
      "description": "Delete a key from Redis"
    },
    {
      "operation": "get",
      "name": "Get",
      "description": "Get the value of a key from Redis"
    },
    {
      "operation": "incr",
      "name": "Increment",
      "description": "Atomically increments a key by 1. Creates the key if it does not exist."
    },
    {
      "operation": "info",
      "name": "Info",
      "description": "Returns generic information about the Redis instance"
    },
    {
      "operation": "keys",
      "name": "Keys",
      "description": "Returns all the keys matching a pattern"
    },
    {
      "operation": "llen",
      "name": "List Length",
      "description": "Returns the length of a list"
    },
    {
      "operation": "pop",
      "name": "Pop",
      "description": "Pop data from a redis list"
    },
    {
      "operation": "publish",
      "name": "Publish",
      "description": "Publish message to redis channel"
    },
    {
      "operation": "push",
      "name": "Push",
      "description": "Push data to a redis list"
    },
    {
      "operation": "set",
      "name": "Set",
      "description": "Set the value of a key in redis"
    }
  ]


node_type: nodes-base.redisTrigger
package_name: n8n-nodes-base
display_name: Redis Trigger
description: Subscribe to redis channel
category: trigger
development_style: programmatic
version: 1
operations: []
credentials_required:
  [
  {
  "name": "redis",
  "required": true,
  "testedBy": "redisConnectionTest"
  }
  ]

outputs:
  [
  "main"
  ]

updated_at: 2026-04-16 09:43:09
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: Redis Trigger node documentation
  description: Learn how to use the Redis Trigger node in n8n. Follow technical documentation to integrate Redis Trigger node into your workflows.
  contentType: [integration, reference]
  ---

  # Redis Trigger node

  [Redis](https://redis.io/){:target=_blank .external-link} is an open-source, in-memory data structure store, used as a database, cache and message broker.

  Use the Redis Trigger node to subscribe to a Redis channel. The workflow starts whenever the channel receives a new message.

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

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

properties_schema:
  [
    {
      "displayName": "Channels",
      "name": "channels",
      "type": "string",
      "default": "",
      "description": "Channels to subscribe to, multiple channels be defined with comma. Wildcard character(*) is supported.",
      "required": true
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "JSON Parse Body",
          "name": "jsonParseBody",
          "type": "boolean",
          "default": false,
          "description": "Whether to try to parse the message to an object"
        },
        {
          "displayName": "Only Message",
          "name": "onlyMessage",
          "type": "boolean",
          "default": false,
          "description": "Whether to return only the message property"
        }
      ]
    }
  ]


node_type: nodes-base.renameKeys
package_name: n8n-nodes-base
display_name: Rename Keys
description: Update item field names
category: transform
development_style: programmatic
version: 1
operations: []
credentials_required: []
outputs:
  [
  "main"
  ]

updated_at: 2026-04-16 09:43:09
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: Rename Keys
  description: Documentation for the Rename Keys node in n8n, a workflow automation platform. Includes guidance on usage, and links to examples.
  contentType: [integration, reference]
  priority: medium
  ---

  # Rename Keys

  Use the Rename Keys node to rename the keys of a key-value pair in n8n.

  ## Node parameters

  You can rename one or multiple keys using the Rename Keys node. Select the **Add new key** button to rename a key.

  For each key, enter the:

  - **Current Key Name**: The current name of the key you want to rename.
  - **New Key Name**: The new name you want to assign to the key.

  ## Node options

  Choose whether to use a **Regex** regular expression to identify keys to rename. To use this option, you must also enter:

  * The **Regular Expression** you'd like to use.
  * **Replace With**: Enter the new name you want to assign to the key(s) that match the **Regular Expression**.
  * You can also choose these Regex-specific options:
      * **Case Insensitive**: Set whether the regular expression should match case (turned off) or be case insensitive (turned on).
      * **Max Depth**: Enter the maximum depth to replace keys, using `-1` for unlimited and `0` for top-level only.

  /// warning | Regex impacts
  Using a regular expression can affect any keys that match the expression, including keys you've already renamed.
  ///

  ## Templates and examples

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

properties_schema:
  [
    {
      "displayName": "Keys",
      "name": "keys",
      "type": "fixedCollection",
      "default": {},
      "description": "Adds a key which should be renamed",
      "options": [
        {
          "displayName": "Key",
          "name": "key",
          "values": [
            {
              "displayName": "Current Key Name",
              "name": "currentKey",
              "type": "string",
              "default": "",
              "placeholder": "currentKey",
              "requiresDataPath": "single",
              "description": "The current name of the key. It is also possible to define deep keys by using dot-notation like for example: \"level1.level2.currentKey\"."
            },
            {
              "displayName": "New Key Name",
              "name": "newKey",
              "type": "string",
              "default": "",
              "placeholder": "newKey",
              "description": "The name the key should be renamed to. It is also possible to define deep keys by using dot-notation like for example: \"level1.level2.newKey\"."
            }
          ]
        }
      ],
      "typeOptions": {
        "multipleValues": true,
        "sortable": true
      }
    },
    {
      "displayName": "Additional Options",
      "name": "additionalOptions",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Regex",
          "name": "regexReplacement",
          "placeholder": "Add new regular expression",
          "description": "Adds a regular expression",
          "type": "fixedCollection",
          "typeOptions": {
            "multipleValues": true,
            "sortable": true
          },
          "default": {},
          "options": [
            {
              "displayName": "Replacement",
              "name": "replacements",
              "values": [
                {
                  "displayName": "Be aware that by using regular expression previously renamed keys can be affected",
                  "name": "regExNotice",
                  "type": "notice",
                  "default": ""
                },
                {
                  "displayName": "Regular Expression",
                  "name": "searchRegex",
                  "type": "string",
                  "default": "",
                  "placeholder": "e.g. [N-n]ame",
                  "description": "Regex to match the key name",
                  "hint": "Learn more and test RegEx <a href=\"https://regex101.com/\">here</a>"
                },
                {
                  "displayName": "Replace With",
                  "name": "replaceRegex",
                  "type": "string",
                  "default": "",
                  "placeholder": "replacedName",
                  "description": "The name the key/s should be renamed to. It's possible to use regex captures e.g. $1, $2, ..."
                },
                {
                  "displayName": "Options",
                  "name": "options",
                  "type": "collection",
                  "default": {},
                  "placeholder": "Add Regex Option",
                  "options": [
                    {
                      "displayName": "Case Insensitive",
                      "name": "caseInsensitive",
                      "type": "boolean",
                      "description": "Whether to use case insensitive match",
                      "default": false
                    },
                    {
                      "displayName": "Max Depth",
                      "name": "depth",
                      "type": "number",
                      "default": -1,
                      "description": "Maximum depth to replace keys",
                      "hint": "Specify number for depth level (-1 for unlimited, 0 for top level only)"
                    }
                  ]
                }
              ]
            }
          ]
        }
      ]
    }
  ]


node_type: nodes-base.respondToWebhook
package_name: n8n-nodes-base
display_name: Respond to Webhook
description: Returns data for Webhook
category: transform
development_style: programmatic
version: 1.5
operations: []
updated_at: 2026-04-16 09:43:09
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: Respond to Webhook
  description: Documentation for the Respond to Webhook node in n8n, a workflow automation platform. Includes guidance on usage, and links to examples.
  contentType: [integration, reference]
  priority: critical
  ---

  # Respond to Webhook

  Use the Respond to Webhook node to control the response to incoming webhooks. This node works with the [Webhook](/integrations/builtin/core-nodes/n8n-nodes-base.webhook/index.md) node.

  /// note | Runs once for the first data item
  The Respond to Webhook node runs once, using the first incoming data item. Refer to [Return more than one data item](#return-more-than-one-data-item-deprecated) for more information.
  ///

  ## How to use Respond to Webhook

  To use the Respond to Webhook node:

  1. Add a [Webhook](/integrations/builtin/core-nodes/n8n-nodes-base.webhook/index.md) node as the trigger node for the workflow.
  1. In the Webhook node, set **Respond** to **Using 'Respond to Webhook' node**.
  1. Add the Respond to Webhook node anywhere in your workflow. If you want it to return data from other nodes, place it after those nodes.

  ## Node parameters

  Configure the node behavior using these parameters.

  ### Respond With

  Choose what data to send in the webhook response.

  - **All Incoming Items**: Respond with all the JSON items from the input.
  - **Binary File**: Respond with a binary file defined in **Response Data Source**.
  - **First Incoming Item**: Respond with the first incoming item's JSON.
  - **JSON**: Respond with a JSON object defined in **Response Body**.
  - **JWT Token**: Respond with a JSON Web Token (JWT).
  - **No Data**: No response payload.
  - **Redirect**: Redirect to a URL set in **Redirect URL**.
  - **Text**: Respond with text set in **Response Body**.

  ## Node options

  Select **Add Option** to view and set the options.

  - **Response Code**: Set the [response code](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status) to use.
  - **Response Headers**: Define the response headers to send.
  - **Put Response in Field**: Available when you respond with **All Incoming Items** or **First Incoming Item**. Set the field name for the field containing the response data.

  ## Templates and examples

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

  ## Workflow behavior

  When using the Respond to Webhook node, workflows behave as follows:

  - The workflow finishes without executing the Respond to Webhook node: it returns a standard message with a 200 status.
  - The workflow errors before the first Respond to Webhook node executes: the workflow returns an error message with a 500 status.
  - A second Respond to Webhook node executes after the first one: the workflow ignores it.
  - A Respond to Webhook node executes but there was no webhook: the workflow ignores the Respond to Webhook node.

  ## Output the response sent to the webhook

  By default, the Respond to Webhook node has a single output branch that contains the node's input data.

  You can optionally enable a second output branch containing the response sent to the webhook. To enable this secondary output, open the Respond to Webhook node on the canvas and select the **Settings** tab. Activate the **Enable Response Output Branch** option.

  The node will now have two outputs:

  * **Input Data**: The original output, passing on the node's input.
  * **Response**: The response object sent to the webhook.

  ## Return more than one data item (deprecated)

  /// note | Deprecated in 1.22.0
  n8n 1.22.0 added support for returning all data items using the **All Incoming Items** option. n8n recommends upgrading to the latest version of n8n, instead of using the workarounds described in this section.
  ///

  The Respond to Webhook node runs once, using the first incoming data item. This includes when using [expressions](/code/expressions.md). You can't force looping using the Loop node: the workflow will run, but the webhook response will still only contain the results of the first execution. 

  If you need to return more than one data item, choose one of these options:

  - Instead of using the Respond to Webhook node, use the **When Last Node Finishes** option in **Respond** in the Webhook node. Use this when you want to return the final data that the workflow outputs.
  - Use the [Aggregate](/integrations/builtin/core-nodes/n8n-nodes-base.aggregate.md) node to turn multiple items into a single item before passing the data to the Respond to Webhook node. Set **Aggregate** to **All Item Data (Into a Single List)**.

properties_schema:
  [
    {
      "displayName": "Enable Response Output Branch",
      "name": "enableResponseOutput",
      "type": "boolean",
      "default": false,
      "description": "Whether to provide an additional output branch with the response sent to the webhook",
      "displayOptions": {
        "show": {
          "@version": [
            {
              "_cnd": {
                "gte": 1.4
              }
            }
          ]
        }
      }
    },
    {
      "displayName": "Verify that the \"Webhook\" node's \"Respond\" parameter is set to \"Using Respond to Webhook Node\". <a href=\"https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.respondtowebhook/\" target=\"_blank\">More details",
      "name": "generalNotice",
      "type": "notice",
      "default": ""
    },
    {
      "displayName": "Respond With",
      "name": "respondWith",
      "type": "options",
      "default": "firstIncomingItem",
      "description": "The data that should be returned",
      "options": [
        {
          "name": "All Incoming Items",
          "value": "allIncomingItems",
          "description": "Respond with all input JSON items"
        },
        {
          "name": "Binary File",
          "value": "binary",
          "description": "Respond with incoming file binary data"
        },
        {
          "name": "First Incoming Item",
          "value": "firstIncomingItem",
          "description": "Respond with the first input JSON item"
        },
        {
          "name": "JSON",
          "value": "json",
          "description": "Respond with a custom JSON body"
        },
        {
          "name": "JWT Token",
          "value": "jwt",
          "description": "Respond with a JWT token"
        },
        {
          "name": "No Data",
          "value": "noData",
          "description": "Respond with an empty body"
        },
        {
          "name": "Redirect",
          "value": "redirect",
          "description": "Respond with a redirect to a given URL"
        },
        {
          "name": "Text",
          "value": "text",
          "description": "Respond with a simple text message body"
        }
      ],
      "displayOptions": {
        "show": {
          "@version": [
            1,
            1.1
          ]
        }
      }
    },
    {
      "displayName": "Respond With",
      "name": "respondWith",
      "type": "options",
      "default": "firstIncomingItem",
      "description": "The data that should be returned",
      "options": [
        {
          "name": "All Incoming Items",
          "value": "allIncomingItems",
          "description": "Respond with all input JSON items"
        },
        {
          "name": "Binary File",
          "value": "binary",
          "description": "Respond with incoming file binary data"
        },
        {
          "name": "First Incoming Item",
          "value": "firstIncomingItem",
          "description": "Respond with the first input JSON item"
        },
        {
          "name": "JSON",
          "value": "json",
          "description": "Respond with a custom JSON body"
        },
        {
          "name": "JWT Token",
          "value": "jwt",
          "description": "Respond with a JWT token"
        },
        {
          "name": "No Data",
          "value": "noData",
          "description": "Respond with an empty body"
        },
        {
          "name": "Redirect",
          "value": "redirect",
          "description": "Respond with a redirect to a given URL"
        },
        {
          "name": "Text",
          "value": "text",
          "description": "Respond with a simple text message body"
        }
      ],
      "displayOptions": {
        "show": {
          "@version": [
            {
              "_cnd": {
                "gte": 1.2
              }
            }
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Credentials",
      "name": "credentials",
      "type": "credentials",
      "default": "",
      "displayOptions": {
        "show": {
          "respondWith": [
            "jwt"
          ]
        }
      }
    },
    {
      "displayName": "When using expressions, note that this node will only run for the first item in the input data",
      "name": "webhookNotice",
      "type": "notice",
      "default": "",
      "displayOptions": {
        "show": {
          "respondWith": [
            "json",
            "text",
            "jwt"
          ]
        }
      }
    },
    {
      "displayName": "Redirect URL",
      "name": "redirectURL",
      "type": "string",
      "default": "",
      "description": "The URL to redirect to",
      "required": true,
      "displayOptions": {
        "show": {
          "respondWith": [
            "redirect"
          ]
        }
      }
    },
    {
      "displayName": "Response Body",
      "name": "responseBody",
      "type": "json",
      "default": "{\n  \"myField\": \"value\"\n}",
      "description": "The HTTP response JSON data",
      "displayOptions": {
        "show": {
          "respondWith": [
            "json"
          ]
        }
      },
      "typeOptions": {
        "rows": 4
      }
    },
    {
      "displayName": "Payload",
      "name": "payload",
      "type": "json",
      "default": "{\n  \"myField\": \"value\"\n}",
      "description": "The payload to include in the JWT token",
      "displayOptions": {
        "show": {
          "respondWith": [
            "jwt"
          ]
        }
      },
      "typeOptions": {
        "rows": 4
      }
    },
    {
      "displayName": "Response Body",
      "name": "responseBody",
      "type": "string",
      "default": "",
      "description": "The HTTP response text data",
      "displayOptions": {
        "show": {
          "respondWith": [
            "text"
          ]
        }
      },
      "typeOptions": {
        "rows": 2
      }
    },
    {
      "displayName": "Response Data Source",
      "name": "responseDataSource",
      "type": "options",
      "default": "automatically",
      "options": [
        {
          "name": "Choose Automatically From Input",
          "value": "automatically",
          "description": "Use if input data will contain a single piece of binary data"
        },
        {
          "name": "Specify Myself",
          "value": "set",
          "description": "Enter the name of the input field the binary data will be in"
        }
      ],
      "displayOptions": {
        "show": {
          "respondWith": [
            "binary"
          ]
        }
      }
    },
    {
      "displayName": "Input Field Name",
      "name": "inputFieldName",
      "type": "string",
      "default": "data",
      "description": "The name of the node input field with the binary data",
      "required": true,
      "displayOptions": {
        "show": {
          "respondWith": [
            "binary"
          ],
          "responseDataSource": [
            "set"
          ]
        }
      }
    },
    {
      "displayName": "To avoid unexpected behavior, add a \"Content-Type\" response header with the appropriate value",
      "name": "contentTypeNotice",
      "type": "notice",
      "default": "",
      "displayOptions": {
        "show": {
          "respondWith": [
            "text"
          ]
        }
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Response Code",
          "name": "responseCode",
          "type": "number",
          "typeOptions": {
            "minValue": 100,
            "maxValue": 599
          },
          "default": 200,
          "description": "The HTTP response code to return. Defaults to 200."
        },
        {
          "displayName": "Response Headers",
          "name": "responseHeaders",
          "placeholder": "Add Response Header",
          "description": "Add headers to the webhook response",
          "type": "fixedCollection",
          "typeOptions": {
            "multipleValues": true
          },
          "default": {},
          "options": [
            {
              "name": "entries",
              "displayName": "Entries",
              "values": [
                {
                  "displayName": "Name",
                  "name": "name",
                  "type": "string",
                  "default": "",
                  "description": "Name of the header"
                },
                {
                  "displayName": "Value",
                  "name": "value",
                  "type": "string",
                  "default": "",
                  "description": "Value of the header"
                }
              ]
            }
          ]
        },
        {
          "displayName": "Put Response in Field",
          "name": "responseKey",
          "type": "string",
          "displayOptions": {
            "show": {
              "/respondWith": [
                "allIncomingItems",
                "firstIncomingItem"
              ]
            }
          },
          "default": "",
          "description": "The name of the response field to put all items in",
          "placeholder": "e.g. data"
        },
        {
          "displayName": "Enable Streaming",
          "name": "enableStreaming",
          "type": "boolean",
          "default": true,
          "description": "Whether to enable streaming to the response",
          "displayOptions": {
            "show": {
              "/respondWith": [
                "allIncomingItems",
                "firstIncomingItem",
                "text",
                "json",
                "jwt"
              ],
              "@version": [
                {
                  "_cnd": {
                    "gte": 1.5
                  }
                }
              ]
            }
          }
        }
      ]
    }
  ]

credentials_required:
  [
    {
      "name": "jwtAuth",
      "required": true,
      "displayOptions": {
        "show": {
          "respondWith": [
            "jwt"
          ]
        }
      }
    }
  ]

outputs:
  [
    "={{((version, parameters) => {\n    const multipleOutputs = version === 1.3 || (version >= 1.4 && parameters.enableResponseOutput);\n    if (multipleOutputs) {\n        return [\n            {\n                type: 'main',\n                displayName: 'Input Data',\n            },\n            {\n                type: 'main',\n                displayName: 'Response',\n            },\n        ];\n    }\n    return ['main'];\n})($nodeVersion, $parameter)}}"
  ]


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

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

output_names:
  [
  "Tool"
  ]

updated_at: 2026-04-16 09:43:09
tool_variant_of: nodes-base.rocketchat
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: Rocket.Chat node documentation
  description: Learn how to use the Rocket.Chat node in n8n. Follow technical documentation to integrate Rocket.Chat node into your workflows.
  contentType: [integration, reference]
  ---

  # Rocket.Chat node

  Use the Rocket.Chat node to automate work in Rocket.Chat, and integrate Rocket.Chat with other applications. n8n supports posting messages to channels, and sending direct messages, with Rocket.Chat. 

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

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

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

  ## Operations

  * Chat
      * Post a message to a channel or a direct message

  ## Templates and examples

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

  --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 send messages and communicate"
    },
    {
      "displayName": "Resource",
      "name": "resource",
      "type": "options",
      "default": "chat",
      "options": [
        {
          "name": "Chat",
          "value": "chat"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "postMessage",
      "options": [
        {
          "name": "Post Message",
          "value": "postMessage",
          "description": "Post a message to a channel or a direct message",
          "action": "Post a message"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "chat"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Channel",
      "name": "channel",
      "type": "string",
      "default": "",
      "description": "The channel name with the prefix in front of it",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "chat"
          ],
          "operation": [
            "postMessage"
          ]
        }
      }
    },
    {
      "displayName": "Text",
      "name": "text",
      "type": "string",
      "default": "",
      "description": "The text of the message to send, is optional because of attachments",
      "displayOptions": {
        "show": {
          "resource": [
            "chat"
          ],
          "operation": [
            "postMessage"
          ]
        }
      }
    },
    {
      "displayName": "JSON Parameters",
      "name": "jsonParameters",
      "type": "boolean",
      "default": false,
      "displayOptions": {
        "show": {
          "resource": [
            "chat"
          ],
          "operation": [
            "postMessage"
          ]
        }
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Alias",
          "name": "alias",
          "type": "string",
          "default": "",
          "description": "This will cause the message’s name to appear as the given alias, but your username will still display"
        },
        {
          "displayName": "Avatar",
          "name": "avatar",
          "type": "string",
          "default": "",
          "description": "If provided, this will make the avatar use the provided image URL"
        },
        {
          "displayName": "Emoji",
          "name": "emoji",
          "type": "string",
          "default": "",
          "description": "This will cause the message’s name to appear as the given alias, but your username will still display"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "chat"
          ],
          "operation": [
            "postMessage"
          ]
        }
      }
    },
    {
      "displayName": "Attachments",
      "name": "attachments",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Color",
          "name": "color",
          "type": "color",
          "default": "#ff0000",
          "description": "The color you want the order on the left side to be, any value background-css supports"
        },
        {
          "displayName": "Text",
          "name": "text",
          "type": "string",
          "default": "",
          "description": "The text to display for this attachment, it is different than the message’s text"
        },
        {
          "displayName": "Timestamp",
          "name": "ts",
          "type": "dateTime",
          "default": "",
          "description": "Displays the time next to the text portion"
        },
        {
          "displayName": "Thumb URL",
          "name": "thumbUrl",
          "type": "string",
          "default": "",
          "description": "An image that displays to the left of the text, looks better when this is relatively small"
        },
        {
          "displayName": "Message Link",
          "name": "messageLink",
          "type": "string",
          "default": "",
          "description": "Only applicable if the timestamp is provided, as it makes the time clickable to this link"
        },
        {
          "displayName": "Collapsed",
          "name": "collapsed",
          "type": "boolean",
          "default": false,
          "description": "Causes the image, audio, and video sections to be hiding when collapsed is true"
        },
        {
          "displayName": "Author Name",
          "name": "authorName",
          "type": "string",
          "default": "",
          "description": "Name of the author"
        },
        {
          "displayName": "Author Link",
          "name": "authorLink",
          "type": "string",
          "default": "",
          "description": "Providing this makes the author name clickable and points to this link"
        },
        {
          "displayName": "Author Icon",
          "name": "authorIcon",
          "type": "string",
          "default": "",
          "placeholder": "https://site.com/img.png",
          "description": "Displays a tiny icon to the left of the Author’s name"
        },
        {
          "displayName": "Title",
          "name": "title",
          "type": "string",
          "default": "",
          "description": "Title to display for this attachment, displays under the author"
        },
        {
          "displayName": "Title Link",
          "name": "titleLink",
          "type": "string",
          "default": "",
          "description": "Providing this makes the title clickable, pointing to this link"
        },
        {
          "displayName": "Title Link Download",
          "name": "titleLinkDownload",
          "type": "boolean",
          "default": false,
          "description": "When this is true, a download icon appears and clicking this saves the link to file"
        },
        {
          "displayName": "Image URL",
          "name": "imageUrl",
          "type": "string",
          "default": "",
          "description": "The image to display, will be “big” and easy to see"
        },
        {
          "displayName": "Audio URL",
          "name": "audioUrl",
          "type": "string",
          "default": "",
          "placeholder": "https://site.com/aud.mp3",
          "description": "Audio file to play, only supports what html audio does"
        },
        {
          "displayName": "Video URL",
          "name": "videoUrl",
          "type": "string",
          "default": "",
          "placeholder": "https://site.com/vid.mp4",
          "description": "Video file to play, only supports what html video does"
        },
        {
          "displayName": "Fields",
          "name": "fields",
          "type": "fixedCollection",
          "placeholder": "Add Field Item",
          "typeOptions": {
            "multipleValues": true
          },
          "default": {},
          "options": [
            {
              "name": "fieldsValues",
              "displayName": "Fields",
              "values": [
                {
                  "displayName": "Short",
                  "name": "short",
                  "type": "boolean",
                  "default": false,
                  "description": "Whether this field should be a short field"
                },
                {
                  "displayName": "Title",
                  "name": "title",
                  "type": "string",
                  "default": "",
                  "description": "The title of this field"
                },
                {
                  "displayName": "Value",
                  "name": "value",
                  "type": "string",
                  "default": "",
                  "description": "The value of this field, displayed underneath the title value"
                }
              ]
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "chat"
          ],
          "operation": [
            "postMessage"
          ],
          "jsonParameters": [
            false
          ]
        }
      },
      "typeOptions": {
        "multipleValues": true,
        "multipleValueButtonText": "Add Attachment"
      }
    },
    {
      "displayName": "Attachments",
      "name": "attachmentsJson",
      "type": "json",
      "default": "",
      "displayOptions": {
        "show": {
          "resource": [
            "chat"
          ],
          "operation": [
            "postMessage"
          ],
          "jsonParameters": [
            true
          ]
        }
      },
      "typeOptions": {
        "alwaysOpenEditWindow": true
      }
    }
  ]

operations:
  [
    {
      "operation": "postMessage",
      "name": "Post Message",
      "description": "Post a message to a channel or a direct message",
      "resource": "chat"
    }
  ]


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

outputs:
  [
  "main"
  ]

updated_at: 2026-04-16 09:43:09
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: Rocket.Chat node documentation
  description: Learn how to use the Rocket.Chat node in n8n. Follow technical documentation to integrate Rocket.Chat node into your workflows.
  contentType: [integration, reference]
  ---

  # Rocket.Chat node

  Use the Rocket.Chat node to automate work in Rocket.Chat, and integrate Rocket.Chat with other applications. n8n supports posting messages to channels, and sending direct messages, with Rocket.Chat. 

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

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

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

  ## Operations

  * Chat
      * Post a message to a channel or a direct message

  ## Templates and examples

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

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

properties_schema:
  [
    {
      "displayName": "Resource",
      "name": "resource",
      "type": "options",
      "default": "chat",
      "options": [
        {
          "name": "Chat",
          "value": "chat"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "postMessage",
      "options": [
        {
          "name": "Post Message",
          "value": "postMessage",
          "description": "Post a message to a channel or a direct message",
          "action": "Post a message"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "chat"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Channel",
      "name": "channel",
      "type": "string",
      "default": "",
      "description": "The channel name with the prefix in front of it",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "chat"
          ],
          "operation": [
            "postMessage"
          ]
        }
      }
    },
    {
      "displayName": "Text",
      "name": "text",
      "type": "string",
      "default": "",
      "description": "The text of the message to send, is optional because of attachments",
      "displayOptions": {
        "show": {
          "resource": [
            "chat"
          ],
          "operation": [
            "postMessage"
          ]
        }
      }
    },
    {
      "displayName": "JSON Parameters",
      "name": "jsonParameters",
      "type": "boolean",
      "default": false,
      "displayOptions": {
        "show": {
          "resource": [
            "chat"
          ],
          "operation": [
            "postMessage"
          ]
        }
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Alias",
          "name": "alias",
          "type": "string",
          "default": "",
          "description": "This will cause the message’s name to appear as the given alias, but your username will still display"
        },
        {
          "displayName": "Avatar",
          "name": "avatar",
          "type": "string",
          "default": "",
          "description": "If provided, this will make the avatar use the provided image URL"
        },
        {
          "displayName": "Emoji",
          "name": "emoji",
          "type": "string",
          "default": "",
          "description": "This will cause the message’s name to appear as the given alias, but your username will still display"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "chat"
          ],
          "operation": [
            "postMessage"
          ]
        }
      }
    },
    {
      "displayName": "Attachments",
      "name": "attachments",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Color",
          "name": "color",
          "type": "color",
          "default": "#ff0000",
          "description": "The color you want the order on the left side to be, any value background-css supports"
        },
        {
          "displayName": "Text",
          "name": "text",
          "type": "string",
          "default": "",
          "description": "The text to display for this attachment, it is different than the message’s text"
        },
        {
          "displayName": "Timestamp",
          "name": "ts",
          "type": "dateTime",
          "default": "",
          "description": "Displays the time next to the text portion"
        },
        {
          "displayName": "Thumb URL",
          "name": "thumbUrl",
          "type": "string",
          "default": "",
          "description": "An image that displays to the left of the text, looks better when this is relatively small"
        },
        {
          "displayName": "Message Link",
          "name": "messageLink",
          "type": "string",
          "default": "",
          "description": "Only applicable if the timestamp is provided, as it makes the time clickable to this link"
        },
        {
          "displayName": "Collapsed",
          "name": "collapsed",
          "type": "boolean",
          "default": false,
          "description": "Causes the image, audio, and video sections to be hiding when collapsed is true"
        },
        {
          "displayName": "Author Name",
          "name": "authorName",
          "type": "string",
          "default": "",
          "description": "Name of the author"
        },
        {
          "displayName": "Author Link",
          "name": "authorLink",
          "type": "string",
          "default": "",
          "description": "Providing this makes the author name clickable and points to this link"
        },
        {
          "displayName": "Author Icon",
          "name": "authorIcon",
          "type": "string",
          "default": "",
          "placeholder": "https://site.com/img.png",
          "description": "Displays a tiny icon to the left of the Author’s name"
        },
        {
          "displayName": "Title",
          "name": "title",
          "type": "string",
          "default": "",
          "description": "Title to display for this attachment, displays under the author"
        },
        {
          "displayName": "Title Link",
          "name": "titleLink",
          "type": "string",
          "default": "",
          "description": "Providing this makes the title clickable, pointing to this link"
        },
        {
          "displayName": "Title Link Download",
          "name": "titleLinkDownload",
          "type": "boolean",
          "default": false,
          "description": "When this is true, a download icon appears and clicking this saves the link to file"
        },
        {
          "displayName": "Image URL",
          "name": "imageUrl",
          "type": "string",
          "default": "",
          "description": "The image to display, will be “big” and easy to see"
        },
        {
          "displayName": "Audio URL",
          "name": "audioUrl",
          "type": "string",
          "default": "",
          "placeholder": "https://site.com/aud.mp3",
          "description": "Audio file to play, only supports what html audio does"
        },
        {
          "displayName": "Video URL",
          "name": "videoUrl",
          "type": "string",
          "default": "",
          "placeholder": "https://site.com/vid.mp4",
          "description": "Video file to play, only supports what html video does"
        },
        {
          "displayName": "Fields",
          "name": "fields",
          "type": "fixedCollection",
          "placeholder": "Add Field Item",
          "typeOptions": {
            "multipleValues": true
          },
          "default": {},
          "options": [
            {
              "name": "fieldsValues",
              "displayName": "Fields",
              "values": [
                {
                  "displayName": "Short",
                  "name": "short",
                  "type": "boolean",
                  "default": false,
                  "description": "Whether this field should be a short field"
                },
                {
                  "displayName": "Title",
                  "name": "title",
                  "type": "string",
                  "default": "",
                  "description": "The title of this field"
                },
                {
                  "displayName": "Value",
                  "name": "value",
                  "type": "string",
                  "default": "",
                  "description": "The value of this field, displayed underneath the title value"
                }
              ]
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "chat"
          ],
          "operation": [
            "postMessage"
          ],
          "jsonParameters": [
            false
          ]
        }
      },
      "typeOptions": {
        "multipleValues": true,
        "multipleValueButtonText": "Add Attachment"
      }
    },
    {
      "displayName": "Attachments",
      "name": "attachmentsJson",
      "type": "json",
      "default": "",
      "displayOptions": {
        "show": {
          "resource": [
            "chat"
          ],
          "operation": [
            "postMessage"
          ],
          "jsonParameters": [
            true
          ]
        }
      },
      "typeOptions": {
        "alwaysOpenEditWindow": true
      }
    }
  ]

operations:
  [
    {
      "operation": "postMessage",
      "name": "Post Message",
      "description": "Post a message to a channel or a direct message",
      "resource": "chat"
    }
  ]


node_type: nodes-base.rssFeedReadTool
package_name: n8n-nodes-base
display_name: RSS Read Tool
description: Reads data from an RSS Feed (AI Tool variant for use with AI Agents)
category: input
development_style: programmatic
version: 1.2
operations: []
credentials_required: []
outputs:
  [
  {
  "type": "ai_tool",
  "displayName": "Tool"
  }
  ]

output_names:
  [
  "Tool"
  ]

updated_at: 2026-04-16 09:43:09
tool_variant_of: nodes-base.rssFeedRead
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: RSS Read
  description: Documentation for the RSS Read node in n8n, a workflow automation platform. Includes guidance on usage, and links to examples.
  contentType: [integration, reference]
  priority: medium
  ---

  # RSS Read

  Use the RSS Read node to read data from RSS feeds published on the internet.

  ## Node parameters

  - **URL**: Enter the URL for the RSS publication you want to read.

  ## Node options

  * **Ignore SSL Issues**: Choose whether n8n should ignore SSL/TLS verification (turned on) or not (turned off).

  ## Templates and examples

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

  ## Related resources

  n8n provides a trigger node for RSS Read. You can find the trigger node docs [here](/integrations/builtin/core-nodes/n8n-nodes-base.rssfeedreadtrigger.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 RSS Read"
    },
    {
      "displayName": "URL",
      "name": "url",
      "type": "string",
      "default": "",
      "description": "URL of the RSS feed",
      "required": true
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Custom Fields",
          "name": "customFields",
          "type": "string",
          "default": "",
          "description": "A comma-separated list of custom fields to include in the output. For example, \"author, contentSnippet\"."
        },
        {
          "displayName": "Ignore SSL Issues (Insecure)",
          "name": "ignoreSSL",
          "type": "boolean",
          "default": false,
          "description": "Whether to ignore SSL/TLS certificate issues or not"
        }
      ]
    }
  ]


node_type: nodes-base.rssFeedRead
package_name: n8n-nodes-base
display_name: RSS Read
description: Reads data from an RSS Feed
category: input
development_style: programmatic
version: 1.2
operations: []
credentials_required: []
outputs:
  [
  "main"
  ]

updated_at: 2026-04-16 09:43:09
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: RSS Read
  description: Documentation for the RSS Read node in n8n, a workflow automation platform. Includes guidance on usage, and links to examples.
  contentType: [integration, reference]
  priority: medium
  ---

  # RSS Read

  Use the RSS Read node to read data from RSS feeds published on the internet.

  ## Node parameters

  - **URL**: Enter the URL for the RSS publication you want to read.

  ## Node options

  * **Ignore SSL Issues**: Choose whether n8n should ignore SSL/TLS verification (turned on) or not (turned off).

  ## Templates and examples

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

  ## Related resources

  n8n provides a trigger node for RSS Read. You can find the trigger node docs [here](/integrations/builtin/core-nodes/n8n-nodes-base.rssfeedreadtrigger.md).

properties_schema:
  [
    {
      "displayName": "URL",
      "name": "url",
      "type": "string",
      "default": "",
      "description": "URL of the RSS feed",
      "required": true
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Custom Fields",
          "name": "customFields",
          "type": "string",
          "default": "",
          "description": "A comma-separated list of custom fields to include in the output. For example, \"author, contentSnippet\"."
        },
        {
          "displayName": "Ignore SSL Issues (Insecure)",
          "name": "ignoreSSL",
          "type": "boolean",
          "default": false,
          "description": "Whether to ignore SSL/TLS certificate issues or not"
        }
      ]
    }
  ]


node_type: nodes-base.rssFeedReadTrigger
package_name: n8n-nodes-base
display_name: RSS Feed Trigger
description: Starts a workflow when an RSS feed is updated
category: trigger
development_style: programmatic
version: 1
operations: []
credentials_required: []
outputs:
  [
  "main"
  ]

updated_at: 2026-04-16 09:43:09
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: RSS Feed Trigger node documentation
  description: Learn how to use the RSS Feed Trigger node in n8n. Follow technical documentation to integrate RSS Feed Trigger node into your workflows.
  contentType: [integration, reference]
  priority: medium
  ---

  # RSS Feed Trigger node

  The RSS Feed Trigger node allows you to start an n8n workflow when a new RSS feed item has been published.

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

  ## Node parameters

  * **Poll Times**: Select a poll **Mode** to set how often to trigger the poll. Your **Mode** selection will add or remove relevant fields. Refer to the sections below to configure the parameters for each mode type.
  * **Feed URL**: Enter the URL of the RSS feed to poll.

  --8<-- "_snippets/integrations/builtin/poll-modes.md"

  ## Templates and examples

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

  ## Related resources

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

properties_schema:
  [
    {
      "displayName": "Feed URL",
      "name": "feedUrl",
      "type": "string",
      "default": "https://blog.n8n.io/rss/",
      "description": "URL of the RSS feed to poll",
      "required": true
    }
  ]


node_type: nodes-base.rundeckTool
package_name: n8n-nodes-base
display_name: Rundeck Tool
description: Manage Rundeck API (AI Tool variant for use with AI Agents)
category: transform
development_style: programmatic
version: 1
credentials_required:
  [
  {
  "name": "rundeckApi",
  "required": true
  }
  ]

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

output_names:
  [
  "Tool"
  ]

updated_at: 2026-04-16 09:43:09
tool_variant_of: nodes-base.rundeck
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: Rundeck node documentation
  description: Learn how to use the Rundeck node in n8n. Follow technical documentation to integrate Rundeck node into your workflows.
  contentType: [integration, reference]
  ---

  # Rundeck node

  Use the Rundeck node to automate work in Rundeck, and integrate Rundeck with other applications. n8n has built-in support for executing jobs and getting metadata.

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

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

  ## Operations

  - **Job**
      - Execute a job
      - Get metadata of a job

  ## Templates and examples

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

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

  ## Find the job ID

  1. Access your Rundeck dashboard.
  2. Open the project that contains the job you want to use with n8n.
  3. In the sidebar, select **JOBS**.
  4. Under **All Jobs**, select the name of the job you want to use with n8n.
  5. In the top left corner, under the name of the job, copy the string that's displayed in smaller font below the job name. This is your job ID.
  6. Paste this job ID in the **Job Id** field in n8n.

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 Rundeck"
    },
    {
      "displayName": "Resource",
      "name": "resource",
      "type": "options",
      "default": "job",
      "options": [
        {
          "name": "Job",
          "value": "job"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "execute",
      "options": [
        {
          "name": "Execute",
          "value": "execute",
          "description": "Execute a job",
          "action": "Execute a job"
        },
        {
          "name": "Get Metadata",
          "value": "getMetadata",
          "description": "Get metadata of a job",
          "action": "Get metadata of a job"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "Job ID",
      "name": "jobid",
      "type": "string",
      "default": "",
      "description": "The job ID to execute",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "execute"
          ],
          "resource": [
            "job"
          ]
        }
      }
    },
    {
      "displayName": "Arguments",
      "name": "arguments",
      "type": "fixedCollection",
      "default": {},
      "options": [
        {
          "name": "arguments",
          "displayName": "Arguments",
          "values": [
            {
              "displayName": "Name",
              "name": "name",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "Value",
              "name": "value",
              "type": "string",
              "default": ""
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "execute"
          ],
          "resource": [
            "job"
          ]
        }
      },
      "typeOptions": {
        "multipleValues": true
      }
    },
    {
      "displayName": "Filter",
      "name": "filter",
      "type": "string",
      "default": "",
      "description": "Filter Rundeck nodes by name",
      "displayOptions": {
        "show": {
          "operation": [
            "execute"
          ],
          "resource": [
            "job"
          ]
        }
      }
    },
    {
      "displayName": "Job ID",
      "name": "jobid",
      "type": "string",
      "default": "",
      "description": "The job ID to get metadata off",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "getMetadata"
          ],
          "resource": [
            "job"
          ]
        }
      }
    }
  ]

operations:
  [
    {
      "operation": "execute",
      "name": "Execute",
      "description": "Execute a job"
    },
    {
      "operation": "getMetadata",
      "name": "Get Metadata",
      "description": "Get metadata of a job"
    }
  ]


node_type: nodes-base.rundeck
package_name: n8n-nodes-base
display_name: Rundeck
description: Manage Rundeck API
category: transform
development_style: programmatic
version: 1
credentials_required:
  [
  {
  "name": "rundeckApi",
  "required": true
  }
  ]

outputs:
  [
  "main"
  ]

updated_at: 2026-04-16 09:43:09
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: Rundeck node documentation
  description: Learn how to use the Rundeck node in n8n. Follow technical documentation to integrate Rundeck node into your workflows.
  contentType: [integration, reference]
  ---

  # Rundeck node

  Use the Rundeck node to automate work in Rundeck, and integrate Rundeck with other applications. n8n has built-in support for executing jobs and getting metadata.

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

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

  ## Operations

  - **Job**
      - Execute a job
      - Get metadata of a job

  ## Templates and examples

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

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

  ## Find the job ID

  1. Access your Rundeck dashboard.
  2. Open the project that contains the job you want to use with n8n.
  3. In the sidebar, select **JOBS**.
  4. Under **All Jobs**, select the name of the job you want to use with n8n.
  5. In the top left corner, under the name of the job, copy the string that's displayed in smaller font below the job name. This is your job ID.
  6. Paste this job ID in the **Job Id** field in n8n.

properties_schema:
  [
    {
      "displayName": "Resource",
      "name": "resource",
      "type": "options",
      "default": "job",
      "options": [
        {
          "name": "Job",
          "value": "job"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "execute",
      "options": [
        {
          "name": "Execute",
          "value": "execute",
          "description": "Execute a job",
          "action": "Execute a job"
        },
        {
          "name": "Get Metadata",
          "value": "getMetadata",
          "description": "Get metadata of a job",
          "action": "Get metadata of a job"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "Job ID",
      "name": "jobid",
      "type": "string",
      "default": "",
      "description": "The job ID to execute",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "execute"
          ],
          "resource": [
            "job"
          ]
        }
      }
    },
    {
      "displayName": "Arguments",
      "name": "arguments",
      "type": "fixedCollection",
      "default": {},
      "options": [
        {
          "name": "arguments",
          "displayName": "Arguments",
          "values": [
            {
              "displayName": "Name",
              "name": "name",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "Value",
              "name": "value",
              "type": "string",
              "default": ""
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "execute"
          ],
          "resource": [
            "job"
          ]
        }
      },
      "typeOptions": {
        "multipleValues": true
      }
    },
    {
      "displayName": "Filter",
      "name": "filter",
      "type": "string",
      "default": "",
      "description": "Filter Rundeck nodes by name",
      "displayOptions": {
        "show": {
          "operation": [
            "execute"
          ],
          "resource": [
            "job"
          ]
        }
      }
    },
    {
      "displayName": "Job ID",
      "name": "jobid",
      "type": "string",
      "default": "",
      "description": "The job ID to get metadata off",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "getMetadata"
          ],
          "resource": [
            "job"
          ]
        }
      }
    }
  ]

operations:
  [
    {
      "operation": "execute",
      "name": "Execute",
      "description": "Execute a job"
    },
    {
      "operation": "getMetadata",
      "name": "Get Metadata",
      "description": "Get metadata of a job"
    }
  ]


node_type: nodes-base.s3Tool
package_name: n8n-nodes-base
display_name: S3 Tool
description: Sends data to any S3-compatible service (AI Tool variant for use with AI Agents)
category: output
development_style: programmatic
version: 1
credentials_required:
  [
  {
  "name": "s3",
  "required": true
  }
  ]

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

output_names:
  [
  "Tool"
  ]

updated_at: 2026-04-16 09:43:09
tool_variant_of: nodes-base.s3
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: S3 node documentation
  description: Learn how to use the S3 node in n8n. Follow technical documentation to integrate S3 node into your workflows.
  contentType: [integration, reference]
  priority: medium
  ---

  # S3 node

  Use the S3 node to automate work in non-AWS S3 storage and integrate S3 with other applications. n8n has built-in support for a wide range of S3 features, including creating, deleting, and getting buckets, files, and folders. For AWS S3, use [AWS S3](/integrations/builtin/app-nodes/n8n-nodes-base.awss3.md).

  Use the S3 node for non-AWS S3 solutions like:

  * [MinIO](https://min.io/){:target="_blank" .external-link}
  * [Wasabi](https://wasabi.com/){:target="_blank" .external-link}
  * [Digital Ocean spaces](https://www.digitalocean.com/products/spaces){:target="_blank" .external-link}

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

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

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

  ## Operations

  * Bucket
      * Create a bucket
      * Delete a bucket
      * Get all buckets
      * Search within a bucket
  * File
      * Copy a file
      * Delete a file
      * Download a file
      * Get all files
      * Upload a file

      /// note | Attach file for upload
      To attach a file for upload, use another node to pass the file as a data property. Nodes like the [Read/Write Files from Disk](/integrations/builtin/core-nodes/n8n-nodes-base.readwritefile.md) node or the [HTTP Request](/integrations/builtin/core-nodes/n8n-nodes-base.httprequest/index.md) work well.
      ///

  * Folder
      * Create a folder
      * Delete a folder
      * Get all folders

  ## Templates and examples

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

  ## Node reference

  ### Setting file permissions in Wasabi

  When uploading files to [Wasabi](https://wasabi.com/){:target="_blank" .external-link}, you must set permissions for the files using the **ACL** dropdown and not the toggles.

  ![File permissions when using the S3 node with Wasabi](/_images/integrations/builtin/app-nodes/s3/acl_dropdown.png)

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 S3"
    },
    {
      "displayName": "This node is for services that use the S3 standard, e.g. Minio or Digital Ocean Spaces. For AWS S3 use the 'AWS S3' node.",
      "name": "s3StandardNotice",
      "type": "notice",
      "default": ""
    },
    {
      "displayName": "Resource",
      "name": "resource",
      "type": "options",
      "default": "file",
      "options": [
        {
          "name": "Bucket",
          "value": "bucket"
        },
        {
          "name": "File",
          "value": "file"
        },
        {
          "name": "Folder",
          "value": "folder"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create a bucket",
          "action": "Create a bucket"
        },
        {
          "name": "Delete",
          "value": "delete",
          "description": "Delete a bucket",
          "action": "Delete a bucket"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get many buckets",
          "action": "Get many buckets"
        },
        {
          "name": "Search",
          "value": "search",
          "description": "Search within a bucket",
          "action": "Search a bucket"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "bucket"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Name",
      "name": "name",
      "type": "string",
      "default": "",
      "description": "A succinct description of the nature, symptoms, cause, or effect of the bucket",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "bucket"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "ACL",
          "name": "acl",
          "type": "options",
          "options": [
            {
              "name": "Authenticated Read",
              "value": "authenticatedRead"
            },
            {
              "name": "Private",
              "value": "Private"
            },
            {
              "name": "Public Read",
              "value": "publicRead"
            },
            {
              "name": "Public Read Write",
              "value": "publicReadWrite"
            }
          ],
          "default": "",
          "description": "The canned ACL to apply to the bucket"
        },
        {
          "displayName": "Bucket Object Lock Enabled",
          "name": "bucketObjectLockEnabled",
          "type": "boolean",
          "default": false,
          "description": "Whether you want S3 Object Lock to be enabled for the new bucket"
        },
        {
          "displayName": "Grant Full Control",
          "name": "grantFullControl",
          "type": "boolean",
          "default": false,
          "description": "Whether to allow grantee the read, write, read ACP, and write ACP permissions on the bucket"
        },
        {
          "displayName": "Grant Read",
          "name": "grantRead",
          "type": "boolean",
          "default": false,
          "description": "Whether to allow grantee to list the objects in the bucket"
        },
        {
          "displayName": "Grant Read ACP",
          "name": "grantReadAcp",
          "type": "boolean",
          "default": false,
          "description": "Whether to allow grantee to read the bucket ACL"
        },
        {
          "displayName": "Grant Write",
          "name": "grantWrite",
          "type": "boolean",
          "default": false,
          "description": "Whether to allow grantee to create, overwrite, and delete any object in the bucket"
        },
        {
          "displayName": "Grant Write ACP",
          "name": "grantWriteAcp",
          "type": "boolean",
          "default": false,
          "description": "Whether to allow grantee to write the ACL for the applicable bucket"
        },
        {
          "displayName": "Region",
          "name": "region",
          "type": "string",
          "default": "",
          "description": "Region you want to create the bucket in, by default the buckets are created on the region defined on the credentials"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "bucket"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Name",
      "name": "name",
      "type": "string",
      "default": "",
      "description": "Name of the AWS S3 bucket to delete",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "bucket"
          ],
          "operation": [
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "Return All",
      "name": "returnAll",
      "type": "boolean",
      "default": false,
      "description": "Whether to return all results or only up to a given limit",
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "bucket"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 100,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "bucket"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 500
      }
    },
    {
      "displayName": "Bucket Name",
      "name": "bucketName",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "bucket"
          ],
          "operation": [
            "search"
          ]
        }
      }
    },
    {
      "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": [
            "search"
          ],
          "resource": [
            "bucket"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 100,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "operation": [
            "search"
          ],
          "resource": [
            "bucket"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 500
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Delimiter",
          "name": "delimiter",
          "type": "string",
          "default": "",
          "description": "A delimiter is a character you use to group keys"
        },
        {
          "displayName": "Encoding Type",
          "name": "encodingType",
          "type": "options",
          "options": [
            {
              "name": "URL",
              "value": "url"
            }
          ],
          "default": "",
          "description": "Encoding type used by Amazon S3 to encode object keys in the response"
        },
        {
          "displayName": "Fetch Owner",
          "name": "fetchOwner",
          "type": "boolean",
          "default": false,
          "description": "The owner field is not present in listV2 by default, if you want to return owner field with each key in the result then set the fetch owner field to true"
        },
        {
          "displayName": "Prefix",
          "name": "prefix",
          "type": "string",
          "default": "",
          "description": "Limits the response to keys that begin with the specified prefix"
        },
        {
          "displayName": "Requester Pays",
          "name": "requesterPays",
          "type": "boolean",
          "default": false,
          "description": "Whether the requester will pay for requests and data transfer. While Requester Pays is enabled, anonymous access to this bucket is disabled."
        },
        {
          "displayName": "Start After",
          "name": "startAfter",
          "type": "string",
          "default": "",
          "description": "StartAfter is where you want Amazon S3 to start listing from. Amazon S3 starts listing after this specified key."
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "bucket"
          ],
          "operation": [
            "search"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create a folder",
          "action": "Create a folder"
        },
        {
          "name": "Delete",
          "value": "delete",
          "description": "Delete a folder",
          "action": "Delete a folder"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get many folders",
          "action": "Get many folders"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "folder"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Bucket Name",
      "name": "bucketName",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "folder"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Folder Name",
      "name": "folderName",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "folder"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Parent Folder Key",
          "name": "parentFolderKey",
          "type": "string",
          "default": "",
          "description": "Parent folder you want to create the folder in"
        },
        {
          "displayName": "Requester Pays",
          "name": "requesterPays",
          "type": "boolean",
          "default": false,
          "description": "Whether the requester will pay for requests and data transfer. While Requester Pays is enabled, anonymous access to this bucket is disabled."
        },
        {
          "displayName": "Storage Class",
          "name": "storageClass",
          "type": "options",
          "options": [
            {
              "name": "Deep Archive",
              "value": "deepArchive"
            },
            {
              "name": "Glacier",
              "value": "glacier"
            },
            {
              "name": "Intelligent Tiering",
              "value": "intelligentTiering"
            },
            {
              "name": "One Zone IA",
              "value": "onezoneIA"
            },
            {
              "name": "Reduced Redundancy",
              "value": "RecudedRedundancy"
            },
            {
              "name": "Standard",
              "value": "standard"
            },
            {
              "name": "Standard IA",
              "value": "standardIA"
            }
          ],
          "default": "standard",
          "description": "Amazon S3 storage classes"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "folder"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Bucket Name",
      "name": "bucketName",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "folder"
          ],
          "operation": [
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "Folder Key",
      "name": "folderKey",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "folder"
          ],
          "operation": [
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "Bucket Name",
      "name": "bucketName",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "folder"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Return All",
      "name": "returnAll",
      "type": "boolean",
      "default": false,
      "description": "Whether to return all results or only up to a given limit",
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "folder"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 100,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "folder"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 500
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Fetch Owner",
          "name": "fetchOwner",
          "type": "boolean",
          "default": false,
          "description": "The owner field is not present in listV2 by default, if you want to return owner field with each key in the result then set the fetch owner field to true"
        },
        {
          "displayName": "Folder Key",
          "name": "folderKey",
          "type": "string",
          "default": ""
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "folder"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "download",
      "options": [
        {
          "name": "Copy",
          "value": "copy",
          "description": "Copy a file",
          "action": "Copy a file"
        },
        {
          "name": "Delete",
          "value": "delete",
          "description": "Delete a file",
          "action": "Delete a file"
        },
        {
          "name": "Download",
          "value": "download",
          "description": "Download a file",
          "action": "Download a file"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get many files",
          "action": "Get many files"
        },
        {
          "name": "Upload",
          "value": "upload",
          "description": "Upload a file",
          "action": "Upload a file"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "file"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Source Path",
      "name": "sourcePath",
      "type": "string",
      "default": "",
      "description": "The name of the source bucket should start with (/) and key name of the source object, separated by a slash (/)",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "file"
          ],
          "operation": [
            "copy"
          ]
        }
      }
    },
    {
      "displayName": "Destination Path",
      "name": "destinationPath",
      "type": "string",
      "default": "",
      "description": "The name of the destination bucket and key name of the destination object, separated by a slash (/)",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "file"
          ],
          "operation": [
            "copy"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "ACL",
          "name": "acl",
          "type": "options",
          "options": [
            {
              "name": "Authenticated Read",
              "value": "authenticatedRead"
            },
            {
              "name": "AWS Exec Read",
              "value": "awsExecRead"
            },
            {
              "name": "Bucket Owner Full Control",
              "value": "bucketOwnerFullControl"
            },
            {
              "name": "Bucket Owner Read",
              "value": "bucketOwnerRead"
            },
            {
              "name": "Private",
              "value": "private"
            },
            {
              "name": "Public Read",
              "value": "publicRead"
            },
            {
              "name": "Public Read Write",
              "value": "publicReadWrite"
            }
          ],
          "default": "private",
          "description": "The canned ACL to apply to the object"
        },
        {
          "displayName": "Grant Full Control",
          "name": "grantFullControl",
          "type": "boolean",
          "default": false,
          "description": "Whether to give the grantee READ, READ_ACP, and WRITE_ACP permissions on the object"
        },
        {
          "displayName": "Grant Read",
          "name": "grantRead",
          "type": "boolean",
          "default": false,
          "description": "Whether to allow grantee to read the object data and its metadata"
        },
        {
          "displayName": "Grant Read ACP",
          "name": "grantReadAcp",
          "type": "boolean",
          "default": false,
          "description": "Whether to allow grantee to read the object ACL"
        },
        {
          "displayName": "Grant Write ACP",
          "name": "grantWriteAcp",
          "type": "boolean",
          "default": false,
          "description": "Whether to allow grantee to write the ACL for the applicable object"
        },
        {
          "displayName": "Lock Legal Hold",
          "name": "lockLegalHold",
          "type": "boolean",
          "default": false,
          "description": "Whether a legal hold will be applied to this object"
        },
        {
          "displayName": "Lock Mode",
          "name": "lockMode",
          "type": "options",
          "options": [
            {
              "name": "Governance",
              "value": "governance"
            },
            {
              "name": "Compliance",
              "value": "compliance"
            }
          ],
          "default": "",
          "description": "The Object Lock mode that you want to apply to this object"
        },
        {
          "displayName": "Lock Retain Until Date",
          "name": "lockRetainUntilDate",
          "type": "dateTime",
          "default": "",
          "description": "The date and time when you want this object's Object Lock to expire"
        },
        {
          "displayName": "Metadata Directive",
          "name": "metadataDirective",
          "type": "options",
          "options": [
            {
              "name": "Copy",
              "value": "copy"
            },
            {
              "name": "Replace",
              "value": "replace"
            }
          ],
          "default": "",
          "description": "Specifies whether the metadata is copied from the source object or replaced with metadata provided in the request"
        },
        {
          "displayName": "Requester Pays",
          "name": "requesterPays",
          "type": "boolean",
          "default": false,
          "description": "Whether the requester will pay for requests and data transfer. While Requester Pays is enabled, anonymous access to this bucket is disabled."
        },
        {
          "displayName": "Server Side Encryption",
          "name": "serverSideEncryption",
          "type": "options",
          "options": [
            {
              "name": "AES256",
              "value": "AES256"
            },
            {
              "name": "AWS:KMS",
              "value": "aws:kms"
            }
          ],
          "default": "",
          "description": "The server-side encryption algorithm used when storing this object in Amazon S3"
        },
        {
          "displayName": "Server Side Encryption Context",
          "name": "serverSideEncryptionContext",
          "type": "string",
          "default": "",
          "description": "Specifies the AWS KMS Encryption Context to use for object encryption"
        },
        {
          "displayName": "Server Side Encryption AWS KMS Key ID",
          "name": "encryptionAwsKmsKeyId",
          "type": "string",
          "default": "",
          "description": "If x-amz-server-side-encryption is present and has the value of aws:kms"
        },
        {
          "displayName": "Server Side Encryption Customer Algorithm",
          "name": "serversideEncryptionCustomerAlgorithm",
          "type": "string",
          "default": "",
          "description": "Specifies the algorithm to use to when encrypting the object (for example, AES256)"
        },
        {
          "displayName": "Server Side Encryption Customer Key",
          "name": "serversideEncryptionCustomerKey",
          "type": "string",
          "default": "",
          "description": "Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data"
        },
        {
          "displayName": "Server Side Encryption Customer Key MD5",
          "name": "serversideEncryptionCustomerKeyMD5",
          "type": "string",
          "default": "",
          "description": "Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321"
        },
        {
          "displayName": "Storage Class",
          "name": "storageClass",
          "type": "options",
          "options": [
            {
              "name": "Deep Archive",
              "value": "deepArchive"
            },
            {
              "name": "Glacier",
              "value": "glacier"
            },
            {
              "name": "Intelligent Tiering",
              "value": "intelligentTiering"
            },
            {
              "name": "One Zone IA",
              "value": "onezoneIA"
            },
            {
              "name": "Standard",
              "value": "standard"
            },
            {
              "name": "Standard IA",
              "value": "standardIA"
            }
          ],
          "default": "standard",
          "description": "Amazon S3 storage classes"
        },
        {
          "displayName": "Tagging Directive",
          "name": "taggingDirective",
          "type": "options",
          "options": [
            {
              "name": "Copy",
              "value": "copy"
            },
            {
              "name": "Replace",
              "value": "replace"
            }
          ],
          "default": "",
          "description": "Specifies whether the metadata is copied from the source object or replaced with metadata provided in the request"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "file"
          ],
          "operation": [
            "copy"
          ]
        }
      }
    },
    {
      "displayName": "Bucket Name",
      "name": "bucketName",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "file"
          ],
          "operation": [
            "upload"
          ]
        }
      }
    },
    {
      "displayName": "File Name",
      "name": "fileName",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "file"
          ],
          "operation": [
            "upload"
          ],
          "binaryData": [
            false
          ]
        }
      }
    },
    {
      "displayName": "File Name",
      "name": "fileName",
      "type": "string",
      "default": "",
      "description": "If not set the binary data filename will be used",
      "displayOptions": {
        "show": {
          "resource": [
            "file"
          ],
          "operation": [
            "upload"
          ],
          "binaryData": [
            true
          ]
        }
      }
    },
    {
      "displayName": "Binary File",
      "name": "binaryData",
      "type": "boolean",
      "default": true,
      "description": "Whether the data to upload should be taken from binary field",
      "displayOptions": {
        "show": {
          "operation": [
            "upload"
          ],
          "resource": [
            "file"
          ]
        }
      }
    },
    {
      "displayName": "File Content",
      "name": "fileContent",
      "type": "string",
      "default": "",
      "description": "The text content of the file to upload",
      "displayOptions": {
        "show": {
          "operation": [
            "upload"
          ],
          "resource": [
            "file"
          ],
          "binaryData": [
            false
          ]
        }
      }
    },
    {
      "displayName": "Input Binary Field",
      "name": "binaryPropertyName",
      "type": "string",
      "default": "data",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "upload"
          ],
          "resource": [
            "file"
          ],
          "binaryData": [
            true
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "ACL",
          "name": "acl",
          "type": "options",
          "options": [
            {
              "name": "Authenticated Read",
              "value": "authenticatedRead"
            },
            {
              "name": "AWS Exec Read",
              "value": "awsExecRead"
            },
            {
              "name": "Bucket Owner Full Control",
              "value": "bucketOwnerFullControl"
            },
            {
              "name": "Bucket Owner Read",
              "value": "bucketOwnerRead"
            },
            {
              "name": "Private",
              "value": "private"
            },
            {
              "name": "Public Read",
              "value": "publicRead"
            },
            {
              "name": "Public Read Write",
              "value": "publicReadWrite"
            }
          ],
          "default": "private",
          "description": "The canned ACL to apply to the object"
        },
        {
          "displayName": "Grant Full Control",
          "name": "grantFullControl",
          "type": "boolean",
          "default": false,
          "description": "Whether to give the grantee READ, READ_ACP, and WRITE_ACP permissions on the object"
        },
        {
          "displayName": "Grant Read",
          "name": "grantRead",
          "type": "boolean",
          "default": false,
          "description": "Whether to allow grantee to read the object data and its metadata"
        },
        {
          "displayName": "Grant Read ACP",
          "name": "grantReadAcp",
          "type": "boolean",
          "default": false,
          "description": "Whether to allow grantee to read the object ACL"
        },
        {
          "displayName": "Grant Write ACP",
          "name": "grantWriteAcp",
          "type": "boolean",
          "default": false,
          "description": "Whether to allow grantee to write the ACL for the applicable object"
        },
        {
          "displayName": "Lock Legal Hold",
          "name": "lockLegalHold",
          "type": "boolean",
          "default": false,
          "description": "Whether a legal hold will be applied to this object"
        },
        {
          "displayName": "Lock Mode",
          "name": "lockMode",
          "type": "options",
          "options": [
            {
              "name": "Governance",
              "value": "governance"
            },
            {
              "name": "Compliance",
              "value": "compliance"
            }
          ],
          "default": "",
          "description": "The Object Lock mode that you want to apply to this object"
        },
        {
          "displayName": "Lock Retain Until Date",
          "name": "lockRetainUntilDate",
          "type": "dateTime",
          "default": "",
          "description": "The date and time when you want this object's Object Lock to expire"
        },
        {
          "displayName": "Parent Folder Key",
          "name": "parentFolderKey",
          "type": "string",
          "default": "",
          "description": "Parent folder you want to create the file in"
        },
        {
          "displayName": "Requester Pays",
          "name": "requesterPays",
          "type": "boolean",
          "default": false,
          "description": "Whether the requester will pay for requests and data transfer. While Requester Pays is enabled, anonymous access to this bucket is disabled."
        },
        {
          "displayName": "Server Side Encryption",
          "name": "serverSideEncryption",
          "type": "options",
          "options": [
            {
              "name": "AES256",
              "value": "AES256"
            },
            {
              "name": "AWS:KMS",
              "value": "aws:kms"
            }
          ],
          "default": "",
          "description": "The server-side encryption algorithm used when storing this object in Amazon S3"
        },
        {
          "displayName": "Server Side Encryption Context",
          "name": "serverSideEncryptionContext",
          "type": "string",
          "default": "",
          "description": "Specifies the AWS KMS Encryption Context to use for object encryption"
        },
        {
          "displayName": "Server Side Encryption AWS KMS Key ID",
          "name": "encryptionAwsKmsKeyId",
          "type": "string",
          "default": "",
          "description": "If x-amz-server-side-encryption is present and has the value of aws:kms"
        },
        {
          "displayName": "Server Side Encryption Customer Algorithm",
          "name": "serversideEncryptionCustomerAlgorithm",
          "type": "string",
          "default": "",
          "description": "Specifies the algorithm to use to when encrypting the object (for example, AES256)"
        },
        {
          "displayName": "Server Side Encryption Customer Key",
          "name": "serversideEncryptionCustomerKey",
          "type": "string",
          "default": "",
          "description": "Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data"
        },
        {
          "displayName": "Server Side Encryption Customer Key MD5",
          "name": "serversideEncryptionCustomerKeyMD5",
          "type": "string",
          "default": "",
          "description": "Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321"
        },
        {
          "displayName": "Storage Class",
          "name": "storageClass",
          "type": "options",
          "options": [
            {
              "name": "Deep Archive",
              "value": "deepArchive"
            },
            {
              "name": "Glacier",
              "value": "glacier"
            },
            {
              "name": "Intelligent Tiering",
              "value": "intelligentTiering"
            },
            {
              "name": "One Zone IA",
              "value": "onezoneIA"
            },
            {
              "name": "Standard",
              "value": "standard"
            },
            {
              "name": "Standard IA",
              "value": "standardIA"
            }
          ],
          "default": "standard",
          "description": "Amazon S3 storage classes"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "file"
          ],
          "operation": [
            "upload"
          ]
        }
      }
    },
    {
      "displayName": "Tags",
      "name": "tagsUi",
      "type": "fixedCollection",
      "default": {},
      "description": "Optional extra headers to add to the message (most headers are allowed)",
      "options": [
        {
          "name": "tagsValues",
          "displayName": "Tag",
          "values": [
            {
              "displayName": "Key",
              "name": "key",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "Value",
              "name": "value",
              "type": "string",
              "default": ""
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "file"
          ],
          "operation": [
            "upload"
          ]
        }
      },
      "typeOptions": {
        "multipleValues": true
      }
    },
    {
      "displayName": "Bucket Name",
      "name": "bucketName",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "file"
          ],
          "operation": [
            "download"
          ]
        }
      }
    },
    {
      "displayName": "File Key",
      "name": "fileKey",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "file"
          ],
          "operation": [
            "download"
          ]
        }
      }
    },
    {
      "displayName": "Put Output File in Field",
      "name": "binaryPropertyName",
      "type": "string",
      "default": "data",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "download"
          ],
          "resource": [
            "file"
          ]
        }
      }
    },
    {
      "displayName": "Bucket Name",
      "name": "bucketName",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "file"
          ],
          "operation": [
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "File Key",
      "name": "fileKey",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "file"
          ],
          "operation": [
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Version ID",
          "name": "versionId",
          "type": "string",
          "default": ""
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "file"
          ],
          "operation": [
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "Bucket Name",
      "name": "bucketName",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "file"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Return All",
      "name": "returnAll",
      "type": "boolean",
      "default": false,
      "description": "Whether to return all results or only up to a given limit",
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "file"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 100,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "file"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 500
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Fetch Owner",
          "name": "fetchOwner",
          "type": "boolean",
          "default": false,
          "description": "The owner field is not present in listV2 by default, if you want to return owner field with each key in the result then set the fetch owner field to true"
        },
        {
          "displayName": "Folder Key",
          "name": "folderKey",
          "type": "string",
          "default": ""
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "file"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    }
  ]

operations:
  [
    {
      "operation": "create",
      "name": "Create",
      "description": "Create a bucket",
      "resource": "bucket"
    },
    {
      "operation": "delete",
      "name": "Delete",
      "description": "Delete a bucket",
      "resource": "bucket"
    },
    {
      "operation": "getAll",
      "name": "Get Many",
      "description": "Get many buckets",
      "resource": "bucket"
    },
    {
      "operation": "search",
      "name": "Search",
      "description": "Search within a bucket",
      "resource": "bucket"
    },
    {
      "operation": "create",
      "name": "Create",
      "description": "Create a folder",
      "resource": "folder"
    },
    {
      "operation": "delete",
      "name": "Delete",
      "description": "Delete a folder",
      "resource": "folder"
    },
    {
      "operation": "getAll",
      "name": "Get Many",
      "description": "Get many folders",
      "resource": "folder"
    },
    {
      "operation": "copy",
      "name": "Copy",
      "description": "Copy a file",
      "resource": "file"
    },
    {
      "operation": "delete",
      "name": "Delete",
      "description": "Delete a file",
      "resource": "file"
    },
    {
      "operation": "download",
      "name": "Download",
      "description": "Download a file",
      "resource": "file"
    },
    {
      "operation": "getAll",
      "name": "Get Many",
      "description": "Get many files",
      "resource": "file"
    },
    {
      "operation": "upload",
      "name": "Upload",
      "description": "Upload a file",
      "resource": "file"
    }
  ]


