# nodes

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

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

  # BambooHR node

  Use the BambooHR node to automate work in BambooHR, and integrate BambooHR with other applications. n8n has built-in support for a wide range of BambooHR features, including creating, deleting, downloading, and getting company reports, employee documents, and files.

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

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

  ## Operations

  * Company Report
      * Get a company report
  * Employee
      * Create an employee
      * Get an employee
      * Get all employees
      * Update an employee
  * Employee Document
      * Delete an employee document
      * Download an employee document
      * Get all employee document
      * Update an employee document
      * Upload an employee document
  * File
      * Delete a company file
      * Download a company file
      * Get all company files
      * Update a company file
      * Upload a company file

  ## Templates and examples

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

properties_schema:
  [
    {
      "displayName": "Resource",
      "name": "resource",
      "type": "options",
      "default": "employee",
      "options": [
        {
          "name": "Company Report",
          "value": "companyReport"
        },
        {
          "name": "Employee",
          "value": "employee"
        },
        {
          "name": "Employee Document",
          "value": "employeeDocument"
        },
        {
          "name": "File",
          "value": "file"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create an employee",
          "action": "Create an employee"
        },
        {
          "name": "Get",
          "value": "get",
          "description": "Get an employee",
          "action": "Get an employee"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get many employees",
          "action": "Get many employees"
        },
        {
          "name": "Update",
          "value": "update",
          "description": "Update an employee",
          "action": "Update an employee"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "employee"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Synced with Trax Payroll",
      "name": "synced",
      "type": "boolean",
      "default": false,
      "description": "Whether the employee to create was added to a pay schedule synced with Trax Payroll",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "create"
          ],
          "resource": [
            "employee"
          ]
        }
      }
    },
    {
      "displayName": "First Name",
      "name": "firstName",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "create"
          ],
          "resource": [
            "employee"
          ]
        }
      }
    },
    {
      "displayName": "Last Name",
      "name": "lastName",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "create"
          ],
          "resource": [
            "employee"
          ]
        }
      }
    },
    {
      "displayName": "Address",
      "name": "address",
      "type": "fixedCollection",
      "default": {},
      "options": [
        {
          "name": "value",
          "displayName": "Address",
          "values": [
            {
              "displayName": "Line 1",
              "name": "address1",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "Line 2",
              "name": "address2",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "City",
              "name": "city",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "State",
              "name": "state",
              "type": "string",
              "default": "",
              "placeholder": "Florida",
              "description": "The full name of the state/province"
            },
            {
              "displayName": "Country",
              "name": "country",
              "type": "string",
              "default": "",
              "placeholder": "United States",
              "description": "The name of the country. Must exist in the BambooHr country list."
            }
          ]
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "employee"
          ],
          "operation": [
            "create"
          ],
          "synced": [
            true
          ]
        }
      },
      "typeOptions": {
        "multipleValues": false
      }
    },
    {
      "displayName": "Date of Birth",
      "name": "dateOfBirth",
      "type": "dateTime",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "employee"
          ],
          "operation": [
            "create"
          ],
          "synced": [
            true
          ]
        }
      }
    },
    {
      "displayName": "Department Name or ID",
      "name": "department",
      "type": "options",
      "default": "",
      "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "employee"
          ],
          "operation": [
            "create"
          ],
          "synced": [
            true
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getDepartments"
      }
    },
    {
      "displayName": "Division Name or ID",
      "name": "division",
      "type": "options",
      "default": "",
      "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "employee"
          ],
          "operation": [
            "create"
          ],
          "synced": [
            true
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getDivisions"
      }
    },
    {
      "displayName": "Employee Number",
      "name": "employeeNumber",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "employee"
          ],
          "operation": [
            "create"
          ],
          "synced": [
            true
          ]
        }
      }
    },
    {
      "displayName": "FLSA Overtime Status",
      "name": "exempt",
      "type": "options",
      "default": "",
      "options": [
        {
          "name": "Exempt",
          "value": "exempt"
        },
        {
          "name": "Non-Exempt",
          "value": "non-exempt"
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "employee"
          ],
          "operation": [
            "create"
          ],
          "synced": [
            true
          ]
        }
      }
    },
    {
      "displayName": "Gender",
      "name": "gender",
      "type": "options",
      "default": "",
      "options": [
        {
          "name": "Female",
          "value": "female"
        },
        {
          "name": "Male",
          "value": "male"
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "employee"
          ],
          "operation": [
            "create"
          ],
          "synced": [
            true
          ]
        }
      }
    },
    {
      "displayName": "Hire Date",
      "name": "hireDate",
      "type": "dateTime",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "employee"
          ],
          "operation": [
            "create"
          ],
          "synced": [
            true
          ]
        }
      }
    },
    {
      "displayName": "Location Name or ID",
      "name": "location",
      "type": "options",
      "default": "",
      "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "employee"
          ],
          "operation": [
            "create"
          ],
          "synced": [
            true
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getEmployeeLocations"
      }
    },
    {
      "displayName": "Marital Status",
      "name": "maritalStatus",
      "type": "options",
      "default": "",
      "options": [
        {
          "name": "Single",
          "value": "single"
        },
        {
          "name": "Married",
          "value": "married"
        },
        {
          "name": "Domestic Partnership",
          "value": "domesticPartnership"
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "employee"
          ],
          "operation": [
            "create"
          ],
          "synced": [
            true
          ]
        }
      }
    },
    {
      "displayName": "Mobile Phone",
      "name": "mobilePhone",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "employee"
          ],
          "operation": [
            "create"
          ],
          "synced": [
            true
          ]
        }
      }
    },
    {
      "displayName": "Pay Per",
      "name": "paidPer",
      "type": "options",
      "default": "",
      "options": [
        {
          "name": "Hour",
          "value": "hour"
        },
        {
          "name": "Day",
          "value": "day"
        },
        {
          "name": "Week",
          "value": "week"
        },
        {
          "name": "Month",
          "value": "month"
        },
        {
          "name": "Quater",
          "value": "quater"
        },
        {
          "name": "Year",
          "value": "year"
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "employee"
          ],
          "operation": [
            "create"
          ],
          "synced": [
            true
          ]
        }
      }
    },
    {
      "displayName": "Pay Rate",
      "name": "payRate",
      "type": "fixedCollection",
      "default": {},
      "options": [
        {
          "name": "value",
          "displayName": "Pay Rate",
          "values": [
            {
              "displayName": "Value",
              "name": "value",
              "type": "string",
              "default": "",
              "placeholder": "20.00"
            },
            {
              "displayName": "Currency",
              "name": "currency",
              "type": "string",
              "default": "",
              "placeholder": "USD"
            }
          ]
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "employee"
          ],
          "operation": [
            "create"
          ],
          "synced": [
            true
          ]
        }
      },
      "typeOptions": {
        "multipleValues": false
      }
    },
    {
      "displayName": "Pay Type",
      "name": "payType",
      "type": "options",
      "default": "",
      "options": [
        {
          "name": "Commission",
          "value": "commission"
        },
        {
          "name": "Contract",
          "value": "contract"
        },
        {
          "name": "Daily",
          "value": "daily"
        },
        {
          "name": "Exception Hourly",
          "value": "exceptionHourly"
        },
        {
          "name": "Hourly",
          "value": "hourly"
        },
        {
          "name": "Monthly",
          "value": "monthly"
        },
        {
          "name": "Piece Rate",
          "value": "pieceRate"
        },
        {
          "name": "Pro Rata",
          "value": "proRata"
        },
        {
          "name": "Salary",
          "value": "salary"
        },
        {
          "name": "Weekly",
          "value": "weekly"
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "employee"
          ],
          "operation": [
            "create"
          ],
          "synced": [
            true
          ]
        }
      }
    },
    {
      "displayName": "Preferred Name",
      "name": "preferredName",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "employee"
          ],
          "operation": [
            "create"
          ],
          "synced": [
            true
          ]
        }
      }
    },
    {
      "displayName": "Social Security Number",
      "name": "ssn",
      "type": "string",
      "default": "",
      "description": "A standard United States Social Security number, with dashes",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "employee"
          ],
          "operation": [
            "create"
          ],
          "synced": [
            true
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Address",
          "name": "address",
          "placeholder": "Address",
          "type": "fixedCollection",
          "typeOptions": {
            "multipleValues": false
          },
          "default": {},
          "options": [
            {
              "name": "value",
              "displayName": "Address",
              "values": [
                {
                  "displayName": "Line 1",
                  "name": "address1",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Line 2",
                  "name": "address2",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "City",
                  "name": "city",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "State",
                  "name": "state",
                  "type": "string",
                  "default": "",
                  "placeholder": "Florida",
                  "description": "The full name of the state/province"
                },
                {
                  "displayName": "Country",
                  "name": "country",
                  "type": "string",
                  "default": "",
                  "placeholder": "United States",
                  "description": "The name of the country. Must exist in the BambooHr country list."
                }
              ]
            }
          ],
          "displayOptions": {
            "show": {
              "/synced": [
                false
              ]
            }
          }
        },
        {
          "displayName": "Date of Birth",
          "name": "dateOfBirth",
          "type": "dateTime",
          "default": "",
          "displayOptions": {
            "show": {
              "/synced": [
                false
              ]
            }
          }
        },
        {
          "displayName": "Department Name or ID",
          "name": "department",
          "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": "getDepartments"
          },
          "default": "",
          "displayOptions": {
            "show": {
              "/synced": [
                false
              ]
            }
          }
        },
        {
          "displayName": "Division Name or ID",
          "name": "division",
          "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": "getDivisions"
          },
          "default": "",
          "displayOptions": {
            "show": {
              "/synced": [
                false
              ]
            }
          }
        },
        {
          "displayName": "Employee Number",
          "name": "employeeNumber",
          "type": "string",
          "default": "",
          "displayOptions": {
            "show": {
              "/synced": [
                false
              ]
            }
          }
        },
        {
          "displayName": "FLSA Overtime Status",
          "name": "exempt",
          "type": "options",
          "options": [
            {
              "name": "Exempt",
              "value": "exempt"
            },
            {
              "name": "Non-Exempt",
              "value": "non-exempt"
            }
          ],
          "default": "",
          "displayOptions": {
            "show": {
              "/synced": [
                false
              ]
            }
          }
        },
        {
          "displayName": "Gender",
          "name": "gender",
          "type": "options",
          "options": [
            {
              "name": "Female",
              "value": "female"
            },
            {
              "name": "Male",
              "value": "male"
            }
          ],
          "default": "",
          "displayOptions": {
            "show": {
              "/synced": [
                false
              ]
            }
          }
        },
        {
          "displayName": "Hire Date",
          "name": "hireDate",
          "type": "dateTime",
          "default": "",
          "displayOptions": {
            "show": {
              "/synced": [
                false
              ]
            }
          }
        },
        {
          "displayName": "Location Name or ID",
          "name": "location",
          "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": "getEmployeeLocations"
          },
          "default": "",
          "displayOptions": {
            "show": {
              "/synced": [
                false
              ]
            }
          }
        },
        {
          "displayName": "Marital Status",
          "name": "maritalStatus",
          "type": "options",
          "options": [
            {
              "name": "Single",
              "value": "single"
            },
            {
              "name": "Married",
              "value": "married"
            },
            {
              "name": "Domestic Partnership",
              "value": "domesticPartnership"
            }
          ],
          "default": "",
          "displayOptions": {
            "show": {
              "/synced": [
                false
              ]
            }
          }
        },
        {
          "displayName": "Mobile Phone",
          "name": "mobilePhone",
          "type": "string",
          "default": "",
          "displayOptions": {
            "show": {
              "/synced": [
                false
              ]
            }
          }
        },
        {
          "displayName": "Pay Per",
          "name": "paidPer",
          "type": "options",
          "options": [
            {
              "name": "Hour",
              "value": "hour"
            },
            {
              "name": "Day",
              "value": "day"
            },
            {
              "name": "Week",
              "value": "week"
            },
            {
              "name": "Month",
              "value": "month"
            },
            {
              "name": "Quater",
              "value": "quater"
            },
            {
              "name": "Year",
              "value": "year"
            }
          ],
          "default": "",
          "displayOptions": {
            "show": {
              "/synced": [
                false
              ]
            }
          }
        },
        {
          "displayName": "Pay Rate",
          "name": "payRate",
          "placeholder": "Add Pay Rate",
          "type": "fixedCollection",
          "typeOptions": {
            "multipleValues": false
          },
          "default": {},
          "options": [
            {
              "name": "value",
              "displayName": "Pay Rate",
              "values": [
                {
                  "displayName": "Value",
                  "name": "value",
                  "type": "string",
                  "default": "",
                  "placeholder": "20.00"
                },
                {
                  "displayName": "Currency",
                  "name": "currency",
                  "type": "string",
                  "default": "",
                  "placeholder": "USD"
                }
              ]
            }
          ],
          "displayOptions": {
            "show": {
              "/synced": [
                false
              ]
            }
          }
        },
        {
          "displayName": "Pay Type",
          "name": "payType",
          "type": "options",
          "options": [
            {
              "name": "Commission",
              "value": "commission"
            },
            {
              "name": "Contract",
              "value": "contract"
            },
            {
              "name": "Daily",
              "value": "daily"
            },
            {
              "name": "Exception Hourly",
              "value": "exceptionHourly"
            },
            {
              "name": "Hourly",
              "value": "hourly"
            },
            {
              "name": "Monthly",
              "value": "monthly"
            },
            {
              "name": "Piece Rate",
              "value": "pieceRate"
            },
            {
              "name": "Pro Rata",
              "value": "proRata"
            },
            {
              "name": "Salary",
              "value": "salary"
            },
            {
              "name": "Weekly",
              "value": "weekly"
            }
          ],
          "default": "",
          "displayOptions": {
            "show": {
              "/synced": [
                false
              ]
            }
          }
        },
        {
          "displayName": "Preferred Name",
          "name": "preferredName",
          "type": "string",
          "default": "",
          "displayOptions": {
            "show": {
              "/synced": [
                false
              ]
            }
          }
        },
        {
          "displayName": "Social Security Number",
          "name": "ssn",
          "type": "string",
          "default": "",
          "placeholder": "123-45-6789",
          "description": "A standard United States Social Security number, with dashes",
          "displayOptions": {
            "show": {
              "/synced": [
                false
              ]
            }
          }
        },
        {
          "displayName": "Work Email",
          "name": "workEmail",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Work Phone",
          "name": "workPhone",
          "type": "string",
          "default": ""
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "create"
          ],
          "resource": [
            "employee"
          ]
        }
      }
    },
    {
      "displayName": "Employee ID",
      "name": "employeeId",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "get"
          ],
          "resource": [
            "employee"
          ]
        }
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Field Names or IDs",
          "name": "fields",
          "type": "multiOptions",
          "typeOptions": {
            "loadOptionsMethod": "getEmployeeFields"
          },
          "default": [
            "all"
          ],
          "description": "Set of fields to get from employee data. Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "get"
          ],
          "resource": [
            "employee"
          ]
        }
      }
    },
    {
      "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": 5,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "employee"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 1000
      }
    },
    {
      "displayName": "Employee ID",
      "name": "employeeId",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "update"
          ],
          "resource": [
            "employee"
          ]
        }
      }
    },
    {
      "displayName": "Synced with Trax Payroll",
      "name": "synced",
      "type": "boolean",
      "default": false,
      "description": "Whether the employee to create was added to a pay schedule synced with Trax Payroll",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "update"
          ],
          "resource": [
            "employee"
          ]
        }
      }
    },
    {
      "displayName": "Address",
      "name": "addasasress",
      "type": "fixedCollection",
      "default": {},
      "options": [
        {
          "name": "value",
          "displayName": "Address",
          "values": [
            {
              "displayName": "Line 1",
              "name": "address1",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "Line 2",
              "name": "address2",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "City",
              "name": "city",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "State",
              "name": "state",
              "type": "string",
              "default": "",
              "placeholder": "Florida",
              "description": "The full name of the state/province"
            },
            {
              "displayName": "Country",
              "name": "country",
              "type": "string",
              "default": "",
              "placeholder": "United States",
              "description": "The name of the country. Must exist in the BambooHr country list."
            }
          ]
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "employee"
          ],
          "operation": [
            "update"
          ],
          "synced": [
            true
          ]
        }
      },
      "typeOptions": {
        "multipleValues": false
      }
    },
    {
      "displayName": "Date of Birth",
      "name": "dateOfBirth",
      "type": "dateTime",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "employee"
          ],
          "operation": [
            "update"
          ],
          "synced": [
            true
          ]
        }
      }
    },
    {
      "displayName": "Department Name or ID",
      "name": "department",
      "type": "options",
      "default": "",
      "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "employee"
          ],
          "operation": [
            "update"
          ],
          "synced": [
            true
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getDepartments"
      }
    },
    {
      "displayName": "Division Name or ID",
      "name": "division",
      "type": "options",
      "default": "",
      "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "employee"
          ],
          "operation": [
            "update"
          ],
          "synced": [
            true
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getDivisions"
      }
    },
    {
      "displayName": "Employee Number",
      "name": "employeeNumber",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "employee"
          ],
          "operation": [
            "update"
          ],
          "synced": [
            true
          ]
        }
      }
    },
    {
      "displayName": "First Name",
      "name": "firstName",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "employee"
          ],
          "operation": [
            "update"
          ],
          "synced": [
            true
          ]
        }
      }
    },
    {
      "displayName": "Last Name",
      "name": "lastName",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "employee"
          ],
          "operation": [
            "update"
          ],
          "synced": [
            true
          ]
        }
      }
    },
    {
      "displayName": "FLSA Overtime Status",
      "name": "exempt",
      "type": "options",
      "default": "",
      "options": [
        {
          "name": "Exempt",
          "value": "exempt"
        },
        {
          "name": "Non-Exempt",
          "value": "non-exempt"
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "employee"
          ],
          "operation": [
            "update"
          ],
          "synced": [
            true
          ]
        }
      }
    },
    {
      "displayName": "Gender",
      "name": "gender",
      "type": "options",
      "default": "",
      "options": [
        {
          "name": "Female",
          "value": "female"
        },
        {
          "name": "Male",
          "value": "male"
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "employee"
          ],
          "operation": [
            "update"
          ],
          "synced": [
            true
          ]
        }
      }
    },
    {
      "displayName": "Hire Date",
      "name": "hireDate",
      "type": "dateTime",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "employee"
          ],
          "operation": [
            "update"
          ],
          "synced": [
            true
          ]
        }
      }
    },
    {
      "displayName": "Location Name or ID",
      "name": "location",
      "type": "options",
      "default": "",
      "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "employee"
          ],
          "operation": [
            "update"
          ],
          "synced": [
            true
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getEmployeeLocations"
      }
    },
    {
      "displayName": "Marital Status",
      "name": "maritalStatus",
      "type": "options",
      "default": "",
      "options": [
        {
          "name": "Single",
          "value": "single"
        },
        {
          "name": "Married",
          "value": "married"
        },
        {
          "name": "Domestic Partnership",
          "value": "domesticPartnership"
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "employee"
          ],
          "operation": [
            "update"
          ],
          "synced": [
            true
          ]
        }
      }
    },
    {
      "displayName": "Mobile Phone",
      "name": "mobilePhone",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "employee"
          ],
          "operation": [
            "update"
          ],
          "synced": [
            true
          ]
        }
      }
    },
    {
      "displayName": "Pay Per",
      "name": "paidPer",
      "type": "options",
      "default": "",
      "options": [
        {
          "name": "Hour",
          "value": "hour"
        },
        {
          "name": "Day",
          "value": "day"
        },
        {
          "name": "Week",
          "value": "week"
        },
        {
          "name": "Month",
          "value": "month"
        },
        {
          "name": "Quater",
          "value": "quater"
        },
        {
          "name": "Year",
          "value": "year"
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "employee"
          ],
          "operation": [
            "update"
          ],
          "synced": [
            true
          ]
        }
      }
    },
    {
      "displayName": "Pay Rate",
      "name": "payRate",
      "type": "fixedCollection",
      "default": {},
      "options": [
        {
          "name": "value",
          "displayName": "Pay Rate",
          "values": [
            {
              "displayName": "Value",
              "name": "value",
              "type": "string",
              "default": "",
              "placeholder": "20.00"
            },
            {
              "displayName": "Currency",
              "name": "currency",
              "type": "string",
              "default": "",
              "placeholder": "USD"
            }
          ]
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "employee"
          ],
          "operation": [
            "update"
          ],
          "synced": [
            true
          ]
        }
      },
      "typeOptions": {
        "multipleValues": false
      }
    },
    {
      "displayName": "Pay Type",
      "name": "payType",
      "type": "options",
      "default": "",
      "options": [
        {
          "name": "Commission",
          "value": "commission"
        },
        {
          "name": "Contract",
          "value": "contract"
        },
        {
          "name": "Daily",
          "value": "daily"
        },
        {
          "name": "Exception Hourly",
          "value": "exceptionHourly"
        },
        {
          "name": "Hourly",
          "value": "hourly"
        },
        {
          "name": "Monthly",
          "value": "monthly"
        },
        {
          "name": "Piece Rate",
          "value": "pieceRate"
        },
        {
          "name": "Pro Rata",
          "value": "proRata"
        },
        {
          "name": "Salary",
          "value": "salary"
        },
        {
          "name": "Weekly",
          "value": "weekly"
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "employee"
          ],
          "operation": [
            "update"
          ],
          "synced": [
            true
          ]
        }
      }
    },
    {
      "displayName": "Preferred Name",
      "name": "preferredName",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "employee"
          ],
          "operation": [
            "update"
          ],
          "synced": [
            true
          ]
        }
      }
    },
    {
      "displayName": "Social Security Number",
      "name": "ssn",
      "type": "string",
      "default": "",
      "description": "A standard United States Social Security number, with dashes",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "employee"
          ],
          "operation": [
            "update"
          ],
          "synced": [
            true
          ]
        }
      }
    },
    {
      "displayName": "Update Fields",
      "name": "updateFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Address",
          "name": "addasasress",
          "placeholder": "Address",
          "type": "fixedCollection",
          "typeOptions": {
            "multipleValues": false
          },
          "default": {},
          "options": [
            {
              "name": "value",
              "displayName": "Address",
              "values": [
                {
                  "displayName": "Line 1",
                  "name": "address1",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Line 2",
                  "name": "address2",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "City",
                  "name": "city",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "State",
                  "name": "state",
                  "type": "string",
                  "default": "",
                  "placeholder": "Florida",
                  "description": "The full name of the state/province"
                },
                {
                  "displayName": "Country",
                  "name": "country",
                  "type": "string",
                  "default": "",
                  "placeholder": "United States",
                  "description": "The name of the country. Must exist in the BambooHr country list."
                }
              ]
            }
          ],
          "displayOptions": {
            "show": {
              "/synced": [
                false
              ]
            }
          }
        },
        {
          "displayName": "Date of Birth",
          "name": "dateOfBirth",
          "type": "dateTime",
          "default": "",
          "displayOptions": {
            "show": {
              "/synced": [
                false
              ]
            }
          }
        },
        {
          "displayName": "Department Name or ID",
          "name": "department",
          "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": "getDepartments"
          },
          "default": "",
          "displayOptions": {
            "show": {
              "/synced": [
                false
              ]
            }
          }
        },
        {
          "displayName": "Division Name or ID",
          "name": "division",
          "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": "getDivisions"
          },
          "default": "",
          "displayOptions": {
            "show": {
              "/synced": [
                false
              ]
            }
          }
        },
        {
          "displayName": "Employee Number",
          "name": "employeeNumber",
          "type": "string",
          "default": "",
          "displayOptions": {
            "show": {
              "/synced": [
                false
              ]
            }
          }
        },
        {
          "displayName": "First Name",
          "name": "firstName",
          "type": "string",
          "displayOptions": {
            "show": {
              "/synced": [
                false
              ]
            }
          },
          "default": ""
        },
        {
          "displayName": "Last Name",
          "name": "lastName",
          "type": "string",
          "displayOptions": {
            "show": {
              "/synced": [
                false
              ]
            }
          },
          "default": ""
        },
        {
          "displayName": "FLSA Overtime Status",
          "name": "exempt",
          "type": "options",
          "options": [
            {
              "name": "Exempt",
              "value": "exempt"
            },
            {
              "name": "Non-Exempt",
              "value": "non-exempt"
            }
          ],
          "default": "",
          "displayOptions": {
            "show": {
              "/synced": [
                false
              ]
            }
          }
        },
        {
          "displayName": "Gender",
          "name": "gender",
          "type": "options",
          "options": [
            {
              "name": "Female",
              "value": "female"
            },
            {
              "name": "Male",
              "value": "male"
            }
          ],
          "default": "",
          "displayOptions": {
            "show": {
              "/synced": [
                false
              ]
            }
          }
        },
        {
          "displayName": "Hire Date",
          "name": "hireDate",
          "type": "dateTime",
          "default": "",
          "displayOptions": {
            "show": {
              "/synced": [
                false
              ]
            }
          }
        },
        {
          "displayName": "Location Name or ID",
          "name": "location",
          "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": "getEmployeeLocations"
          },
          "default": "",
          "displayOptions": {
            "show": {
              "/synced": [
                false
              ]
            }
          }
        },
        {
          "displayName": "Marital Status",
          "name": "maritalStatus",
          "type": "options",
          "options": [
            {
              "name": "Single",
              "value": "single"
            },
            {
              "name": "Married",
              "value": "married"
            },
            {
              "name": "Domestic Partnership",
              "value": "domesticPartnership"
            }
          ],
          "default": "",
          "displayOptions": {
            "show": {
              "/synced": [
                false
              ]
            }
          }
        },
        {
          "displayName": "Mobile Phone",
          "name": "mobilePhone",
          "type": "string",
          "default": "",
          "displayOptions": {
            "show": {
              "/synced": [
                false
              ]
            }
          }
        },
        {
          "displayName": "Pay Per",
          "name": "paidPer",
          "type": "options",
          "options": [
            {
              "name": "Hour",
              "value": "hour"
            },
            {
              "name": "Day",
              "value": "day"
            },
            {
              "name": "Week",
              "value": "week"
            },
            {
              "name": "Month",
              "value": "month"
            },
            {
              "name": "Quater",
              "value": "quater"
            },
            {
              "name": "Year",
              "value": "year"
            }
          ],
          "default": "",
          "displayOptions": {
            "show": {
              "/synced": [
                false
              ]
            }
          }
        },
        {
          "displayName": "Pay Rate",
          "name": "payRate",
          "placeholder": "Add Pay Rate",
          "type": "fixedCollection",
          "typeOptions": {
            "multipleValues": false
          },
          "default": {},
          "options": [
            {
              "name": "value",
              "displayName": "Pay Rate",
              "values": [
                {
                  "displayName": "Value",
                  "name": "value",
                  "type": "string",
                  "default": "",
                  "placeholder": "20.00"
                },
                {
                  "displayName": "Currency",
                  "name": "currency",
                  "type": "string",
                  "default": "",
                  "placeholder": "USD"
                }
              ]
            }
          ],
          "displayOptions": {
            "show": {
              "/synced": [
                false
              ]
            }
          }
        },
        {
          "displayName": "Pay Type",
          "name": "payType",
          "type": "options",
          "options": [
            {
              "name": "Commission",
              "value": "commission"
            },
            {
              "name": "Contract",
              "value": "contract"
            },
            {
              "name": "Daily",
              "value": "daily"
            },
            {
              "name": "Exception Hourly",
              "value": "exceptionHourly"
            },
            {
              "name": "Hourly",
              "value": "hourly"
            },
            {
              "name": "Monthly",
              "value": "monthly"
            },
            {
              "name": "Piece Rate",
              "value": "pieceRate"
            },
            {
              "name": "Pro Rata",
              "value": "proRata"
            },
            {
              "name": "Salary",
              "value": "salary"
            },
            {
              "name": "Weekly",
              "value": "weekly"
            }
          ],
          "default": "",
          "displayOptions": {
            "show": {
              "/synced": [
                false
              ]
            }
          }
        },
        {
          "displayName": "Preferred Name",
          "name": "preferredName",
          "type": "string",
          "default": "",
          "displayOptions": {
            "show": {
              "/synced": [
                false
              ]
            }
          }
        },
        {
          "displayName": "Social Security Number",
          "name": "ssn",
          "type": "string",
          "default": "",
          "placeholder": "123-45-6789",
          "description": "A standard United States Social Security number, with dashes",
          "displayOptions": {
            "show": {
              "/synced": [
                false
              ]
            }
          }
        },
        {
          "displayName": "Work Email",
          "name": "workEmail",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Work Phone",
          "name": "workPhone",
          "type": "string",
          "default": ""
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "update"
          ],
          "resource": [
            "employee"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "delete",
      "options": [
        {
          "name": "Delete",
          "value": "delete",
          "description": "Delete an employee document",
          "action": "Delete an employee document"
        },
        {
          "name": "Download",
          "value": "download",
          "description": "Download an employee document",
          "action": "Download an employee document"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get many employee documents",
          "action": "Get many employee documents"
        },
        {
          "name": "Update",
          "value": "update",
          "description": "Update an employee document",
          "action": "Update an employee document"
        },
        {
          "name": "Upload",
          "value": "upload",
          "description": "Upload an employee document",
          "action": "Upload an employee document"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "employeeDocument"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Employee ID",
      "name": "employeeId",
      "type": "string",
      "default": "",
      "description": "ID of the employee",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "delete"
          ],
          "resource": [
            "employeeDocument"
          ]
        }
      }
    },
    {
      "displayName": "File ID",
      "name": "fileId",
      "type": "string",
      "default": "",
      "description": "ID of the employee file",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "delete"
          ],
          "resource": [
            "employeeDocument"
          ]
        }
      }
    },
    {
      "displayName": "Employee ID",
      "name": "employeeId",
      "type": "string",
      "default": "",
      "description": "ID of the employee",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "download"
          ],
          "resource": [
            "employeeDocument"
          ]
        }
      }
    },
    {
      "displayName": "File ID",
      "name": "fileId",
      "type": "string",
      "default": "",
      "description": "ID of the employee file",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "download"
          ],
          "resource": [
            "employeeDocument"
          ]
        }
      }
    },
    {
      "displayName": "Put Output In Field",
      "name": "output",
      "type": "string",
      "default": "data",
      "description": "The name of the output field to put the binary file data in",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "download"
          ],
          "resource": [
            "employeeDocument"
          ]
        }
      }
    },
    {
      "displayName": "Employee ID",
      "name": "employeeId",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "employeeDocument"
          ]
        }
      }
    },
    {
      "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": [
            "employeeDocument"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 5,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "employeeDocument"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 1000
      }
    },
    {
      "displayName": "Simplify",
      "name": "simplifyOutput",
      "type": "boolean",
      "default": true,
      "description": "Whether to return a simplified version of the response instead of the raw data",
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "employeeDocument"
          ]
        }
      }
    },
    {
      "displayName": "Employee ID",
      "name": "employeeId",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "update"
          ],
          "resource": [
            "employeeDocument"
          ]
        }
      }
    },
    {
      "displayName": "File ID",
      "name": "fileId",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "update"
          ],
          "resource": [
            "employeeDocument"
          ]
        }
      }
    },
    {
      "displayName": "Update Fields",
      "name": "updateFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Employee Document Category Name or ID",
          "name": "categoryId",
          "type": "options",
          "typeOptions": {
            "loadOptionsMethod": "getEmployeeDocumentCategories",
            "loadOptionsDependsOn": [
              "employeeId"
            ]
          },
          "default": "",
          "description": "ID of the new category of the file. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        },
        {
          "displayName": "Name",
          "name": "name",
          "type": "string",
          "default": "",
          "description": "New name of the file"
        },
        {
          "displayName": "Share with Employee",
          "name": "shareWithEmployee",
          "type": "boolean",
          "default": true,
          "description": "Whether this file is shared or not"
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "update"
          ],
          "resource": [
            "employeeDocument"
          ]
        }
      }
    },
    {
      "displayName": "Employee ID",
      "name": "employeeId",
      "type": "string",
      "default": "",
      "description": "ID of the employee",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "upload"
          ],
          "resource": [
            "employeeDocument"
          ]
        }
      }
    },
    {
      "displayName": "Employee Document Category ID",
      "name": "categoryId",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "upload"
          ],
          "resource": [
            "employeeDocument"
          ]
        }
      }
    },
    {
      "displayName": "Input Data Field Name",
      "name": "binaryPropertyName",
      "type": "string",
      "default": "data",
      "description": "The name of the input field containing the binary file data to be uploaded. Supported file types: PNG, JPEG.",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "upload"
          ],
          "resource": [
            "employeeDocument"
          ]
        }
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Share with Employee",
          "name": "share",
          "type": "boolean",
          "default": true,
          "description": "Whether this file is shared or not"
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "upload"
          ],
          "resource": [
            "employeeDocument"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "delete",
      "options": [
        {
          "name": "Delete",
          "value": "delete",
          "description": "Delete a company file",
          "action": "Delete a file"
        },
        {
          "name": "Download",
          "value": "download",
          "description": "Download a company file",
          "action": "Download a file"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get many company files",
          "action": "Get many files"
        },
        {
          "name": "Update",
          "value": "update",
          "description": "Update a company file",
          "action": "Update a file"
        },
        {
          "name": "Upload",
          "value": "upload",
          "description": "Upload a company file",
          "action": "Upload a file"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "file"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "File ID",
      "name": "fileId",
      "type": "string",
      "default": "",
      "description": "ID of the file",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "delete"
          ],
          "resource": [
            "file"
          ]
        }
      }
    },
    {
      "displayName": "File ID",
      "name": "fileId",
      "type": "string",
      "default": "",
      "description": "ID of the file",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "download"
          ],
          "resource": [
            "file"
          ]
        }
      }
    },
    {
      "displayName": "Put Output In Field",
      "name": "output",
      "type": "string",
      "default": "data",
      "description": "The name of the output field to put the binary file data in",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "download"
          ],
          "resource": [
            "file"
          ]
        }
      }
    },
    {
      "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": 5,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "file"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 1000
      }
    },
    {
      "displayName": "Simplify",
      "name": "simplifyOutput",
      "type": "boolean",
      "default": true,
      "description": "Whether to return a simplified version of the response instead of the raw data",
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "file"
          ]
        }
      }
    },
    {
      "displayName": "File ID",
      "name": "fileId",
      "type": "string",
      "default": "",
      "description": "ID of the file",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "update"
          ],
          "resource": [
            "file"
          ]
        }
      }
    },
    {
      "displayName": "Update Fields",
      "name": "updateFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Category Name or ID",
          "name": "categoryId",
          "type": "options",
          "typeOptions": {
            "loadOptionsMethod": "getCompanyFileCategories"
          },
          "default": "",
          "description": "Move the file to a different category. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        },
        {
          "displayName": "Name",
          "name": "name",
          "type": "string",
          "default": "",
          "description": "New name of the file"
        },
        {
          "displayName": "Share with Employee",
          "name": "shareWithEmployee",
          "type": "boolean",
          "default": true,
          "description": "Whether this file is shared or not"
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "update"
          ],
          "resource": [
            "file"
          ]
        }
      }
    },
    {
      "displayName": "Input Data Field Name",
      "name": "binaryPropertyName",
      "type": "string",
      "default": "data",
      "description": "The name of the input field containing the binary file data to be uploaded. Supported file types: PNG, JPEG.",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "upload"
          ],
          "resource": [
            "file"
          ]
        }
      }
    },
    {
      "displayName": "Category Name or ID",
      "name": "categoryId",
      "type": "options",
      "default": "",
      "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "upload"
          ],
          "resource": [
            "file"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getCompanyFileCategories"
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Share with Employee",
          "name": "share",
          "type": "boolean",
          "default": true,
          "description": "Whether this file is shared or not"
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "upload"
          ],
          "resource": [
            "file"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "get",
      "options": [
        {
          "name": "Get",
          "value": "get",
          "description": "Get a company report",
          "action": "Get a company report"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "companyReport"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Report ID",
      "name": "reportId",
      "type": "string",
      "default": "",
      "description": "ID of the report. You can get the report number by hovering over the report name on the reports page and grabbing the ID.",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "get"
          ],
          "resource": [
            "companyReport"
          ]
        }
      }
    },
    {
      "displayName": "Format",
      "name": "format",
      "type": "options",
      "default": "JSON",
      "description": "The output format for the report",
      "options": [
        {
          "name": "CSV",
          "value": "CSV"
        },
        {
          "name": "JSON",
          "value": "JSON"
        },
        {
          "name": "PDF",
          "value": "PDF"
        },
        {
          "name": "XLS",
          "value": "XLS"
        },
        {
          "name": "XML",
          "value": "XML"
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "get"
          ],
          "resource": [
            "companyReport"
          ]
        }
      }
    },
    {
      "displayName": "Put Output In Field",
      "name": "output",
      "type": "string",
      "default": "data",
      "description": "The name of the output field to put the binary file data in",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "get"
          ],
          "resource": [
            "companyReport"
          ]
        },
        "hide": {
          "format": [
            "JSON"
          ]
        }
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Duplicate Field Filtering",
          "name": "fd",
          "type": "boolean",
          "default": true,
          "description": "Whether to apply the standard duplicate field filtering or not"
        },
        {
          "displayName": "Only Current",
          "name": "onlyCurrent",
          "type": "boolean",
          "default": true,
          "description": "Whether to hide future dated values from the history table fields or not"
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "get"
          ],
          "resource": [
            "companyReport"
          ]
        }
      }
    }
  ]

operations:
  [
    {
      "operation": "create",
      "name": "Create",
      "description": "Create an employee",
      "resource": "employee"
    },
    {
      "operation": "get",
      "name": "Get",
      "description": "Get an employee",
      "resource": "employee"
    },
    {
      "operation": "getAll",
      "name": "Get Many",
      "description": "Get many employees",
      "resource": "employee"
    },
    {
      "operation": "update",
      "name": "Update",
      "description": "Update an employee",
      "resource": "employee"
    },
    {
      "operation": "delete",
      "name": "Delete",
      "description": "Delete an employee document",
      "resource": "employeeDocument"
    },
    {
      "operation": "download",
      "name": "Download",
      "description": "Download an employee document",
      "resource": "employeeDocument"
    },
    {
      "operation": "getAll",
      "name": "Get Many",
      "description": "Get many employee documents",
      "resource": "employeeDocument"
    },
    {
      "operation": "update",
      "name": "Update",
      "description": "Update an employee document",
      "resource": "employeeDocument"
    },
    {
      "operation": "upload",
      "name": "Upload",
      "description": "Upload an employee document",
      "resource": "employeeDocument"
    },
    {
      "operation": "delete",
      "name": "Delete",
      "description": "Delete a company file",
      "resource": "file"
    },
    {
      "operation": "download",
      "name": "Download",
      "description": "Download a company file",
      "resource": "file"
    },
    {
      "operation": "getAll",
      "name": "Get Many",
      "description": "Get many company files",
      "resource": "file"
    },
    {
      "operation": "update",
      "name": "Update",
      "description": "Update a company file",
      "resource": "file"
    },
    {
      "operation": "upload",
      "name": "Upload",
      "description": "Upload a company file",
      "resource": "file"
    },
    {
      "operation": "get",
      "name": "Get",
      "description": "Get a company report",
      "resource": "companyReport"
    }
  ]

credentials_required:
  [
    {
      "name": "bambooHrApi",
      "required": true,
      "testedBy": "bambooHrApiCredentialTest"
    }
  ]


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

outputs:
  [
  "main"
  ]

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

  # Bannerbear node

  Use the Bannerbear node to automate work in Bannerbear, and integrate Bannerbear with other applications. n8n has built-in support for a wide range of Bannerbear features, including creating and getting images and templates.

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

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

  ## Operations

  * Image
      * Create an image
      * Get an image
  * Template
      * Get a template
      * Get all templates

  ## Templates and examples

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

properties_schema:
  [
    {
      "displayName": "Resource",
      "name": "resource",
      "type": "options",
      "default": "image",
      "options": [
        {
          "name": "Image",
          "value": "image"
        },
        {
          "name": "Template",
          "value": "template"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create an image",
          "action": "Create an image"
        },
        {
          "name": "Get",
          "value": "get",
          "description": "Get an image",
          "action": "Get an image"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "image"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Template Name or ID",
      "name": "templateId",
      "type": "options",
      "default": "",
      "description": "The template ID you want to use. 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": [
            "image"
          ],
          "operation": [
            "create"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getTemplates"
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Metadata",
          "name": "metadata",
          "type": "string",
          "default": "",
          "description": "Metadata that you need to store e.g. ID of a record in your DB"
        },
        {
          "displayName": "Wait for Image",
          "name": "waitForImage",
          "type": "boolean",
          "default": false,
          "description": "Whether to wait for the image to be proccesed before returning. If after three tries the images is not ready, an error will be thrown. Number of tries can be increased by setting \"Wait Max Tries\"."
        },
        {
          "displayName": "Wait Max Tries",
          "name": "waitForImageMaxTries",
          "type": "number",
          "typeOptions": {
            "minValue": 1,
            "maxValue": 10
          },
          "displayOptions": {
            "show": {
              "waitForImage": [
                true
              ]
            }
          },
          "default": 3,
          "description": "How often it should check if the image is available before it fails"
        },
        {
          "displayName": "Webhook URL",
          "name": "webhookUrl",
          "type": "string",
          "default": "",
          "description": "A URL to POST the Image object to upon rendering completed"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "image"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Modifications",
      "name": "modificationsUi",
      "type": "fixedCollection",
      "default": {},
      "options": [
        {
          "displayName": "Modification",
          "name": "modificationsValues",
          "values": [
            {
              "displayName": "Name or ID",
              "name": "name",
              "type": "options",
              "typeOptions": {
                "loadOptionsMethod": "getModificationNames",
                "loadOptionsDependsOn": [
                  "templateId"
                ]
              },
              "default": "",
              "description": "The name of the item you want to change. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
            },
            {
              "displayName": "Text",
              "name": "text",
              "type": "string",
              "default": "",
              "description": "Replacement text you want to use"
            },
            {
              "displayName": "Color",
              "name": "color",
              "type": "color",
              "default": "",
              "description": "Color hex of object"
            },
            {
              "displayName": "Background",
              "name": "background",
              "type": "color",
              "default": "",
              "description": "Color hex of text background"
            },
            {
              "displayName": "Image URL",
              "name": "imageUrl",
              "type": "string",
              "default": "",
              "description": "Replacement image URL you want to use (must be publicly viewable)"
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "image"
          ],
          "operation": [
            "create"
          ]
        }
      },
      "typeOptions": {
        "multipleValues": true
      }
    },
    {
      "displayName": "Image ID",
      "name": "imageId",
      "type": "string",
      "default": "",
      "description": "Unique identifier for the image",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "image"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "get",
      "options": [
        {
          "name": "Get",
          "value": "get",
          "description": "Get a template",
          "action": "Get a template"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get many templates",
          "action": "Get many templates"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "template"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Template ID",
      "name": "templateId",
      "type": "string",
      "default": "",
      "description": "Unique identifier for the template",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "template"
          ],
          "operation": [
            "get"
          ]
        }
      }
    }
  ]

operations:
  [
    {
      "operation": "create",
      "name": "Create",
      "description": "Create an image",
      "resource": "image"
    },
    {
      "operation": "get",
      "name": "Get",
      "description": "Get an image",
      "resource": "image"
    },
    {
      "operation": "get",
      "name": "Get",
      "description": "Get a template",
      "resource": "template"
    },
    {
      "operation": "getAll",
      "name": "Get Many",
      "description": "Get many templates",
      "resource": "template"
    }
  ]


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

output_names:
  [
  "Tool"
  ]

updated_at: 2026-07-16 12:10:22
tool_variant_of: nodes-base.baserow
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: Baserow node documentation
  description: Learn how to use the Baserow node in n8n. Follow technical documentation to integrate Baserow node into your workflows.
  contentType: [integration, reference]
  priority: high
  ---

  # Baserow node

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

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

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

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

  ## Operations

  * Row
      * Create a row
      * Delete a row
      * Retrieve a row
      * Retrieve all rows
      * Update a row

  ## Templates and examples

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

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 Baserow"
    },
    {
      "displayName": "Authentication",
      "name": "authentication",
      "type": "options",
      "default": "usernamePassword",
      "options": [
        {
          "name": "Username & Password",
          "value": "usernamePassword"
        },
        {
          "name": "Database Token",
          "value": "databaseToken"
        }
      ]
    },
    {
      "displayName": "Resource",
      "name": "resource",
      "type": "options",
      "default": "row",
      "options": [
        {
          "name": "Row",
          "value": "row"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "getAll",
      "options": [
        {
          "name": "Batch Create",
          "value": "batchCreate",
          "description": "Create up to 200 rows in one request",
          "action": "Create multiple rows"
        },
        {
          "name": "Batch Delete",
          "value": "batchDelete",
          "description": "Delete up to 200 rows in one request",
          "action": "Delete multiple rows"
        },
        {
          "name": "Batch Update",
          "value": "batchUpdate",
          "description": "Update up to 200 rows in one request",
          "action": "Update multiple rows"
        },
        {
          "name": "Create",
          "value": "create",
          "description": "Create a row",
          "action": "Create a row"
        },
        {
          "name": "Delete",
          "value": "delete",
          "description": "Delete a row",
          "action": "Delete a row"
        },
        {
          "name": "Get",
          "value": "get",
          "description": "Retrieve a row",
          "action": "Get a row"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Retrieve many rows",
          "action": "Get many rows"
        },
        {
          "name": "Update",
          "value": "update",
          "description": "Update a row",
          "action": "Update a row"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "row"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Database Name or ID",
      "name": "databaseId",
      "type": "options",
      "default": "0",
      "description": "Database to operate on. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
      "required": true,
      "displayOptions": {
        "hide": {
          "authentication": [
            "databaseToken"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getDatabaseIds"
      }
    },
    {
      "displayName": "Table Name or ID",
      "name": "tableId",
      "type": "options",
      "default": "",
      "description": "Table to operate on. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
      "required": true,
      "typeOptions": {
        "loadOptionsDependsOn": [
          "databaseId"
        ],
        "loadOptionsMethod": "getTableIds"
      }
    },
    {
      "displayName": "Row ID",
      "name": "rowId",
      "type": "string",
      "default": "",
      "description": "ID of the row to return",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Row ID",
      "name": "rowId",
      "type": "string",
      "default": "",
      "description": "ID of the row to update",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Data to Send",
      "name": "dataToSend",
      "type": "options",
      "default": "defineBelow",
      "description": "Whether to insert the input data this node receives in the new row",
      "options": [
        {
          "name": "Auto-Map Input Data to Columns",
          "value": "autoMapInputData",
          "description": "Use when node input properties match destination column names"
        },
        {
          "name": "Define Below for Each Column",
          "value": "defineBelow",
          "description": "Set the value for each destination column"
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "create",
            "update",
            "batchCreate",
            "batchUpdate"
          ]
        }
      }
    },
    {
      "displayName": "Inputs to Ignore",
      "name": "inputsToIgnore",
      "type": "string",
      "default": "",
      "description": "List of input properties to avoid sending, separated by commas. Leave empty to send all properties.",
      "displayOptions": {
        "show": {
          "operation": [
            "create",
            "update",
            "batchCreate",
            "batchUpdate"
          ],
          "dataToSend": [
            "autoMapInputData"
          ]
        }
      }
    },
    {
      "displayName": "Fields to Send",
      "name": "fieldsUi",
      "type": "fixedCollection",
      "default": {},
      "options": [
        {
          "displayName": "Field",
          "name": "fieldValues",
          "values": [
            {
              "displayName": "Field Name or ID",
              "name": "fieldId",
              "type": "options",
              "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
              "typeOptions": {
                "loadOptionsDependsOn": [
                  "tableId"
                ],
                "loadOptionsMethod": "getTableFields"
              },
              "default": ""
            },
            {
              "displayName": "Field Value",
              "name": "fieldValue",
              "type": "string",
              "default": ""
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "create",
            "update"
          ],
          "dataToSend": [
            "defineBelow"
          ]
        }
      },
      "typeOptions": {
        "multipleValueButtonText": "Add Field to Send",
        "multipleValues": true
      }
    },
    {
      "displayName": "Rows",
      "name": "rowsUi",
      "type": "fixedCollection",
      "default": [],
      "options": [
        {
          "name": "rowValues",
          "displayName": "Row",
          "values": [
            {
              "displayName": "Row ID",
              "name": "id",
              "type": "string",
              "displayOptions": {
                "show": {
                  "/operation": [
                    "batchUpdate"
                  ]
                }
              },
              "default": "",
              "required": true,
              "description": "Row ID to update (required for batch update)"
            },
            {
              "displayName": "Fields",
              "name": "fieldsUi",
              "type": "fixedCollection",
              "typeOptions": {
                "multipleValues": true,
                "multipleValueButtonText": "Add Field"
              },
              "default": {},
              "options": [
                {
                  "name": "fieldValues",
                  "displayName": "Field",
                  "values": [
                    {
                      "displayName": "Field Name or ID",
                      "name": "fieldId",
                      "type": "options",
                      "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
                      "typeOptions": {
                        "loadOptionsDependsOn": [
                          "tableId"
                        ],
                        "loadOptionsMethod": "getTableFields"
                      },
                      "default": ""
                    },
                    {
                      "displayName": "Field Value",
                      "name": "fieldValue",
                      "type": "string",
                      "default": ""
                    }
                  ]
                }
              ]
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "batchCreate",
            "batchUpdate"
          ],
          "dataToSend": [
            "defineBelow"
          ]
        }
      },
      "typeOptions": {
        "multipleValues": true
      }
    },
    {
      "displayName": "Data to Send",
      "name": "dataToSend",
      "type": "options",
      "default": "defineBelow",
      "description": "Choose whether to manually enter row IDs or map them from input data",
      "options": [
        {
          "name": "Auto-Map Input Data",
          "value": "autoMapInputData",
          "description": "Collect row IDs from input items automatically"
        },
        {
          "name": "Define Below",
          "value": "defineBelow",
          "description": "Manually specify row IDs"
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "batchDelete"
          ]
        }
      }
    },
    {
      "displayName": "Row ID",
      "name": "rowId",
      "type": "string",
      "default": "",
      "description": "ID of the row to delete",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "Row IDs",
      "name": "rowIds",
      "type": "string",
      "default": [],
      "description": "IDs of the rows to delete",
      "displayOptions": {
        "show": {
          "operation": [
            "batchDelete"
          ],
          "dataToSend": [
            "defineBelow"
          ]
        }
      },
      "typeOptions": {
        "multipleValues": true
      }
    },
    {
      "displayName": "Property Containing Row ID",
      "name": "rowIdProperty",
      "type": "string",
      "default": "id",
      "description": "Name of the property in each input item that contains the row ID",
      "displayOptions": {
        "show": {
          "operation": [
            "batchDelete"
          ],
          "dataToSend": [
            "autoMapInputData"
          ]
        }
      }
    },
    {
      "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"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 50,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 100
      }
    },
    {
      "displayName": "Options",
      "name": "additionalOptions",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Filters",
          "name": "filters",
          "placeholder": "Add Filter",
          "description": "Filter rows based on comparison operators",
          "type": "fixedCollection",
          "typeOptions": {
            "multipleValues": true
          },
          "default": {},
          "options": [
            {
              "name": "fields",
              "displayName": "Field",
              "values": [
                {
                  "displayName": "Field Name or ID",
                  "name": "field",
                  "type": "options",
                  "default": "",
                  "description": "Field to compare. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
                  "typeOptions": {
                    "loadOptionsDependsOn": [
                      "tableId"
                    ],
                    "loadOptionsMethod": "getTableFields"
                  }
                },
                {
                  "displayName": "Filter",
                  "name": "operator",
                  "description": "Operator to compare field and value with",
                  "type": "options",
                  "options": [
                    {
                      "name": "Equal",
                      "value": "equal",
                      "description": "Field value is exactly equal to the given value"
                    },
                    {
                      "name": "Not Equal",
                      "value": "not_equal",
                      "description": "Field value is not equal to the given value"
                    },
                    {
                      "name": "Contains",
                      "value": "contains",
                      "description": "Field value contains the given substring (case-insensitive)"
                    },
                    {
                      "name": "Contains Not",
                      "value": "contains_not",
                      "description": "Field value does not contain the given substring (case-insensitive)"
                    },
                    {
                      "name": "Contains Word",
                      "value": "contains_word",
                      "description": "Field contains the full word (case-insensitive match on word boundaries)"
                    },
                    {
                      "name": "Does Not Contain Word",
                      "value": "doesnt_contain_word",
                      "description": "Field does not contain the full word (case-insensitive)"
                    },
                    {
                      "name": "Length Is Lower Than",
                      "value": "length_is_lower_than",
                      "description": "Field value length is shorter than the given number"
                    },
                    {
                      "name": "Higher Than",
                      "value": "higher_than",
                      "description": "Field value is greater than the given number"
                    },
                    {
                      "name": "Higher Than or Equal",
                      "value": "higher_than_or_equal",
                      "description": "Field value is greater than or equal to the given number"
                    },
                    {
                      "name": "Lower Than",
                      "value": "lower_than",
                      "description": "Field value is less than the given number"
                    },
                    {
                      "name": "Lower Than or Equal",
                      "value": "lower_than_or_equal",
                      "description": "Field value is less than or equal to the given number"
                    },
                    {
                      "name": "Is Even And Whole",
                      "value": "is_even_and_whole",
                      "description": "Field value is an even whole number (no decimals)"
                    },
                    {
                      "name": "Date Is",
                      "value": "date_is",
                      "description": "Date matches the given day. Format: `Europe/Berlin??2024-09-17` (Timezone??YYYY-MM-DD)."
                    },
                    {
                      "name": "Date Is Not",
                      "value": "date_is_not",
                      "description": "Date does not match the given day. Format: `UTC??2024-09-17`."
                    },
                    {
                      "name": "Date Is Before",
                      "value": "date_is_before",
                      "description": "Date is strictly before the given day. Format: `UTC??2024-09-17`."
                    },
                    {
                      "name": "Date Is On Or Before",
                      "value": "date_is_on_or_before",
                      "description": "Date is before or equal to the given day. Format: `UTC??2024-09-17`."
                    },
                    {
                      "name": "Date Is After",
                      "value": "date_is_after",
                      "description": "Date is strictly after the given day. Format: `UTC??2024-09-17`."
                    },
                    {
                      "name": "Date Is On Or After",
                      "value": "date_is_on_or_after",
                      "description": "Date is after or equal to the given day. Format: `UTC??2024-09-17`."
                    },
                    {
                      "name": "Date Is Within",
                      "value": "date_is_within",
                      "description": "Date is within the next X days. Format: `UTC??30` (Timezone??NumberOfDays)."
                    },
                    {
                      "name": "Date Equals Today",
                      "value": "date_equals_today",
                      "description": "Date is today. Format: `UTC??today`. (Deprecated but kept for compatibility)."
                    },
                    {
                      "name": "Date Equals Month",
                      "value": "date_equals_month",
                      "description": "Date is in the given month. Format: `UTC??2024-09`. (Deprecated but kept for compatibility)."
                    },
                    {
                      "name": "Date Equals Year",
                      "value": "date_equals_year",
                      "description": "Date is in the given year. Format: `UTC??2024`. (Deprecated but kept for compatibility)."
                    },
                    {
                      "name": "Date Equals Day Of Month",
                      "value": "date_equals_day_of_month",
                      "description": "Day of month matches the given number. Format: `UTC??15` (1-31)."
                    },
                    {
                      "name": "Date Equal (Deprecated)",
                      "value": "date_equal",
                      "description": "Field is date. Format: `UTC?YYYY-MM-DD`. Prefer using Date Is (date_is)."
                    },
                    {
                      "name": "Date Not Equal (Deprecated)",
                      "value": "date_not_equal",
                      "description": "Field is not date. Format: `UTC?YYYY-MM-DD`. Prefer using Date Is Not (date_is_not)."
                    },
                    {
                      "name": "Date Before (Deprecated)",
                      "value": "date_before",
                      "description": "Field before this date. Format: `UTC?YYYY-MM-DD`. Prefer using Date Is Before (date_is_before)."
                    },
                    {
                      "name": "Date Before Or Equal (Deprecated)",
                      "value": "date_before_or_equal",
                      "description": "Field on or before this date. Format: `UTC?YYYY-MM-DD`. Prefer using Date Is On Or Before (date_is_on_or_before)."
                    },
                    {
                      "name": "Date After (Deprecated)",
                      "value": "date_after",
                      "description": "Field after this date. Format: `UTC?YYYY-MM-DD`. Prefer using Date Is After (date_is_after)."
                    },
                    {
                      "name": "Date After Or Equal (Deprecated)",
                      "value": "date_after_or_equal",
                      "description": "Field after or equal to this date. Format: `UTC?YYYY-MM-DD`. Prefer using Date Is On Or After (date_is_on_or_after)."
                    },
                    {
                      "name": "Date After Days Ago (Deprecated)",
                      "value": "date_after_days_ago",
                      "description": "Date is after X days ago. Format: `UTC?10`. Prefer using Date Is On Or After with NR_DAYS_AGO."
                    },
                    {
                      "name": "Date Within Days (Deprecated)",
                      "value": "date_within_days",
                      "description": "Date is within N days from today. Format: `UTC?30`. Prefer using Date Is Within (date_is_within)."
                    },
                    {
                      "name": "Date Within Weeks (Deprecated)",
                      "value": "date_within_weeks",
                      "description": "Date is within N weeks from today. Format: `UTC?4`. Prefer using Date Is Within."
                    },
                    {
                      "name": "Date Within Months (Deprecated)",
                      "value": "date_within_months",
                      "description": "Date is within N months from today. Format: `UTC?3`. Prefer using Date Is Within."
                    },
                    {
                      "name": "Date Equals Days Ago (Deprecated)",
                      "value": "date_equals_days_ago",
                      "description": "Date is exactly N days ago. Format: `UTC?5`."
                    },
                    {
                      "name": "Date Equals Months Ago (Deprecated)",
                      "value": "date_equals_months_ago",
                      "description": "Date is exactly N months ago. Format: `UTC?2`."
                    },
                    {
                      "name": "Date Equals Years Ago (Deprecated)",
                      "value": "date_equals_years_ago",
                      "description": "Date is exactly N years ago. Format: `UTC?1`."
                    },
                    {
                      "name": "Date Before Today (Deprecated)",
                      "value": "date_before_today",
                      "description": "Date is before today. Format: `UTC`. Prefer using Date Is Before with operator TODAY."
                    },
                    {
                      "name": "Date After Today (Deprecated)",
                      "value": "date_after_today",
                      "description": "Date is after today. Format: `UTC`. Prefer using Date Is After with operator TODAY."
                    },
                    {
                      "name": "Date Equals Current Week (Deprecated)",
                      "value": "date_equals_week",
                      "description": "Date is within current week. Format: `UTC`. Prefer using Date Is with THIS_WEEK."
                    },
                    {
                      "name": "Filename Contains",
                      "value": "filename_contains",
                      "description": "Filename contains the given substring"
                    },
                    {
                      "name": "Has File Type",
                      "value": "has_file_type",
                      "description": "File type is \"image\" or \"document\""
                    },
                    {
                      "name": "Files Lower Than",
                      "value": "files_lower_than",
                      "description": "Number of attached files is less than the given number"
                    },
                    {
                      "name": "Single Select Equal",
                      "value": "single_select_equal",
                      "description": "Single select option matches given option ID"
                    },
                    {
                      "name": "Single Select Not Equal",
                      "value": "single_select_not_equal",
                      "description": "Single select option does not match given option ID"
                    },
                    {
                      "name": "Single Select Is Any Of",
                      "value": "single_select_is_any_of",
                      "description": "Single select option is one of the given option IDs. Format: `1,2,3`."
                    },
                    {
                      "name": "Single Select Is None Of",
                      "value": "single_select_is_none_of",
                      "description": "Single select option is none of the given option IDs. Format: `1,2,3`."
                    },
                    {
                      "name": "Multiple Select Has",
                      "value": "multiple_select_has",
                      "description": "Multiple select has at least one of the given option IDs. Format: `1,2,3`."
                    },
                    {
                      "name": "Multiple Select Has Not",
                      "value": "multiple_select_has_not",
                      "description": "Multiple select has none of the given option IDs. Format: `1,2,3`."
                    },
                    {
                      "name": "Collaborators Has",
                      "value": "multiple_collaborators_has",
                      "description": "Field includes the given user ID"
                    },
                    {
                      "name": "Collaborators Has Not",
                      "value": "multiple_collaborators_has_not",
                      "description": "Field excludes the given user ID"
                    },
                    {
                      "name": "User Is",
                      "value": "user_is",
                      "description": "Row created by or last modified by the given user ID"
                    },
                    {
                      "name": "User Is Not",
                      "value": "user_is_not",
                      "description": "Row was not created or modified by the given user ID"
                    },
                    {
                      "name": "Link Row Has",
                      "value": "link_row_has",
                      "description": "Field links to the given row ID"
                    },
                    {
                      "name": "Link Row Has Not",
                      "value": "link_row_has_not",
                      "description": "Field does not link to the given row ID"
                    },
                    {
                      "name": "Link Row Contains",
                      "value": "link_row_contains",
                      "description": "Linked row value contains the given text (case-insensitive)"
                    },
                    {
                      "name": "Link Row Not Contains",
                      "value": "link_row_not_contains",
                      "description": "Linked row value does not contain the given text"
                    },
                    {
                      "name": "Is True",
                      "value": "boolean",
                      "description": "Boolean field is true (false if not set)"
                    },
                    {
                      "name": "Is Empty",
                      "value": "empty",
                      "description": "Field is empty (null or blank)"
                    },
                    {
                      "name": "Is Not Empty",
                      "value": "not_empty",
                      "description": "Field is not empty"
                    }
                  ],
                  "default": "equal"
                },
                {
                  "displayName": "Value",
                  "name": "value",
                  "type": "string",
                  "default": "",
                  "description": "Value to compare to"
                }
              ]
            }
          ]
        },
        {
          "displayName": "Filter Type",
          "name": "filterType",
          "type": "options",
          "options": [
            {
              "name": "AND",
              "value": "AND",
              "description": "Indicates that the rows must match all the provided filters"
            },
            {
              "name": "OR",
              "value": "OR",
              "description": "Indicates that the rows only have to match one of the filters"
            }
          ],
          "default": "AND",
          "description": "This works only if two or more filters are provided. Defaults to <code>AND</code>"
        },
        {
          "displayName": "Search Term",
          "name": "search",
          "type": "string",
          "default": "",
          "description": "Text to match (can be in any column)"
        },
        {
          "displayName": "Sorting",
          "name": "order",
          "placeholder": "Add Sort Order",
          "description": "Set the sort order of the result rows",
          "type": "fixedCollection",
          "typeOptions": {
            "multipleValues": true
          },
          "default": {},
          "options": [
            {
              "name": "fields",
              "displayName": "Field",
              "values": [
                {
                  "displayName": "Field Name or ID",
                  "name": "field",
                  "type": "options",
                  "default": "",
                  "description": "Field name to sort by. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
                  "typeOptions": {
                    "loadOptionsDependsOn": [
                      "tableId"
                    ],
                    "loadOptionsMethod": "getTableFields"
                  }
                },
                {
                  "displayName": "Direction",
                  "name": "direction",
                  "type": "options",
                  "options": [
                    {
                      "name": "ASC",
                      "value": "",
                      "description": "Sort in ascending order"
                    },
                    {
                      "name": "DESC",
                      "value": "-",
                      "description": "Sort in descending order"
                    }
                  ],
                  "default": "",
                  "description": "Sort direction, either ascending or descending"
                }
              ]
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ]
        }
      }
    }
  ]

operations:
  [
    {
      "operation": "batchCreate",
      "name": "Batch Create",
      "description": "Create up to 200 rows in one request",
      "resource": "row"
    },
    {
      "operation": "batchDelete",
      "name": "Batch Delete",
      "description": "Delete up to 200 rows in one request",
      "resource": "row"
    },
    {
      "operation": "batchUpdate",
      "name": "Batch Update",
      "description": "Update up to 200 rows in one request",
      "resource": "row"
    },
    {
      "operation": "create",
      "name": "Create",
      "description": "Create a row",
      "resource": "row"
    },
    {
      "operation": "delete",
      "name": "Delete",
      "description": "Delete a row",
      "resource": "row"
    },
    {
      "operation": "get",
      "name": "Get",
      "description": "Retrieve a row",
      "resource": "row"
    },
    {
      "operation": "getAll",
      "name": "Get Many",
      "description": "Retrieve many rows",
      "resource": "row"
    },
    {
      "operation": "update",
      "name": "Update",
      "description": "Update a row",
      "resource": "row"
    }
  ]

credentials_required:
  [
    {
      "name": "baserowApi",
      "required": true,
      "displayOptions": {
        "show": {
          "authentication": [
            "usernamePassword"
          ]
        }
      }
    },
    {
      "name": "baserowTokenApi",
      "required": true,
      "displayOptions": {
        "show": {
          "authentication": [
            "databaseToken"
          ]
        }
      }
    }
  ]


node_type: nodes-base.baserow
package_name: n8n-nodes-base
display_name: Baserow
description: Consume the Baserow API
category: output
development_style: programmatic
version: 1.1
outputs:
  [
  "main"
  ]

updated_at: 2026-07-16 12:10:22
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: Baserow node documentation
  description: Learn how to use the Baserow node in n8n. Follow technical documentation to integrate Baserow node into your workflows.
  contentType: [integration, reference]
  priority: high
  ---

  # Baserow node

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

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

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

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

  ## Operations

  * Row
      * Create a row
      * Delete a row
      * Retrieve a row
      * Retrieve all rows
      * Update a row

  ## Templates and examples

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

properties_schema:
  [
    {
      "displayName": "Authentication",
      "name": "authentication",
      "type": "options",
      "default": "usernamePassword",
      "options": [
        {
          "name": "Username & Password",
          "value": "usernamePassword"
        },
        {
          "name": "Database Token",
          "value": "databaseToken"
        }
      ]
    },
    {
      "displayName": "Resource",
      "name": "resource",
      "type": "options",
      "default": "row",
      "options": [
        {
          "name": "Row",
          "value": "row"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "getAll",
      "options": [
        {
          "name": "Batch Create",
          "value": "batchCreate",
          "description": "Create up to 200 rows in one request",
          "action": "Create multiple rows"
        },
        {
          "name": "Batch Delete",
          "value": "batchDelete",
          "description": "Delete up to 200 rows in one request",
          "action": "Delete multiple rows"
        },
        {
          "name": "Batch Update",
          "value": "batchUpdate",
          "description": "Update up to 200 rows in one request",
          "action": "Update multiple rows"
        },
        {
          "name": "Create",
          "value": "create",
          "description": "Create a row",
          "action": "Create a row"
        },
        {
          "name": "Delete",
          "value": "delete",
          "description": "Delete a row",
          "action": "Delete a row"
        },
        {
          "name": "Get",
          "value": "get",
          "description": "Retrieve a row",
          "action": "Get a row"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Retrieve many rows",
          "action": "Get many rows"
        },
        {
          "name": "Update",
          "value": "update",
          "description": "Update a row",
          "action": "Update a row"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "row"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Database Name or ID",
      "name": "databaseId",
      "type": "options",
      "default": "0",
      "description": "Database to operate on. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
      "required": true,
      "displayOptions": {
        "hide": {
          "authentication": [
            "databaseToken"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getDatabaseIds"
      }
    },
    {
      "displayName": "Table Name or ID",
      "name": "tableId",
      "type": "options",
      "default": "",
      "description": "Table to operate on. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
      "required": true,
      "typeOptions": {
        "loadOptionsDependsOn": [
          "databaseId"
        ],
        "loadOptionsMethod": "getTableIds"
      }
    },
    {
      "displayName": "Row ID",
      "name": "rowId",
      "type": "string",
      "default": "",
      "description": "ID of the row to return",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Row ID",
      "name": "rowId",
      "type": "string",
      "default": "",
      "description": "ID of the row to update",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Data to Send",
      "name": "dataToSend",
      "type": "options",
      "default": "defineBelow",
      "description": "Whether to insert the input data this node receives in the new row",
      "options": [
        {
          "name": "Auto-Map Input Data to Columns",
          "value": "autoMapInputData",
          "description": "Use when node input properties match destination column names"
        },
        {
          "name": "Define Below for Each Column",
          "value": "defineBelow",
          "description": "Set the value for each destination column"
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "create",
            "update",
            "batchCreate",
            "batchUpdate"
          ]
        }
      }
    },
    {
      "displayName": "Inputs to Ignore",
      "name": "inputsToIgnore",
      "type": "string",
      "default": "",
      "description": "List of input properties to avoid sending, separated by commas. Leave empty to send all properties.",
      "displayOptions": {
        "show": {
          "operation": [
            "create",
            "update",
            "batchCreate",
            "batchUpdate"
          ],
          "dataToSend": [
            "autoMapInputData"
          ]
        }
      }
    },
    {
      "displayName": "Fields to Send",
      "name": "fieldsUi",
      "type": "fixedCollection",
      "default": {},
      "options": [
        {
          "displayName": "Field",
          "name": "fieldValues",
          "values": [
            {
              "displayName": "Field Name or ID",
              "name": "fieldId",
              "type": "options",
              "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
              "typeOptions": {
                "loadOptionsDependsOn": [
                  "tableId"
                ],
                "loadOptionsMethod": "getTableFields"
              },
              "default": ""
            },
            {
              "displayName": "Field Value",
              "name": "fieldValue",
              "type": "string",
              "default": ""
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "create",
            "update"
          ],
          "dataToSend": [
            "defineBelow"
          ]
        }
      },
      "typeOptions": {
        "multipleValueButtonText": "Add Field to Send",
        "multipleValues": true
      }
    },
    {
      "displayName": "Rows",
      "name": "rowsUi",
      "type": "fixedCollection",
      "default": [],
      "options": [
        {
          "name": "rowValues",
          "displayName": "Row",
          "values": [
            {
              "displayName": "Row ID",
              "name": "id",
              "type": "string",
              "displayOptions": {
                "show": {
                  "/operation": [
                    "batchUpdate"
                  ]
                }
              },
              "default": "",
              "required": true,
              "description": "Row ID to update (required for batch update)"
            },
            {
              "displayName": "Fields",
              "name": "fieldsUi",
              "type": "fixedCollection",
              "typeOptions": {
                "multipleValues": true,
                "multipleValueButtonText": "Add Field"
              },
              "default": {},
              "options": [
                {
                  "name": "fieldValues",
                  "displayName": "Field",
                  "values": [
                    {
                      "displayName": "Field Name or ID",
                      "name": "fieldId",
                      "type": "options",
                      "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
                      "typeOptions": {
                        "loadOptionsDependsOn": [
                          "tableId"
                        ],
                        "loadOptionsMethod": "getTableFields"
                      },
                      "default": ""
                    },
                    {
                      "displayName": "Field Value",
                      "name": "fieldValue",
                      "type": "string",
                      "default": ""
                    }
                  ]
                }
              ]
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "batchCreate",
            "batchUpdate"
          ],
          "dataToSend": [
            "defineBelow"
          ]
        }
      },
      "typeOptions": {
        "multipleValues": true
      }
    },
    {
      "displayName": "Data to Send",
      "name": "dataToSend",
      "type": "options",
      "default": "defineBelow",
      "description": "Choose whether to manually enter row IDs or map them from input data",
      "options": [
        {
          "name": "Auto-Map Input Data",
          "value": "autoMapInputData",
          "description": "Collect row IDs from input items automatically"
        },
        {
          "name": "Define Below",
          "value": "defineBelow",
          "description": "Manually specify row IDs"
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "batchDelete"
          ]
        }
      }
    },
    {
      "displayName": "Row ID",
      "name": "rowId",
      "type": "string",
      "default": "",
      "description": "ID of the row to delete",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "Row IDs",
      "name": "rowIds",
      "type": "string",
      "default": [],
      "description": "IDs of the rows to delete",
      "displayOptions": {
        "show": {
          "operation": [
            "batchDelete"
          ],
          "dataToSend": [
            "defineBelow"
          ]
        }
      },
      "typeOptions": {
        "multipleValues": true
      }
    },
    {
      "displayName": "Property Containing Row ID",
      "name": "rowIdProperty",
      "type": "string",
      "default": "id",
      "description": "Name of the property in each input item that contains the row ID",
      "displayOptions": {
        "show": {
          "operation": [
            "batchDelete"
          ],
          "dataToSend": [
            "autoMapInputData"
          ]
        }
      }
    },
    {
      "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"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 50,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 100
      }
    },
    {
      "displayName": "Options",
      "name": "additionalOptions",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Filters",
          "name": "filters",
          "placeholder": "Add Filter",
          "description": "Filter rows based on comparison operators",
          "type": "fixedCollection",
          "typeOptions": {
            "multipleValues": true
          },
          "default": {},
          "options": [
            {
              "name": "fields",
              "displayName": "Field",
              "values": [
                {
                  "displayName": "Field Name or ID",
                  "name": "field",
                  "type": "options",
                  "default": "",
                  "description": "Field to compare. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
                  "typeOptions": {
                    "loadOptionsDependsOn": [
                      "tableId"
                    ],
                    "loadOptionsMethod": "getTableFields"
                  }
                },
                {
                  "displayName": "Filter",
                  "name": "operator",
                  "description": "Operator to compare field and value with",
                  "type": "options",
                  "options": [
                    {
                      "name": "Equal",
                      "value": "equal",
                      "description": "Field value is exactly equal to the given value"
                    },
                    {
                      "name": "Not Equal",
                      "value": "not_equal",
                      "description": "Field value is not equal to the given value"
                    },
                    {
                      "name": "Contains",
                      "value": "contains",
                      "description": "Field value contains the given substring (case-insensitive)"
                    },
                    {
                      "name": "Contains Not",
                      "value": "contains_not",
                      "description": "Field value does not contain the given substring (case-insensitive)"
                    },
                    {
                      "name": "Contains Word",
                      "value": "contains_word",
                      "description": "Field contains the full word (case-insensitive match on word boundaries)"
                    },
                    {
                      "name": "Does Not Contain Word",
                      "value": "doesnt_contain_word",
                      "description": "Field does not contain the full word (case-insensitive)"
                    },
                    {
                      "name": "Length Is Lower Than",
                      "value": "length_is_lower_than",
                      "description": "Field value length is shorter than the given number"
                    },
                    {
                      "name": "Higher Than",
                      "value": "higher_than",
                      "description": "Field value is greater than the given number"
                    },
                    {
                      "name": "Higher Than or Equal",
                      "value": "higher_than_or_equal",
                      "description": "Field value is greater than or equal to the given number"
                    },
                    {
                      "name": "Lower Than",
                      "value": "lower_than",
                      "description": "Field value is less than the given number"
                    },
                    {
                      "name": "Lower Than or Equal",
                      "value": "lower_than_or_equal",
                      "description": "Field value is less than or equal to the given number"
                    },
                    {
                      "name": "Is Even And Whole",
                      "value": "is_even_and_whole",
                      "description": "Field value is an even whole number (no decimals)"
                    },
                    {
                      "name": "Date Is",
                      "value": "date_is",
                      "description": "Date matches the given day. Format: `Europe/Berlin??2024-09-17` (Timezone??YYYY-MM-DD)."
                    },
                    {
                      "name": "Date Is Not",
                      "value": "date_is_not",
                      "description": "Date does not match the given day. Format: `UTC??2024-09-17`."
                    },
                    {
                      "name": "Date Is Before",
                      "value": "date_is_before",
                      "description": "Date is strictly before the given day. Format: `UTC??2024-09-17`."
                    },
                    {
                      "name": "Date Is On Or Before",
                      "value": "date_is_on_or_before",
                      "description": "Date is before or equal to the given day. Format: `UTC??2024-09-17`."
                    },
                    {
                      "name": "Date Is After",
                      "value": "date_is_after",
                      "description": "Date is strictly after the given day. Format: `UTC??2024-09-17`."
                    },
                    {
                      "name": "Date Is On Or After",
                      "value": "date_is_on_or_after",
                      "description": "Date is after or equal to the given day. Format: `UTC??2024-09-17`."
                    },
                    {
                      "name": "Date Is Within",
                      "value": "date_is_within",
                      "description": "Date is within the next X days. Format: `UTC??30` (Timezone??NumberOfDays)."
                    },
                    {
                      "name": "Date Equals Today",
                      "value": "date_equals_today",
                      "description": "Date is today. Format: `UTC??today`. (Deprecated but kept for compatibility)."
                    },
                    {
                      "name": "Date Equals Month",
                      "value": "date_equals_month",
                      "description": "Date is in the given month. Format: `UTC??2024-09`. (Deprecated but kept for compatibility)."
                    },
                    {
                      "name": "Date Equals Year",
                      "value": "date_equals_year",
                      "description": "Date is in the given year. Format: `UTC??2024`. (Deprecated but kept for compatibility)."
                    },
                    {
                      "name": "Date Equals Day Of Month",
                      "value": "date_equals_day_of_month",
                      "description": "Day of month matches the given number. Format: `UTC??15` (1-31)."
                    },
                    {
                      "name": "Date Equal (Deprecated)",
                      "value": "date_equal",
                      "description": "Field is date. Format: `UTC?YYYY-MM-DD`. Prefer using Date Is (date_is)."
                    },
                    {
                      "name": "Date Not Equal (Deprecated)",
                      "value": "date_not_equal",
                      "description": "Field is not date. Format: `UTC?YYYY-MM-DD`. Prefer using Date Is Not (date_is_not)."
                    },
                    {
                      "name": "Date Before (Deprecated)",
                      "value": "date_before",
                      "description": "Field before this date. Format: `UTC?YYYY-MM-DD`. Prefer using Date Is Before (date_is_before)."
                    },
                    {
                      "name": "Date Before Or Equal (Deprecated)",
                      "value": "date_before_or_equal",
                      "description": "Field on or before this date. Format: `UTC?YYYY-MM-DD`. Prefer using Date Is On Or Before (date_is_on_or_before)."
                    },
                    {
                      "name": "Date After (Deprecated)",
                      "value": "date_after",
                      "description": "Field after this date. Format: `UTC?YYYY-MM-DD`. Prefer using Date Is After (date_is_after)."
                    },
                    {
                      "name": "Date After Or Equal (Deprecated)",
                      "value": "date_after_or_equal",
                      "description": "Field after or equal to this date. Format: `UTC?YYYY-MM-DD`. Prefer using Date Is On Or After (date_is_on_or_after)."
                    },
                    {
                      "name": "Date After Days Ago (Deprecated)",
                      "value": "date_after_days_ago",
                      "description": "Date is after X days ago. Format: `UTC?10`. Prefer using Date Is On Or After with NR_DAYS_AGO."
                    },
                    {
                      "name": "Date Within Days (Deprecated)",
                      "value": "date_within_days",
                      "description": "Date is within N days from today. Format: `UTC?30`. Prefer using Date Is Within (date_is_within)."
                    },
                    {
                      "name": "Date Within Weeks (Deprecated)",
                      "value": "date_within_weeks",
                      "description": "Date is within N weeks from today. Format: `UTC?4`. Prefer using Date Is Within."
                    },
                    {
                      "name": "Date Within Months (Deprecated)",
                      "value": "date_within_months",
                      "description": "Date is within N months from today. Format: `UTC?3`. Prefer using Date Is Within."
                    },
                    {
                      "name": "Date Equals Days Ago (Deprecated)",
                      "value": "date_equals_days_ago",
                      "description": "Date is exactly N days ago. Format: `UTC?5`."
                    },
                    {
                      "name": "Date Equals Months Ago (Deprecated)",
                      "value": "date_equals_months_ago",
                      "description": "Date is exactly N months ago. Format: `UTC?2`."
                    },
                    {
                      "name": "Date Equals Years Ago (Deprecated)",
                      "value": "date_equals_years_ago",
                      "description": "Date is exactly N years ago. Format: `UTC?1`."
                    },
                    {
                      "name": "Date Before Today (Deprecated)",
                      "value": "date_before_today",
                      "description": "Date is before today. Format: `UTC`. Prefer using Date Is Before with operator TODAY."
                    },
                    {
                      "name": "Date After Today (Deprecated)",
                      "value": "date_after_today",
                      "description": "Date is after today. Format: `UTC`. Prefer using Date Is After with operator TODAY."
                    },
                    {
                      "name": "Date Equals Current Week (Deprecated)",
                      "value": "date_equals_week",
                      "description": "Date is within current week. Format: `UTC`. Prefer using Date Is with THIS_WEEK."
                    },
                    {
                      "name": "Filename Contains",
                      "value": "filename_contains",
                      "description": "Filename contains the given substring"
                    },
                    {
                      "name": "Has File Type",
                      "value": "has_file_type",
                      "description": "File type is \"image\" or \"document\""
                    },
                    {
                      "name": "Files Lower Than",
                      "value": "files_lower_than",
                      "description": "Number of attached files is less than the given number"
                    },
                    {
                      "name": "Single Select Equal",
                      "value": "single_select_equal",
                      "description": "Single select option matches given option ID"
                    },
                    {
                      "name": "Single Select Not Equal",
                      "value": "single_select_not_equal",
                      "description": "Single select option does not match given option ID"
                    },
                    {
                      "name": "Single Select Is Any Of",
                      "value": "single_select_is_any_of",
                      "description": "Single select option is one of the given option IDs. Format: `1,2,3`."
                    },
                    {
                      "name": "Single Select Is None Of",
                      "value": "single_select_is_none_of",
                      "description": "Single select option is none of the given option IDs. Format: `1,2,3`."
                    },
                    {
                      "name": "Multiple Select Has",
                      "value": "multiple_select_has",
                      "description": "Multiple select has at least one of the given option IDs. Format: `1,2,3`."
                    },
                    {
                      "name": "Multiple Select Has Not",
                      "value": "multiple_select_has_not",
                      "description": "Multiple select has none of the given option IDs. Format: `1,2,3`."
                    },
                    {
                      "name": "Collaborators Has",
                      "value": "multiple_collaborators_has",
                      "description": "Field includes the given user ID"
                    },
                    {
                      "name": "Collaborators Has Not",
                      "value": "multiple_collaborators_has_not",
                      "description": "Field excludes the given user ID"
                    },
                    {
                      "name": "User Is",
                      "value": "user_is",
                      "description": "Row created by or last modified by the given user ID"
                    },
                    {
                      "name": "User Is Not",
                      "value": "user_is_not",
                      "description": "Row was not created or modified by the given user ID"
                    },
                    {
                      "name": "Link Row Has",
                      "value": "link_row_has",
                      "description": "Field links to the given row ID"
                    },
                    {
                      "name": "Link Row Has Not",
                      "value": "link_row_has_not",
                      "description": "Field does not link to the given row ID"
                    },
                    {
                      "name": "Link Row Contains",
                      "value": "link_row_contains",
                      "description": "Linked row value contains the given text (case-insensitive)"
                    },
                    {
                      "name": "Link Row Not Contains",
                      "value": "link_row_not_contains",
                      "description": "Linked row value does not contain the given text"
                    },
                    {
                      "name": "Is True",
                      "value": "boolean",
                      "description": "Boolean field is true (false if not set)"
                    },
                    {
                      "name": "Is Empty",
                      "value": "empty",
                      "description": "Field is empty (null or blank)"
                    },
                    {
                      "name": "Is Not Empty",
                      "value": "not_empty",
                      "description": "Field is not empty"
                    }
                  ],
                  "default": "equal"
                },
                {
                  "displayName": "Value",
                  "name": "value",
                  "type": "string",
                  "default": "",
                  "description": "Value to compare to"
                }
              ]
            }
          ]
        },
        {
          "displayName": "Filter Type",
          "name": "filterType",
          "type": "options",
          "options": [
            {
              "name": "AND",
              "value": "AND",
              "description": "Indicates that the rows must match all the provided filters"
            },
            {
              "name": "OR",
              "value": "OR",
              "description": "Indicates that the rows only have to match one of the filters"
            }
          ],
          "default": "AND",
          "description": "This works only if two or more filters are provided. Defaults to <code>AND</code>"
        },
        {
          "displayName": "Search Term",
          "name": "search",
          "type": "string",
          "default": "",
          "description": "Text to match (can be in any column)"
        },
        {
          "displayName": "Sorting",
          "name": "order",
          "placeholder": "Add Sort Order",
          "description": "Set the sort order of the result rows",
          "type": "fixedCollection",
          "typeOptions": {
            "multipleValues": true
          },
          "default": {},
          "options": [
            {
              "name": "fields",
              "displayName": "Field",
              "values": [
                {
                  "displayName": "Field Name or ID",
                  "name": "field",
                  "type": "options",
                  "default": "",
                  "description": "Field name to sort by. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
                  "typeOptions": {
                    "loadOptionsDependsOn": [
                      "tableId"
                    ],
                    "loadOptionsMethod": "getTableFields"
                  }
                },
                {
                  "displayName": "Direction",
                  "name": "direction",
                  "type": "options",
                  "options": [
                    {
                      "name": "ASC",
                      "value": "",
                      "description": "Sort in ascending order"
                    },
                    {
                      "name": "DESC",
                      "value": "-",
                      "description": "Sort in descending order"
                    }
                  ],
                  "default": "",
                  "description": "Sort direction, either ascending or descending"
                }
              ]
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ]
        }
      }
    }
  ]

operations:
  [
    {
      "operation": "batchCreate",
      "name": "Batch Create",
      "description": "Create up to 200 rows in one request",
      "resource": "row"
    },
    {
      "operation": "batchDelete",
      "name": "Batch Delete",
      "description": "Delete up to 200 rows in one request",
      "resource": "row"
    },
    {
      "operation": "batchUpdate",
      "name": "Batch Update",
      "description": "Update up to 200 rows in one request",
      "resource": "row"
    },
    {
      "operation": "create",
      "name": "Create",
      "description": "Create a row",
      "resource": "row"
    },
    {
      "operation": "delete",
      "name": "Delete",
      "description": "Delete a row",
      "resource": "row"
    },
    {
      "operation": "get",
      "name": "Get",
      "description": "Retrieve a row",
      "resource": "row"
    },
    {
      "operation": "getAll",
      "name": "Get Many",
      "description": "Retrieve many rows",
      "resource": "row"
    },
    {
      "operation": "update",
      "name": "Update",
      "description": "Update a row",
      "resource": "row"
    }
  ]

credentials_required:
  [
    {
      "name": "baserowApi",
      "required": true,
      "displayOptions": {
        "show": {
          "authentication": [
            "usernamePassword"
          ]
        }
      }
    },
    {
      "name": "baserowTokenApi",
      "required": true,
      "displayOptions": {
        "show": {
          "authentication": [
            "databaseToken"
          ]
        }
      }
    }
  ]


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

output_names:
  [
  "Tool"
  ]

updated_at: 2026-07-16 12:10:22
tool_variant_of: nodes-base.beeminder
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: Beeminder node documentation
  description: Learn how to use the Beeminder node in n8n. Follow technical documentation to integrate Beeminder node into your workflows.
  contentType: [integration, reference]
  ---

  # Beeminder node

  Use the Beeminder node to automate work in Beeminder, and integrate Beeminder with other applications. n8n has built-in support for a wide range of Beeminder features, including creating, deleting, and updating data points.

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

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

  ## Operations

  **data point**
  - Create data point for a goal
  - Delete a data point
  - Get all data points for a goal
  - Update a data point

  ## Templates and examples

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

  --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 Beeminder"
    },
    {
      "displayName": "Authentication",
      "name": "authentication",
      "type": "options",
      "default": "apiToken",
      "options": [
        {
          "name": "API Token",
          "value": "apiToken"
        },
        {
          "name": "OAuth2",
          "value": "oAuth2"
        }
      ]
    },
    {
      "displayName": "Resource",
      "name": "resource",
      "type": "options",
      "default": "datapoint",
      "options": [
        {
          "name": "Charge",
          "value": "charge"
        },
        {
          "name": "Datapoint",
          "value": "datapoint"
        },
        {
          "name": "Goal",
          "value": "goal"
        },
        {
          "name": "User",
          "value": "user"
        }
      ],
      "required": true,
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create a charge",
          "action": "Create a charge"
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "charge"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create datapoint for goal",
          "action": "Create datapoint for goal"
        },
        {
          "name": "Create All",
          "value": "createAll",
          "description": "Create multiple datapoints at once",
          "action": "Create multiple datapoints at once"
        },
        {
          "name": "Delete",
          "value": "delete",
          "description": "Delete a datapoint",
          "action": "Delete a datapoint"
        },
        {
          "name": "Get",
          "value": "get",
          "description": "Get a single datapoint",
          "action": "Get a single datapoint"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get many datapoints for a goal",
          "action": "Get many datapoints for a goal"
        },
        {
          "name": "Update",
          "value": "update",
          "description": "Update a datapoint",
          "action": "Update a datapoint"
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "datapoint"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "get",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create a new goal",
          "action": "Create a new goal"
        },
        {
          "name": "Get",
          "value": "get",
          "description": "Get a specific goal",
          "action": "Get a specific goal"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get many goals",
          "action": "Get many goals"
        },
        {
          "name": "Get Archived",
          "value": "getArchived",
          "description": "Get archived goals",
          "action": "Get archived goals"
        },
        {
          "name": "Update",
          "value": "update",
          "description": "Update a goal",
          "action": "Update a goal"
        },
        {
          "name": "Refresh",
          "value": "refresh",
          "description": "Refresh goal data",
          "action": "Refresh goal data"
        },
        {
          "name": "Short Circuit",
          "value": "shortCircuit",
          "description": "Short circuit pledge",
          "action": "Short circuit pledge"
        },
        {
          "name": "Step Down",
          "value": "stepDown",
          "description": "Step down pledge",
          "action": "Step down pledge"
        },
        {
          "name": "Cancel Step Down",
          "value": "cancelStepDown",
          "action": "Cancel step down"
        },
        {
          "name": "Uncle",
          "value": "uncle",
          "description": "Derail a goal and charge the pledge amount",
          "action": "Derail a goal and charge the pledge amount"
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "goal"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "get",
      "options": [
        {
          "name": "Get",
          "value": "get",
          "description": "Get user information",
          "action": "Get user information"
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Goal Name or ID",
      "name": "goalName",
      "type": "options",
      "default": "",
      "description": "The name of the goal. 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": [
            "datapoint"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getGoals"
      }
    },
    {
      "displayName": "Goal Name or ID",
      "name": "goalName",
      "type": "options",
      "default": "",
      "description": "The name of the goal to derail. 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": [
            "goal"
          ],
          "operation": [
            "uncle"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getGoals"
      }
    },
    {
      "displayName": "Goal Name or ID",
      "name": "goalName",
      "type": "options",
      "default": "",
      "description": "The name of the goal. 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": [
            "goal"
          ],
          "operation": [
            "get",
            "update",
            "refresh",
            "shortCircuit",
            "stepDown",
            "cancelStepDown"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getGoals"
      }
    },
    {
      "displayName": "Amount",
      "name": "amount",
      "type": "number",
      "default": 0,
      "description": "Charge amount in USD",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "charge"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Datapoints",
      "name": "datapoints",
      "type": "json",
      "default": "[]",
      "description": "Array of datapoint objects to create. Each object should contain value and optionally timestamp, comment, etc.",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "datapoint"
          ],
          "operation": [
            "createAll"
          ]
        }
      }
    },
    {
      "displayName": "Goal Slug",
      "name": "slug",
      "type": "string",
      "default": "",
      "description": "Unique identifier for the goal",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "goal"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Goal Title",
      "name": "title",
      "type": "string",
      "default": "",
      "description": "Human-readable title for the goal",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "goal"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Goal Type",
      "name": "goal_type",
      "type": "options",
      "default": "hustler",
      "description": "Type of goal. <a href=\"https://api.beeminder.com/#attributes-2\">More info here.</a>.",
      "options": [
        {
          "name": "Hustler",
          "value": "hustler"
        },
        {
          "name": "Biker",
          "value": "biker"
        },
        {
          "name": "Fatloser",
          "value": "fatloser"
        },
        {
          "name": "Gainer",
          "value": "gainer"
        },
        {
          "name": "Inboxer",
          "value": "inboxer"
        },
        {
          "name": "Drinker",
          "value": "drinker"
        },
        {
          "name": "Custom",
          "value": "custom"
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "goal"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Goal Units",
      "name": "gunits",
      "type": "string",
      "default": "",
      "description": "Units for the goal (e.g., \"hours\", \"pages\", \"pounds\")",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "goal"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "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": [
            "datapoint"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 30,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "datapoint"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 300
      }
    },
    {
      "displayName": "Value",
      "name": "value",
      "type": "number",
      "default": 1,
      "description": "Datapoint value to send",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "datapoint"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Datapoint ID",
      "name": "datapointId",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "datapoint"
          ],
          "operation": [
            "update",
            "delete",
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Comment",
          "name": "comment",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Timestamp",
          "name": "timestamp",
          "type": "dateTime",
          "default": "",
          "placeholder": "",
          "description": "Defaults to \"now\" if none is passed in, or the existing timestamp if the datapoint is being updated rather than created"
        },
        {
          "displayName": "Request ID",
          "name": "requestid",
          "type": "string",
          "default": "",
          "placeholder": "",
          "description": "String to uniquely identify a datapoint"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "datapoint"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Note",
          "name": "note",
          "type": "string",
          "default": "",
          "description": "Charge explanation"
        },
        {
          "displayName": "Dry Run",
          "name": "dryrun",
          "type": "boolean",
          "default": false,
          "description": "Whether to test charge creation without actually charging"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "charge"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Goal Date",
          "name": "goaldate",
          "type": "dateTime",
          "default": null,
          "description": "Target date for the goal"
        },
        {
          "displayName": "Goal Value",
          "name": "goalval",
          "type": "number",
          "default": null,
          "description": "Target value for the goal"
        },
        {
          "displayName": "Rate",
          "name": "rate",
          "type": "number",
          "default": null,
          "description": "Rate of progress (units per day)"
        },
        {
          "displayName": "Initial Value",
          "name": "initval",
          "type": "number",
          "default": 0,
          "description": "Initial value for today's date"
        },
        {
          "displayName": "Secret",
          "name": "secret",
          "type": "boolean",
          "default": false,
          "description": "Whether the goal is secret"
        },
        {
          "displayName": "Data Public",
          "name": "datapublic",
          "type": "boolean",
          "default": false,
          "description": "Whether the data is public"
        },
        {
          "displayName": "Data Source",
          "name": "datasource",
          "type": "options",
          "options": [
            {
              "name": "API",
              "value": "api"
            },
            {
              "name": "IFTTT",
              "value": "ifttt"
            },
            {
              "name": "Zapier",
              "value": "zapier"
            },
            {
              "name": "Manual",
              "value": "manual"
            }
          ],
          "default": "manual",
          "description": "Data source for the goal"
        },
        {
          "displayName": "Dry Run",
          "name": "dryrun",
          "type": "boolean",
          "default": false,
          "description": "Whether to test the endpoint without actually creating a goal"
        },
        {
          "displayName": "Tags",
          "name": "tags",
          "type": "json",
          "default": "[]",
          "description": "Array of alphanumeric tags for the goal. Replaces existing tags.",
          "placeholder": "[\"tag1\", \"tag2\"]"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "goal"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Update Fields",
      "name": "updateFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Title",
          "name": "title",
          "type": "string",
          "default": "",
          "description": "Human-readable title for the goal"
        },
        {
          "displayName": "Y-Axis",
          "name": "yaxis",
          "type": "string",
          "default": "",
          "description": "Y-axis label for the goal graph"
        },
        {
          "displayName": "Tmin",
          "name": "tmin",
          "type": "string",
          "default": "",
          "placeholder": "yyyy-mm-dd",
          "description": "Minimum date for the goal in format yyyy-mm-dd"
        },
        {
          "displayName": "Tmax",
          "name": "tmax",
          "type": "string",
          "default": "",
          "placeholder": "yyyy-mm-dd",
          "description": "Maximum date for the goal in format yyyy-mm-dd"
        },
        {
          "displayName": "Secret",
          "name": "secret",
          "type": "boolean",
          "default": false,
          "description": "Whether the goal is secret"
        },
        {
          "displayName": "Data Public",
          "name": "datapublic",
          "type": "boolean",
          "default": false,
          "description": "Whether the data is public"
        },
        {
          "displayName": "Road All",
          "name": "roadall",
          "type": "json",
          "default": "[]",
          "description": "Array of arrays defining the bright red line. Each sub-array contains [date, value, rate] with exactly one field null.",
          "placeholder": "[[\"2023-01-01\", 0, null], [null, 100, 1]]"
        },
        {
          "displayName": "Data Source",
          "name": "datasource",
          "type": "options",
          "options": [
            {
              "name": "API",
              "value": "api"
            },
            {
              "name": "IFTTT",
              "value": "ifttt"
            },
            {
              "name": "Zapier",
              "value": "zapier"
            },
            {
              "name": "Manual",
              "value": ""
            }
          ],
          "default": "",
          "description": "Data source for the goal. Use empty string for manual entry."
        },
        {
          "displayName": "Tags",
          "name": "tags",
          "type": "json",
          "default": "[]",
          "description": "Array of alphanumeric tags for the goal. Replaces existing tags.",
          "placeholder": "[\"tag1\", \"tag2\"]"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "goal"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Include Datapoints",
          "name": "datapoints",
          "type": "boolean",
          "default": false,
          "description": "Whether to include datapoints in the response"
        },
        {
          "displayName": "Emaciated",
          "name": "emaciated",
          "type": "boolean",
          "default": false,
          "description": "Whether to include the goal attributes called road, roadall, and fullroad will be stripped from the goal object"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "goal"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Associations",
          "name": "associations",
          "type": "boolean",
          "default": false,
          "description": "Whether to include associations in the response"
        },
        {
          "displayName": "Diff Since",
          "name": "diff_since",
          "type": "dateTime",
          "default": null,
          "description": "Only goals and datapoints that have been created or updated since the timestamp will be returned"
        },
        {
          "displayName": "Skinny",
          "name": "skinny",
          "type": "boolean",
          "default": false,
          "description": "Whether to return minimal user data"
        },
        {
          "displayName": "Emaciated",
          "name": "emaciated",
          "type": "boolean",
          "default": false,
          "description": "Whether to include the goal attributes called road, roadall, and fullroad will be stripped from any goal objects returned with the user"
        },
        {
          "displayName": "Datapoints Count",
          "name": "datapoints_count",
          "type": "number",
          "default": null,
          "description": "Number of datapoints to include"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Emaciated",
          "name": "emaciated",
          "type": "boolean",
          "default": false,
          "description": "Whether to include the goal attributes called road, roadall, and fullroad will be stripped from the goal objects"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "goal"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Emaciated",
          "name": "emaciated",
          "type": "boolean",
          "default": false,
          "description": "Whether to include the goal attributes called road, roadall, and fullroad will be stripped from the goal objects"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "goal"
          ],
          "operation": [
            "getArchived"
          ]
        }
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Sort",
          "name": "sort",
          "type": "string",
          "default": "id",
          "placeholder": "",
          "description": "Attribute to sort on"
        },
        {
          "displayName": "Page",
          "name": "page",
          "type": "number",
          "displayOptions": {
            "show": {
              "/returnAll": [
                false
              ]
            }
          },
          "default": 1,
          "typeOptions": {
            "minValue": 1
          },
          "description": "Used to paginate results, 1-indexed, meaning page 1 is the first page"
        },
        {
          "displayName": "Per Page",
          "name": "per",
          "type": "number",
          "displayOptions": {
            "show": {
              "/returnAll": [
                false
              ]
            }
          },
          "default": 25,
          "typeOptions": {
            "minValue": 0
          },
          "description": "Number of results per page. Default 25. Ignored without page parameter. Must be non-negative"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "datapoint"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Update Fields",
      "name": "updateFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Value",
          "name": "value",
          "type": "number",
          "default": 1,
          "placeholder": "",
          "description": "Datapoint value to send"
        },
        {
          "displayName": "Comment",
          "name": "comment",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Timestamp",
          "name": "timestamp",
          "type": "dateTime",
          "default": "",
          "placeholder": "",
          "description": "Defaults to \"now\" if none is passed in, or the existing timestamp if the datapoint is being updated rather than created"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "datapoint"
          ],
          "operation": [
            "update"
          ]
        }
      }
    }
  ]

operations:
  [
    {
      "operation": "create",
      "name": "Create",
      "description": "Create a charge",
      "resource": "charge"
    },
    {
      "operation": "create",
      "name": "Create",
      "description": "Create datapoint for goal",
      "resource": "datapoint"
    },
    {
      "operation": "createAll",
      "name": "Create All",
      "description": "Create multiple datapoints at once",
      "resource": "datapoint"
    },
    {
      "operation": "delete",
      "name": "Delete",
      "description": "Delete a datapoint",
      "resource": "datapoint"
    },
    {
      "operation": "get",
      "name": "Get",
      "description": "Get a single datapoint",
      "resource": "datapoint"
    },
    {
      "operation": "getAll",
      "name": "Get Many",
      "description": "Get many datapoints for a goal",
      "resource": "datapoint"
    },
    {
      "operation": "update",
      "name": "Update",
      "description": "Update a datapoint",
      "resource": "datapoint"
    },
    {
      "operation": "create",
      "name": "Create",
      "description": "Create a new goal",
      "resource": "goal"
    },
    {
      "operation": "get",
      "name": "Get",
      "description": "Get a specific goal",
      "resource": "goal"
    },
    {
      "operation": "getAll",
      "name": "Get Many",
      "description": "Get many goals",
      "resource": "goal"
    },
    {
      "operation": "getArchived",
      "name": "Get Archived",
      "description": "Get archived goals",
      "resource": "goal"
    },
    {
      "operation": "update",
      "name": "Update",
      "description": "Update a goal",
      "resource": "goal"
    },
    {
      "operation": "refresh",
      "name": "Refresh",
      "description": "Refresh goal data",
      "resource": "goal"
    },
    {
      "operation": "shortCircuit",
      "name": "Short Circuit",
      "description": "Short circuit pledge",
      "resource": "goal"
    },
    {
      "operation": "stepDown",
      "name": "Step Down",
      "description": "Step down pledge",
      "resource": "goal"
    },
    {
      "operation": "cancelStepDown",
      "name": "Cancel Step Down",
      "resource": "goal"
    },
    {
      "operation": "uncle",
      "name": "Uncle",
      "description": "Derail a goal and charge the pledge amount",
      "resource": "goal"
    },
    {
      "operation": "get",
      "name": "Get",
      "description": "Get user information",
      "resource": "user"
    }
  ]

credentials_required:
  [
    {
      "name": "beeminderApi",
      "required": true,
      "displayOptions": {
        "show": {
          "authentication": [
            "apiToken"
          ]
        }
      }
    },
    {
      "name": "beeminderOAuth2Api",
      "required": true,
      "displayOptions": {
        "show": {
          "authentication": [
            "oAuth2"
          ]
        }
      }
    }
  ]


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

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

  # Beeminder node

  Use the Beeminder node to automate work in Beeminder, and integrate Beeminder with other applications. n8n has built-in support for a wide range of Beeminder features, including creating, deleting, and updating data points.

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

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

  ## Operations

  **data point**
  - Create data point for a goal
  - Delete a data point
  - Get all data points for a goal
  - Update a data point

  ## Templates and examples

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

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

properties_schema:
  [
    {
      "displayName": "Authentication",
      "name": "authentication",
      "type": "options",
      "default": "apiToken",
      "options": [
        {
          "name": "API Token",
          "value": "apiToken"
        },
        {
          "name": "OAuth2",
          "value": "oAuth2"
        }
      ]
    },
    {
      "displayName": "Resource",
      "name": "resource",
      "type": "options",
      "default": "datapoint",
      "options": [
        {
          "name": "Charge",
          "value": "charge"
        },
        {
          "name": "Datapoint",
          "value": "datapoint"
        },
        {
          "name": "Goal",
          "value": "goal"
        },
        {
          "name": "User",
          "value": "user"
        }
      ],
      "required": true,
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create a charge",
          "action": "Create a charge"
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "charge"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create datapoint for goal",
          "action": "Create datapoint for goal"
        },
        {
          "name": "Create All",
          "value": "createAll",
          "description": "Create multiple datapoints at once",
          "action": "Create multiple datapoints at once"
        },
        {
          "name": "Delete",
          "value": "delete",
          "description": "Delete a datapoint",
          "action": "Delete a datapoint"
        },
        {
          "name": "Get",
          "value": "get",
          "description": "Get a single datapoint",
          "action": "Get a single datapoint"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get many datapoints for a goal",
          "action": "Get many datapoints for a goal"
        },
        {
          "name": "Update",
          "value": "update",
          "description": "Update a datapoint",
          "action": "Update a datapoint"
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "datapoint"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "get",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create a new goal",
          "action": "Create a new goal"
        },
        {
          "name": "Get",
          "value": "get",
          "description": "Get a specific goal",
          "action": "Get a specific goal"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get many goals",
          "action": "Get many goals"
        },
        {
          "name": "Get Archived",
          "value": "getArchived",
          "description": "Get archived goals",
          "action": "Get archived goals"
        },
        {
          "name": "Update",
          "value": "update",
          "description": "Update a goal",
          "action": "Update a goal"
        },
        {
          "name": "Refresh",
          "value": "refresh",
          "description": "Refresh goal data",
          "action": "Refresh goal data"
        },
        {
          "name": "Short Circuit",
          "value": "shortCircuit",
          "description": "Short circuit pledge",
          "action": "Short circuit pledge"
        },
        {
          "name": "Step Down",
          "value": "stepDown",
          "description": "Step down pledge",
          "action": "Step down pledge"
        },
        {
          "name": "Cancel Step Down",
          "value": "cancelStepDown",
          "action": "Cancel step down"
        },
        {
          "name": "Uncle",
          "value": "uncle",
          "description": "Derail a goal and charge the pledge amount",
          "action": "Derail a goal and charge the pledge amount"
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "goal"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "get",
      "options": [
        {
          "name": "Get",
          "value": "get",
          "description": "Get user information",
          "action": "Get user information"
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Goal Name or ID",
      "name": "goalName",
      "type": "options",
      "default": "",
      "description": "The name of the goal. 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": [
            "datapoint"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getGoals"
      }
    },
    {
      "displayName": "Goal Name or ID",
      "name": "goalName",
      "type": "options",
      "default": "",
      "description": "The name of the goal to derail. 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": [
            "goal"
          ],
          "operation": [
            "uncle"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getGoals"
      }
    },
    {
      "displayName": "Goal Name or ID",
      "name": "goalName",
      "type": "options",
      "default": "",
      "description": "The name of the goal. 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": [
            "goal"
          ],
          "operation": [
            "get",
            "update",
            "refresh",
            "shortCircuit",
            "stepDown",
            "cancelStepDown"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getGoals"
      }
    },
    {
      "displayName": "Amount",
      "name": "amount",
      "type": "number",
      "default": 0,
      "description": "Charge amount in USD",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "charge"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Datapoints",
      "name": "datapoints",
      "type": "json",
      "default": "[]",
      "description": "Array of datapoint objects to create. Each object should contain value and optionally timestamp, comment, etc.",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "datapoint"
          ],
          "operation": [
            "createAll"
          ]
        }
      }
    },
    {
      "displayName": "Goal Slug",
      "name": "slug",
      "type": "string",
      "default": "",
      "description": "Unique identifier for the goal",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "goal"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Goal Title",
      "name": "title",
      "type": "string",
      "default": "",
      "description": "Human-readable title for the goal",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "goal"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Goal Type",
      "name": "goal_type",
      "type": "options",
      "default": "hustler",
      "description": "Type of goal. <a href=\"https://api.beeminder.com/#attributes-2\">More info here.</a>.",
      "options": [
        {
          "name": "Hustler",
          "value": "hustler"
        },
        {
          "name": "Biker",
          "value": "biker"
        },
        {
          "name": "Fatloser",
          "value": "fatloser"
        },
        {
          "name": "Gainer",
          "value": "gainer"
        },
        {
          "name": "Inboxer",
          "value": "inboxer"
        },
        {
          "name": "Drinker",
          "value": "drinker"
        },
        {
          "name": "Custom",
          "value": "custom"
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "goal"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Goal Units",
      "name": "gunits",
      "type": "string",
      "default": "",
      "description": "Units for the goal (e.g., \"hours\", \"pages\", \"pounds\")",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "goal"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "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": [
            "datapoint"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 30,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "datapoint"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 300
      }
    },
    {
      "displayName": "Value",
      "name": "value",
      "type": "number",
      "default": 1,
      "description": "Datapoint value to send",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "datapoint"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Datapoint ID",
      "name": "datapointId",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "datapoint"
          ],
          "operation": [
            "update",
            "delete",
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Comment",
          "name": "comment",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Timestamp",
          "name": "timestamp",
          "type": "dateTime",
          "default": "",
          "placeholder": "",
          "description": "Defaults to \"now\" if none is passed in, or the existing timestamp if the datapoint is being updated rather than created"
        },
        {
          "displayName": "Request ID",
          "name": "requestid",
          "type": "string",
          "default": "",
          "placeholder": "",
          "description": "String to uniquely identify a datapoint"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "datapoint"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Note",
          "name": "note",
          "type": "string",
          "default": "",
          "description": "Charge explanation"
        },
        {
          "displayName": "Dry Run",
          "name": "dryrun",
          "type": "boolean",
          "default": false,
          "description": "Whether to test charge creation without actually charging"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "charge"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Goal Date",
          "name": "goaldate",
          "type": "dateTime",
          "default": null,
          "description": "Target date for the goal"
        },
        {
          "displayName": "Goal Value",
          "name": "goalval",
          "type": "number",
          "default": null,
          "description": "Target value for the goal"
        },
        {
          "displayName": "Rate",
          "name": "rate",
          "type": "number",
          "default": null,
          "description": "Rate of progress (units per day)"
        },
        {
          "displayName": "Initial Value",
          "name": "initval",
          "type": "number",
          "default": 0,
          "description": "Initial value for today's date"
        },
        {
          "displayName": "Secret",
          "name": "secret",
          "type": "boolean",
          "default": false,
          "description": "Whether the goal is secret"
        },
        {
          "displayName": "Data Public",
          "name": "datapublic",
          "type": "boolean",
          "default": false,
          "description": "Whether the data is public"
        },
        {
          "displayName": "Data Source",
          "name": "datasource",
          "type": "options",
          "options": [
            {
              "name": "API",
              "value": "api"
            },
            {
              "name": "IFTTT",
              "value": "ifttt"
            },
            {
              "name": "Zapier",
              "value": "zapier"
            },
            {
              "name": "Manual",
              "value": "manual"
            }
          ],
          "default": "manual",
          "description": "Data source for the goal"
        },
        {
          "displayName": "Dry Run",
          "name": "dryrun",
          "type": "boolean",
          "default": false,
          "description": "Whether to test the endpoint without actually creating a goal"
        },
        {
          "displayName": "Tags",
          "name": "tags",
          "type": "json",
          "default": "[]",
          "description": "Array of alphanumeric tags for the goal. Replaces existing tags.",
          "placeholder": "[\"tag1\", \"tag2\"]"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "goal"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Update Fields",
      "name": "updateFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Title",
          "name": "title",
          "type": "string",
          "default": "",
          "description": "Human-readable title for the goal"
        },
        {
          "displayName": "Y-Axis",
          "name": "yaxis",
          "type": "string",
          "default": "",
          "description": "Y-axis label for the goal graph"
        },
        {
          "displayName": "Tmin",
          "name": "tmin",
          "type": "string",
          "default": "",
          "placeholder": "yyyy-mm-dd",
          "description": "Minimum date for the goal in format yyyy-mm-dd"
        },
        {
          "displayName": "Tmax",
          "name": "tmax",
          "type": "string",
          "default": "",
          "placeholder": "yyyy-mm-dd",
          "description": "Maximum date for the goal in format yyyy-mm-dd"
        },
        {
          "displayName": "Secret",
          "name": "secret",
          "type": "boolean",
          "default": false,
          "description": "Whether the goal is secret"
        },
        {
          "displayName": "Data Public",
          "name": "datapublic",
          "type": "boolean",
          "default": false,
          "description": "Whether the data is public"
        },
        {
          "displayName": "Road All",
          "name": "roadall",
          "type": "json",
          "default": "[]",
          "description": "Array of arrays defining the bright red line. Each sub-array contains [date, value, rate] with exactly one field null.",
          "placeholder": "[[\"2023-01-01\", 0, null], [null, 100, 1]]"
        },
        {
          "displayName": "Data Source",
          "name": "datasource",
          "type": "options",
          "options": [
            {
              "name": "API",
              "value": "api"
            },
            {
              "name": "IFTTT",
              "value": "ifttt"
            },
            {
              "name": "Zapier",
              "value": "zapier"
            },
            {
              "name": "Manual",
              "value": ""
            }
          ],
          "default": "",
          "description": "Data source for the goal. Use empty string for manual entry."
        },
        {
          "displayName": "Tags",
          "name": "tags",
          "type": "json",
          "default": "[]",
          "description": "Array of alphanumeric tags for the goal. Replaces existing tags.",
          "placeholder": "[\"tag1\", \"tag2\"]"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "goal"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Include Datapoints",
          "name": "datapoints",
          "type": "boolean",
          "default": false,
          "description": "Whether to include datapoints in the response"
        },
        {
          "displayName": "Emaciated",
          "name": "emaciated",
          "type": "boolean",
          "default": false,
          "description": "Whether to include the goal attributes called road, roadall, and fullroad will be stripped from the goal object"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "goal"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Associations",
          "name": "associations",
          "type": "boolean",
          "default": false,
          "description": "Whether to include associations in the response"
        },
        {
          "displayName": "Diff Since",
          "name": "diff_since",
          "type": "dateTime",
          "default": null,
          "description": "Only goals and datapoints that have been created or updated since the timestamp will be returned"
        },
        {
          "displayName": "Skinny",
          "name": "skinny",
          "type": "boolean",
          "default": false,
          "description": "Whether to return minimal user data"
        },
        {
          "displayName": "Emaciated",
          "name": "emaciated",
          "type": "boolean",
          "default": false,
          "description": "Whether to include the goal attributes called road, roadall, and fullroad will be stripped from any goal objects returned with the user"
        },
        {
          "displayName": "Datapoints Count",
          "name": "datapoints_count",
          "type": "number",
          "default": null,
          "description": "Number of datapoints to include"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Emaciated",
          "name": "emaciated",
          "type": "boolean",
          "default": false,
          "description": "Whether to include the goal attributes called road, roadall, and fullroad will be stripped from the goal objects"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "goal"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Emaciated",
          "name": "emaciated",
          "type": "boolean",
          "default": false,
          "description": "Whether to include the goal attributes called road, roadall, and fullroad will be stripped from the goal objects"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "goal"
          ],
          "operation": [
            "getArchived"
          ]
        }
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Sort",
          "name": "sort",
          "type": "string",
          "default": "id",
          "placeholder": "",
          "description": "Attribute to sort on"
        },
        {
          "displayName": "Page",
          "name": "page",
          "type": "number",
          "displayOptions": {
            "show": {
              "/returnAll": [
                false
              ]
            }
          },
          "default": 1,
          "typeOptions": {
            "minValue": 1
          },
          "description": "Used to paginate results, 1-indexed, meaning page 1 is the first page"
        },
        {
          "displayName": "Per Page",
          "name": "per",
          "type": "number",
          "displayOptions": {
            "show": {
              "/returnAll": [
                false
              ]
            }
          },
          "default": 25,
          "typeOptions": {
            "minValue": 0
          },
          "description": "Number of results per page. Default 25. Ignored without page parameter. Must be non-negative"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "datapoint"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Update Fields",
      "name": "updateFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Value",
          "name": "value",
          "type": "number",
          "default": 1,
          "placeholder": "",
          "description": "Datapoint value to send"
        },
        {
          "displayName": "Comment",
          "name": "comment",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Timestamp",
          "name": "timestamp",
          "type": "dateTime",
          "default": "",
          "placeholder": "",
          "description": "Defaults to \"now\" if none is passed in, or the existing timestamp if the datapoint is being updated rather than created"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "datapoint"
          ],
          "operation": [
            "update"
          ]
        }
      }
    }
  ]

operations:
  [
    {
      "operation": "create",
      "name": "Create",
      "description": "Create a charge",
      "resource": "charge"
    },
    {
      "operation": "create",
      "name": "Create",
      "description": "Create datapoint for goal",
      "resource": "datapoint"
    },
    {
      "operation": "createAll",
      "name": "Create All",
      "description": "Create multiple datapoints at once",
      "resource": "datapoint"
    },
    {
      "operation": "delete",
      "name": "Delete",
      "description": "Delete a datapoint",
      "resource": "datapoint"
    },
    {
      "operation": "get",
      "name": "Get",
      "description": "Get a single datapoint",
      "resource": "datapoint"
    },
    {
      "operation": "getAll",
      "name": "Get Many",
      "description": "Get many datapoints for a goal",
      "resource": "datapoint"
    },
    {
      "operation": "update",
      "name": "Update",
      "description": "Update a datapoint",
      "resource": "datapoint"
    },
    {
      "operation": "create",
      "name": "Create",
      "description": "Create a new goal",
      "resource": "goal"
    },
    {
      "operation": "get",
      "name": "Get",
      "description": "Get a specific goal",
      "resource": "goal"
    },
    {
      "operation": "getAll",
      "name": "Get Many",
      "description": "Get many goals",
      "resource": "goal"
    },
    {
      "operation": "getArchived",
      "name": "Get Archived",
      "description": "Get archived goals",
      "resource": "goal"
    },
    {
      "operation": "update",
      "name": "Update",
      "description": "Update a goal",
      "resource": "goal"
    },
    {
      "operation": "refresh",
      "name": "Refresh",
      "description": "Refresh goal data",
      "resource": "goal"
    },
    {
      "operation": "shortCircuit",
      "name": "Short Circuit",
      "description": "Short circuit pledge",
      "resource": "goal"
    },
    {
      "operation": "stepDown",
      "name": "Step Down",
      "description": "Step down pledge",
      "resource": "goal"
    },
    {
      "operation": "cancelStepDown",
      "name": "Cancel Step Down",
      "resource": "goal"
    },
    {
      "operation": "uncle",
      "name": "Uncle",
      "description": "Derail a goal and charge the pledge amount",
      "resource": "goal"
    },
    {
      "operation": "get",
      "name": "Get",
      "description": "Get user information",
      "resource": "user"
    }
  ]

credentials_required:
  [
    {
      "name": "beeminderApi",
      "required": true,
      "displayOptions": {
        "show": {
          "authentication": [
            "apiToken"
          ]
        }
      }
    },
    {
      "name": "beeminderOAuth2Api",
      "required": true,
      "displayOptions": {
        "show": {
          "authentication": [
            "oAuth2"
          ]
        }
      }
    }
  ]


node_type: nodes-base.bitbucketTrigger
package_name: n8n-nodes-base
display_name: Bitbucket Trigger
description: Handle Bitbucket events via webhooks
category: trigger
development_style: programmatic
version: 1.1
operations: []
outputs:
  [
  "main"
  ]

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

  # Bitbucket Trigger node

  [Bitbucket](https://bitbucket.org/){:target=_blank .external-link} is a web-based version control repository hosting service owned by Atlassian, for source code and development projects that use either Mercurial or Git revision control systems.

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

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

properties_schema:
  [
    {
      "displayName": "Authentication",
      "name": "authentication",
      "type": "options",
      "default": "password",
      "options": [
        {
          "name": "Password (Deprecated)",
          "value": "password"
        },
        {
          "name": "Access Token",
          "value": "accessToken"
        }
      ],
      "displayOptions": {
        "show": {
          "@version": [
            1
          ]
        }
      }
    },
    {
      "displayName": "Authentication",
      "name": "authentication",
      "type": "options",
      "default": "accessToken",
      "options": [
        {
          "name": "Password (Deprecated)",
          "value": "password"
        },
        {
          "name": "Access Token",
          "value": "accessToken"
        }
      ],
      "displayOptions": {
        "show": {
          "@version": [
            1.1
          ]
        }
      }
    },
    {
      "displayName": "Resource",
      "name": "resource",
      "type": "options",
      "default": "workspace",
      "options": [
        {
          "name": "Repository",
          "value": "repository"
        },
        {
          "name": "Workspace",
          "value": "workspace"
        }
      ],
      "required": true,
      "noDataExpression": true
    },
    {
      "displayName": "Workspace Name or ID",
      "name": "workspace",
      "type": "options",
      "default": "",
      "description": "The repository of which to listen to the events. 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": [
            "workspace",
            "repository"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getWorkspaces"
      }
    },
    {
      "displayName": "Event Names or IDs",
      "name": "events",
      "type": "multiOptions",
      "default": [],
      "description": "The events to listen to. Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
      "options": [],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "workspace"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getWorkspaceEvents"
      }
    },
    {
      "displayName": "Repository Name or ID",
      "name": "repository",
      "type": "options",
      "default": "",
      "description": "The repository of which to listen to the events. 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": [
            "repository"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getRepositories",
        "loadOptionsDependsOn": [
          "workspace"
        ]
      }
    },
    {
      "displayName": "Event Names or IDs",
      "name": "events",
      "type": "multiOptions",
      "default": [],
      "description": "The events to listen to. Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
      "options": [],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "repository"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getRepositoriesEvents"
      }
    }
  ]

credentials_required:
  [
    {
      "name": "bitbucketApi",
      "required": true,
      "testedBy": "bitbucketApiTest",
      "displayOptions": {
        "show": {
          "authentication": [
            "password"
          ]
        }
      }
    },
    {
      "name": "bitbucketAccessTokenApi",
      "required": true,
      "displayOptions": {
        "show": {
          "authentication": [
            "accessToken"
          ]
        }
      }
    }
  ]


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

output_names:
  [
  "Tool"
  ]

updated_at: 2026-07-16 12:10:22
tool_variant_of: nodes-base.bitly
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: Bitly node documentation
  description: Learn how to use the Bitly node in n8n. Follow technical documentation to integrate Bitly node into your workflows.
  contentType: [integration, reference]
  ---

  # Bitly node

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

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

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

  ## Operations

  * Link
      * Create a link
      * Get a link
      * Update a link

  ## Templates and examples

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

  --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 Bitly"
    },
    {
      "displayName": "Authentication",
      "name": "authentication",
      "type": "options",
      "default": "accessToken",
      "options": [
        {
          "name": "Access Token",
          "value": "accessToken"
        },
        {
          "name": "OAuth2",
          "value": "oAuth2"
        }
      ]
    },
    {
      "displayName": "Resource",
      "name": "resource",
      "type": "options",
      "default": "link",
      "options": [
        {
          "name": "Link",
          "value": "link"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create a link",
          "action": "Create a link"
        },
        {
          "name": "Get",
          "value": "get",
          "description": "Get a link",
          "action": "Get a link"
        },
        {
          "name": "Update",
          "value": "update",
          "description": "Update a link",
          "action": "Update a link"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "link"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Long URL",
      "name": "longUrl",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "link"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Domain",
          "name": "domain",
          "type": "string",
          "default": "bit.ly"
        },
        {
          "displayName": "Group Name or ID",
          "name": "group",
          "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": "getGroups"
          }
        },
        {
          "displayName": "Tag Names or IDs",
          "name": "tags",
          "type": "multiOptions",
          "description": "Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
          "default": [],
          "typeOptions": {
            "loadOptionsMethod": "getTags",
            "loadOptionsDependsOn": [
              "group"
            ]
          }
        },
        {
          "displayName": "Title",
          "name": "title",
          "type": "string",
          "default": ""
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "link"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Deeplinks",
      "name": "deeplink",
      "type": "fixedCollection",
      "default": {},
      "options": [
        {
          "name": "deeplinkUi",
          "displayName": "Deep Link",
          "values": [
            {
              "displayName": "App ID",
              "name": "appId",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "App URI Path",
              "name": "appUriPath",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "Install Type",
              "name": "installType",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "Install URL",
              "name": "installUrl",
              "type": "string",
              "default": ""
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "link"
          ],
          "operation": [
            "create"
          ]
        }
      },
      "typeOptions": {
        "multipleValues": true
      }
    },
    {
      "displayName": "Bitlink",
      "name": "id",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "link"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Update Fields",
      "name": "updateFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Archived",
          "name": "archived",
          "type": "boolean",
          "default": false
        },
        {
          "displayName": "Group Name or ID",
          "name": "group",
          "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": "getGroups"
          }
        },
        {
          "displayName": "Long URL",
          "name": "longUrl",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Tag Names or IDs",
          "name": "tags",
          "type": "multiOptions",
          "description": "Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
          "default": [],
          "typeOptions": {
            "loadOptionsMethod": "getTags",
            "loadOptionsDependsOn": [
              "group"
            ]
          }
        },
        {
          "displayName": "Title",
          "name": "title",
          "type": "string",
          "default": ""
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "link"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Deeplinks",
      "name": "deeplink",
      "type": "fixedCollection",
      "default": {},
      "options": [
        {
          "name": "deeplinkUi",
          "displayName": "Deep Link",
          "values": [
            {
              "displayName": "App ID",
              "name": "appId",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "App URI Path",
              "name": "appUriPath",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "Install Type",
              "name": "installType",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "Install URL",
              "name": "installUrl",
              "type": "string",
              "default": ""
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "link"
          ],
          "operation": [
            "update"
          ]
        }
      },
      "typeOptions": {
        "multipleValues": true
      }
    },
    {
      "displayName": "Bitlink",
      "name": "id",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "link"
          ],
          "operation": [
            "get"
          ]
        }
      }
    }
  ]

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

credentials_required:
  [
    {
      "name": "bitlyApi",
      "required": true,
      "displayOptions": {
        "show": {
          "authentication": [
            "accessToken"
          ]
        }
      }
    },
    {
      "name": "bitlyOAuth2Api",
      "required": true,
      "displayOptions": {
        "show": {
          "authentication": [
            "oAuth2"
          ]
        }
      }
    }
  ]


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

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

  # Bitly node

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

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

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

  ## Operations

  * Link
      * Create a link
      * Get a link
      * Update a link

  ## Templates and examples

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

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

properties_schema:
  [
    {
      "displayName": "Authentication",
      "name": "authentication",
      "type": "options",
      "default": "accessToken",
      "options": [
        {
          "name": "Access Token",
          "value": "accessToken"
        },
        {
          "name": "OAuth2",
          "value": "oAuth2"
        }
      ]
    },
    {
      "displayName": "Resource",
      "name": "resource",
      "type": "options",
      "default": "link",
      "options": [
        {
          "name": "Link",
          "value": "link"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create a link",
          "action": "Create a link"
        },
        {
          "name": "Get",
          "value": "get",
          "description": "Get a link",
          "action": "Get a link"
        },
        {
          "name": "Update",
          "value": "update",
          "description": "Update a link",
          "action": "Update a link"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "link"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Long URL",
      "name": "longUrl",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "link"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Domain",
          "name": "domain",
          "type": "string",
          "default": "bit.ly"
        },
        {
          "displayName": "Group Name or ID",
          "name": "group",
          "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": "getGroups"
          }
        },
        {
          "displayName": "Tag Names or IDs",
          "name": "tags",
          "type": "multiOptions",
          "description": "Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
          "default": [],
          "typeOptions": {
            "loadOptionsMethod": "getTags",
            "loadOptionsDependsOn": [
              "group"
            ]
          }
        },
        {
          "displayName": "Title",
          "name": "title",
          "type": "string",
          "default": ""
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "link"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Deeplinks",
      "name": "deeplink",
      "type": "fixedCollection",
      "default": {},
      "options": [
        {
          "name": "deeplinkUi",
          "displayName": "Deep Link",
          "values": [
            {
              "displayName": "App ID",
              "name": "appId",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "App URI Path",
              "name": "appUriPath",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "Install Type",
              "name": "installType",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "Install URL",
              "name": "installUrl",
              "type": "string",
              "default": ""
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "link"
          ],
          "operation": [
            "create"
          ]
        }
      },
      "typeOptions": {
        "multipleValues": true
      }
    },
    {
      "displayName": "Bitlink",
      "name": "id",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "link"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Update Fields",
      "name": "updateFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Archived",
          "name": "archived",
          "type": "boolean",
          "default": false
        },
        {
          "displayName": "Group Name or ID",
          "name": "group",
          "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": "getGroups"
          }
        },
        {
          "displayName": "Long URL",
          "name": "longUrl",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Tag Names or IDs",
          "name": "tags",
          "type": "multiOptions",
          "description": "Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
          "default": [],
          "typeOptions": {
            "loadOptionsMethod": "getTags",
            "loadOptionsDependsOn": [
              "group"
            ]
          }
        },
        {
          "displayName": "Title",
          "name": "title",
          "type": "string",
          "default": ""
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "link"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Deeplinks",
      "name": "deeplink",
      "type": "fixedCollection",
      "default": {},
      "options": [
        {
          "name": "deeplinkUi",
          "displayName": "Deep Link",
          "values": [
            {
              "displayName": "App ID",
              "name": "appId",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "App URI Path",
              "name": "appUriPath",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "Install Type",
              "name": "installType",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "Install URL",
              "name": "installUrl",
              "type": "string",
              "default": ""
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "link"
          ],
          "operation": [
            "update"
          ]
        }
      },
      "typeOptions": {
        "multipleValues": true
      }
    },
    {
      "displayName": "Bitlink",
      "name": "id",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "link"
          ],
          "operation": [
            "get"
          ]
        }
      }
    }
  ]

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

credentials_required:
  [
    {
      "name": "bitlyApi",
      "required": true,
      "displayOptions": {
        "show": {
          "authentication": [
            "accessToken"
          ]
        }
      }
    },
    {
      "name": "bitlyOAuth2Api",
      "required": true,
      "displayOptions": {
        "show": {
          "authentication": [
            "oAuth2"
          ]
        }
      }
    }
  ]


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

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

output_names:
  [
  "Tool"
  ]

updated_at: 2026-07-16 12:10:22
tool_variant_of: nodes-base.bitwarden
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: Bitwarden node documentation
  description: Learn how to use the Bitwarden node in n8n. Follow technical documentation to integrate Bitwarden node into your workflows.
  contentType: [integration, reference]
  ---

  # Bitwarden node

  Use the Bitwarden node to automate work in Bitwarden, and integrate Bitwarden with other applications. n8n has built-in support for a wide range of Bitwarden features, including creating, getting, deleting, and updating collections, events, groups, and members.

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

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

  ## Operations

  * Collection
      * Delete
      * Get
      * Get All
      * Update
  * Event
      * Get All
  * Group
      * Create
      * Delete
      * Get
      * Get All
      * Get Members
      * Update
      * Update Members
  * Member
      * Create
      * Delete
      * Get
      * Get All
      * Get Groups
      * Update
      * Update Groups

  ## Templates and examples

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

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 Bitwarden"
    },
    {
      "displayName": "Resource",
      "name": "resource",
      "type": "options",
      "default": "collection",
      "options": [
        {
          "name": "Collection",
          "value": "collection"
        },
        {
          "name": "Event",
          "value": "event"
        },
        {
          "name": "Group",
          "value": "group"
        },
        {
          "name": "Member",
          "value": "member"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "get",
      "options": [
        {
          "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": "Collection ID",
      "name": "collectionId",
      "type": "string",
      "default": "",
      "description": "The identifier of the collection",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "collection"
          ],
          "operation": [
            "delete",
            "get",
            "update"
          ]
        }
      }
    },
    {
      "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": 10,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "collection"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1
      }
    },
    {
      "displayName": "Update Fields",
      "name": "updateFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Group Names or IDs",
          "name": "groups",
          "type": "multiOptions",
          "description": "The group to assign this collection to. Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
          "default": [],
          "typeOptions": {
            "loadOptionsMethod": "getGroups"
          }
        },
        {
          "displayName": "External ID",
          "name": "externalId",
          "type": "string",
          "description": "The external identifier to set to this collection",
          "default": ""
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "collection"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "get",
      "options": [
        {
          "name": "Get Many",
          "value": "getAll",
          "action": "Get many events"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "event"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Return All",
      "name": "returnAll",
      "type": "boolean",
      "default": false,
      "description": "Whether to return all results or only up to a given limit",
      "displayOptions": {
        "show": {
          "resource": [
            "event"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 10,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "event"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1
      }
    },
    {
      "displayName": "Filters",
      "name": "filters",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Acting User ID",
          "name": "actingUserId",
          "type": "string",
          "default": "",
          "description": "The unique identifier of the acting user",
          "placeholder": "4a59c8c7-e05a-4d17-8e85-acc301343926"
        },
        {
          "displayName": "End Date",
          "name": "end",
          "type": "dateTime",
          "default": "",
          "description": "The end date for the search"
        },
        {
          "displayName": "Item ID",
          "name": "itemID",
          "type": "string",
          "default": "",
          "description": "The unique identifier of the item that the event describes",
          "placeholder": "5e59c8c7-e05a-4d17-8e85-acc301343926"
        },
        {
          "displayName": "Start Date",
          "name": "start",
          "type": "dateTime",
          "default": "",
          "description": "The start date for the search"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "event"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "get",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "action": "Create a group"
        },
        {
          "name": "Delete",
          "value": "delete",
          "action": "Delete a group"
        },
        {
          "name": "Get",
          "value": "get",
          "action": "Get a group"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "action": "Get many groups"
        },
        {
          "name": "Get Members",
          "value": "getMembers",
          "action": "Get group members"
        },
        {
          "name": "Update",
          "value": "update",
          "action": "Update a group"
        },
        {
          "name": "Update Members",
          "value": "updateMembers",
          "action": "Update group members"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "group"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Group ID",
      "name": "groupId",
      "type": "string",
      "default": "",
      "description": "The identifier of the group",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "group"
          ],
          "operation": [
            "delete",
            "get",
            "getMembers",
            "update",
            "updateMembers"
          ]
        }
      }
    },
    {
      "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": [
            "group"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 10,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "group"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1
      }
    },
    {
      "displayName": "Name",
      "name": "name",
      "type": "string",
      "default": "",
      "description": "The name of the group to create",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "group"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Access All",
      "name": "accessAll",
      "type": "boolean",
      "default": false,
      "description": "Whether to allow this group to access all collections within the organization, instead of only its associated collections. If set to true, this option overrides any collection assignments.",
      "displayOptions": {
        "show": {
          "resource": [
            "group"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Collection Names or IDs",
          "name": "collections",
          "type": "multiOptions",
          "description": "The collections to assign to this group. Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
          "default": [],
          "typeOptions": {
            "loadOptionsMethod": "getCollections"
          }
        },
        {
          "displayName": "External ID",
          "name": "externalId",
          "type": "string",
          "description": "The external identifier to set to this group",
          "default": ""
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "group"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Update Fields",
      "name": "updateFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Access All",
          "name": "accessAll",
          "type": "boolean",
          "default": false,
          "description": "Whether to allow this group to access all collections within the organization, instead of only its associated collections. If set to true, this option overrides any collection assignments."
        },
        {
          "displayName": "Collection Names or IDs",
          "name": "collections",
          "type": "multiOptions",
          "description": "The collections to assign to this group. Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
          "default": [],
          "typeOptions": {
            "loadOptionsMethod": "getCollections"
          }
        },
        {
          "displayName": "External ID",
          "name": "externalId",
          "type": "string",
          "description": "The external identifier to set to this group",
          "default": ""
        },
        {
          "displayName": "Name",
          "name": "name",
          "type": "string",
          "default": "",
          "description": "The name of the group to update"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "group"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Member IDs",
      "name": "memberIds",
      "type": "string",
      "default": "",
      "description": "Comma-separated list of IDs of members to set in a group",
      "displayOptions": {
        "show": {
          "resource": [
            "group"
          ],
          "operation": [
            "updateMembers"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "get",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "action": "Create a member"
        },
        {
          "name": "Delete",
          "value": "delete",
          "action": "Delete a member"
        },
        {
          "name": "Get",
          "value": "get",
          "action": "Get a member"
        },
        {
          "name": "Get Groups",
          "value": "getGroups",
          "action": "Get groups for a member"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "action": "Get many members"
        },
        {
          "name": "Update",
          "value": "update",
          "action": "Update a member"
        },
        {
          "name": "Update Groups",
          "value": "updateGroups",
          "action": "Update groups for a member"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "member"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Member ID",
      "name": "memberId",
      "type": "string",
      "default": "",
      "description": "The identifier of the member",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "member"
          ],
          "operation": [
            "delete",
            "get",
            "getGroups",
            "update",
            "updateGroups"
          ]
        }
      }
    },
    {
      "displayName": "Type",
      "name": "type",
      "type": "options",
      "default": 2,
      "options": [
        {
          "name": "Owner",
          "value": 0
        },
        {
          "name": "Admin",
          "value": 1
        },
        {
          "name": "User",
          "value": 2
        },
        {
          "name": "Manager",
          "value": 3
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "member"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "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": [
            "member"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 10,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "member"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1
      }
    },
    {
      "displayName": "Email",
      "name": "email",
      "type": "string",
      "default": "",
      "description": "The email of the member to update",
      "displayOptions": {
        "show": {
          "resource": [
            "member"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Access All",
      "name": "accessAll",
      "type": "boolean",
      "default": false,
      "displayOptions": {
        "show": {
          "resource": [
            "member"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Collection Names or IDs",
          "name": "collections",
          "type": "multiOptions",
          "description": "The collections to assign to this member. Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
          "default": [],
          "typeOptions": {
            "loadOptionsMethod": "getCollections"
          }
        },
        {
          "displayName": "External ID",
          "name": "externalId",
          "type": "string",
          "description": "The external identifier to set to this member",
          "default": ""
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "member"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Update Fields",
      "name": "updateFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Type",
          "name": "type",
          "type": "options",
          "default": {},
          "options": [
            {
              "name": "Owner",
              "value": 0
            },
            {
              "name": "Admin",
              "value": 1
            },
            {
              "name": "User",
              "value": 2
            },
            {
              "name": "Manager",
              "value": 3
            }
          ]
        },
        {
          "displayName": "Collection Names or IDs",
          "name": "collections",
          "type": "multiOptions",
          "description": "The collections to assign to this member. Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
          "default": [],
          "typeOptions": {
            "loadOptionsMethod": "getCollections"
          }
        },
        {
          "displayName": "External ID",
          "name": "externalId",
          "type": "string",
          "description": "The external identifier to set to this member",
          "default": ""
        },
        {
          "displayName": "Access All",
          "name": "accessAll",
          "type": "boolean",
          "default": false
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "member"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Group IDs",
      "name": "groupIds",
      "type": "string",
      "default": "",
      "description": "Comma-separated list of IDs of groups to set for a member",
      "displayOptions": {
        "show": {
          "resource": [
            "member"
          ],
          "operation": [
            "updateGroups"
          ]
        }
      }
    }
  ]

operations:
  [
    {
      "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": "getAll",
      "name": "Get Many",
      "resource": "event"
    },
    {
      "operation": "create",
      "name": "Create",
      "resource": "group"
    },
    {
      "operation": "delete",
      "name": "Delete",
      "resource": "group"
    },
    {
      "operation": "get",
      "name": "Get",
      "resource": "group"
    },
    {
      "operation": "getAll",
      "name": "Get Many",
      "resource": "group"
    },
    {
      "operation": "getMembers",
      "name": "Get Members",
      "resource": "group"
    },
    {
      "operation": "update",
      "name": "Update",
      "resource": "group"
    },
    {
      "operation": "updateMembers",
      "name": "Update Members",
      "resource": "group"
    },
    {
      "operation": "create",
      "name": "Create",
      "resource": "member"
    },
    {
      "operation": "delete",
      "name": "Delete",
      "resource": "member"
    },
    {
      "operation": "get",
      "name": "Get",
      "resource": "member"
    },
    {
      "operation": "getGroups",
      "name": "Get Groups",
      "resource": "member"
    },
    {
      "operation": "getAll",
      "name": "Get Many",
      "resource": "member"
    },
    {
      "operation": "update",
      "name": "Update",
      "resource": "member"
    },
    {
      "operation": "updateGroups",
      "name": "Update Groups",
      "resource": "member"
    }
  ]


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

outputs:
  [
  "main"
  ]

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

  # Bitwarden node

  Use the Bitwarden node to automate work in Bitwarden, and integrate Bitwarden with other applications. n8n has built-in support for a wide range of Bitwarden features, including creating, getting, deleting, and updating collections, events, groups, and members.

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

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

  ## Operations

  * Collection
      * Delete
      * Get
      * Get All
      * Update
  * Event
      * Get All
  * Group
      * Create
      * Delete
      * Get
      * Get All
      * Get Members
      * Update
      * Update Members
  * Member
      * Create
      * Delete
      * Get
      * Get All
      * Get Groups
      * Update
      * Update Groups

  ## Templates and examples

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

properties_schema:
  [
    {
      "displayName": "Resource",
      "name": "resource",
      "type": "options",
      "default": "collection",
      "options": [
        {
          "name": "Collection",
          "value": "collection"
        },
        {
          "name": "Event",
          "value": "event"
        },
        {
          "name": "Group",
          "value": "group"
        },
        {
          "name": "Member",
          "value": "member"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "get",
      "options": [
        {
          "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": "Collection ID",
      "name": "collectionId",
      "type": "string",
      "default": "",
      "description": "The identifier of the collection",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "collection"
          ],
          "operation": [
            "delete",
            "get",
            "update"
          ]
        }
      }
    },
    {
      "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": 10,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "collection"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1
      }
    },
    {
      "displayName": "Update Fields",
      "name": "updateFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Group Names or IDs",
          "name": "groups",
          "type": "multiOptions",
          "description": "The group to assign this collection to. Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
          "default": [],
          "typeOptions": {
            "loadOptionsMethod": "getGroups"
          }
        },
        {
          "displayName": "External ID",
          "name": "externalId",
          "type": "string",
          "description": "The external identifier to set to this collection",
          "default": ""
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "collection"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "get",
      "options": [
        {
          "name": "Get Many",
          "value": "getAll",
          "action": "Get many events"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "event"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Return All",
      "name": "returnAll",
      "type": "boolean",
      "default": false,
      "description": "Whether to return all results or only up to a given limit",
      "displayOptions": {
        "show": {
          "resource": [
            "event"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 10,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "event"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1
      }
    },
    {
      "displayName": "Filters",
      "name": "filters",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Acting User ID",
          "name": "actingUserId",
          "type": "string",
          "default": "",
          "description": "The unique identifier of the acting user",
          "placeholder": "4a59c8c7-e05a-4d17-8e85-acc301343926"
        },
        {
          "displayName": "End Date",
          "name": "end",
          "type": "dateTime",
          "default": "",
          "description": "The end date for the search"
        },
        {
          "displayName": "Item ID",
          "name": "itemID",
          "type": "string",
          "default": "",
          "description": "The unique identifier of the item that the event describes",
          "placeholder": "5e59c8c7-e05a-4d17-8e85-acc301343926"
        },
        {
          "displayName": "Start Date",
          "name": "start",
          "type": "dateTime",
          "default": "",
          "description": "The start date for the search"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "event"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "get",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "action": "Create a group"
        },
        {
          "name": "Delete",
          "value": "delete",
          "action": "Delete a group"
        },
        {
          "name": "Get",
          "value": "get",
          "action": "Get a group"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "action": "Get many groups"
        },
        {
          "name": "Get Members",
          "value": "getMembers",
          "action": "Get group members"
        },
        {
          "name": "Update",
          "value": "update",
          "action": "Update a group"
        },
        {
          "name": "Update Members",
          "value": "updateMembers",
          "action": "Update group members"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "group"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Group ID",
      "name": "groupId",
      "type": "string",
      "default": "",
      "description": "The identifier of the group",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "group"
          ],
          "operation": [
            "delete",
            "get",
            "getMembers",
            "update",
            "updateMembers"
          ]
        }
      }
    },
    {
      "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": [
            "group"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 10,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "group"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1
      }
    },
    {
      "displayName": "Name",
      "name": "name",
      "type": "string",
      "default": "",
      "description": "The name of the group to create",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "group"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Access All",
      "name": "accessAll",
      "type": "boolean",
      "default": false,
      "description": "Whether to allow this group to access all collections within the organization, instead of only its associated collections. If set to true, this option overrides any collection assignments.",
      "displayOptions": {
        "show": {
          "resource": [
            "group"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Collection Names or IDs",
          "name": "collections",
          "type": "multiOptions",
          "description": "The collections to assign to this group. Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
          "default": [],
          "typeOptions": {
            "loadOptionsMethod": "getCollections"
          }
        },
        {
          "displayName": "External ID",
          "name": "externalId",
          "type": "string",
          "description": "The external identifier to set to this group",
          "default": ""
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "group"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Update Fields",
      "name": "updateFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Access All",
          "name": "accessAll",
          "type": "boolean",
          "default": false,
          "description": "Whether to allow this group to access all collections within the organization, instead of only its associated collections. If set to true, this option overrides any collection assignments."
        },
        {
          "displayName": "Collection Names or IDs",
          "name": "collections",
          "type": "multiOptions",
          "description": "The collections to assign to this group. Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
          "default": [],
          "typeOptions": {
            "loadOptionsMethod": "getCollections"
          }
        },
        {
          "displayName": "External ID",
          "name": "externalId",
          "type": "string",
          "description": "The external identifier to set to this group",
          "default": ""
        },
        {
          "displayName": "Name",
          "name": "name",
          "type": "string",
          "default": "",
          "description": "The name of the group to update"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "group"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Member IDs",
      "name": "memberIds",
      "type": "string",
      "default": "",
      "description": "Comma-separated list of IDs of members to set in a group",
      "displayOptions": {
        "show": {
          "resource": [
            "group"
          ],
          "operation": [
            "updateMembers"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "get",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "action": "Create a member"
        },
        {
          "name": "Delete",
          "value": "delete",
          "action": "Delete a member"
        },
        {
          "name": "Get",
          "value": "get",
          "action": "Get a member"
        },
        {
          "name": "Get Groups",
          "value": "getGroups",
          "action": "Get groups for a member"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "action": "Get many members"
        },
        {
          "name": "Update",
          "value": "update",
          "action": "Update a member"
        },
        {
          "name": "Update Groups",
          "value": "updateGroups",
          "action": "Update groups for a member"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "member"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Member ID",
      "name": "memberId",
      "type": "string",
      "default": "",
      "description": "The identifier of the member",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "member"
          ],
          "operation": [
            "delete",
            "get",
            "getGroups",
            "update",
            "updateGroups"
          ]
        }
      }
    },
    {
      "displayName": "Type",
      "name": "type",
      "type": "options",
      "default": 2,
      "options": [
        {
          "name": "Owner",
          "value": 0
        },
        {
          "name": "Admin",
          "value": 1
        },
        {
          "name": "User",
          "value": 2
        },
        {
          "name": "Manager",
          "value": 3
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "member"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "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": [
            "member"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 10,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "member"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1
      }
    },
    {
      "displayName": "Email",
      "name": "email",
      "type": "string",
      "default": "",
      "description": "The email of the member to update",
      "displayOptions": {
        "show": {
          "resource": [
            "member"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Access All",
      "name": "accessAll",
      "type": "boolean",
      "default": false,
      "displayOptions": {
        "show": {
          "resource": [
            "member"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Collection Names or IDs",
          "name": "collections",
          "type": "multiOptions",
          "description": "The collections to assign to this member. Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
          "default": [],
          "typeOptions": {
            "loadOptionsMethod": "getCollections"
          }
        },
        {
          "displayName": "External ID",
          "name": "externalId",
          "type": "string",
          "description": "The external identifier to set to this member",
          "default": ""
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "member"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Update Fields",
      "name": "updateFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Type",
          "name": "type",
          "type": "options",
          "default": {},
          "options": [
            {
              "name": "Owner",
              "value": 0
            },
            {
              "name": "Admin",
              "value": 1
            },
            {
              "name": "User",
              "value": 2
            },
            {
              "name": "Manager",
              "value": 3
            }
          ]
        },
        {
          "displayName": "Collection Names or IDs",
          "name": "collections",
          "type": "multiOptions",
          "description": "The collections to assign to this member. Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
          "default": [],
          "typeOptions": {
            "loadOptionsMethod": "getCollections"
          }
        },
        {
          "displayName": "External ID",
          "name": "externalId",
          "type": "string",
          "description": "The external identifier to set to this member",
          "default": ""
        },
        {
          "displayName": "Access All",
          "name": "accessAll",
          "type": "boolean",
          "default": false
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "member"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Group IDs",
      "name": "groupIds",
      "type": "string",
      "default": "",
      "description": "Comma-separated list of IDs of groups to set for a member",
      "displayOptions": {
        "show": {
          "resource": [
            "member"
          ],
          "operation": [
            "updateGroups"
          ]
        }
      }
    }
  ]

operations:
  [
    {
      "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": "getAll",
      "name": "Get Many",
      "resource": "event"
    },
    {
      "operation": "create",
      "name": "Create",
      "resource": "group"
    },
    {
      "operation": "delete",
      "name": "Delete",
      "resource": "group"
    },
    {
      "operation": "get",
      "name": "Get",
      "resource": "group"
    },
    {
      "operation": "getAll",
      "name": "Get Many",
      "resource": "group"
    },
    {
      "operation": "getMembers",
      "name": "Get Members",
      "resource": "group"
    },
    {
      "operation": "update",
      "name": "Update",
      "resource": "group"
    },
    {
      "operation": "updateMembers",
      "name": "Update Members",
      "resource": "group"
    },
    {
      "operation": "create",
      "name": "Create",
      "resource": "member"
    },
    {
      "operation": "delete",
      "name": "Delete",
      "resource": "member"
    },
    {
      "operation": "get",
      "name": "Get",
      "resource": "member"
    },
    {
      "operation": "getGroups",
      "name": "Get Groups",
      "resource": "member"
    },
    {
      "operation": "getAll",
      "name": "Get Many",
      "resource": "member"
    },
    {
      "operation": "update",
      "name": "Update",
      "resource": "member"
    },
    {
      "operation": "updateGroups",
      "name": "Update Groups",
      "resource": "member"
    }
  ]


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

outputs:
  [
  "main"
  ]

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

  # Box node

  Use the Box node to automate work in Box, and integrate Box with other applications. n8n has built-in support for a wide range of Box features, including creating, copying, deleting, searching, uploading, and downloading files and folders.

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

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

  ## Operations

  * File
      * Copy a file
      * Delete a file
      * Download a file
      * Get a file
      * Search files
      * Share a file
      * Upload a file
  * Folder
      * Create a folder
      * Get a folder
      * Delete a folder
      * Search files
      * Share a folder
      * Update folder

  ## Templates and examples

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

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

properties_schema:
  [
    {
      "displayName": "Resource",
      "name": "resource",
      "type": "options",
      "default": "file",
      "options": [
        {
          "name": "File",
          "value": "file"
        },
        {
          "name": "Folder",
          "value": "folder"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "upload",
      "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",
          "value": "get",
          "description": "Get a file",
          "action": "Get a file"
        },
        {
          "name": "Search",
          "value": "search",
          "description": "Search files",
          "action": "Search a file"
        },
        {
          "name": "Share",
          "value": "share",
          "description": "Share a file",
          "action": "Share a file"
        },
        {
          "name": "Upload",
          "value": "upload",
          "description": "Upload a file",
          "action": "Upload a file"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "file"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "File ID",
      "name": "fileId",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "copy"
          ],
          "resource": [
            "file"
          ]
        }
      }
    },
    {
      "displayName": "Parent ID",
      "name": "parentId",
      "type": "string",
      "default": "",
      "description": "The ID of folder to copy the file to. If not defined will be copied to the root folder.",
      "displayOptions": {
        "show": {
          "operation": [
            "copy"
          ],
          "resource": [
            "file"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Fields",
          "name": "fields",
          "type": "string",
          "default": "",
          "description": "A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response."
        },
        {
          "displayName": "Name",
          "name": "name",
          "type": "string",
          "default": "",
          "description": "An optional new name for the copied file"
        },
        {
          "displayName": "Version",
          "name": "version",
          "type": "string",
          "default": "",
          "description": "An optional ID of the specific file version to copy"
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "copy"
          ],
          "resource": [
            "file"
          ]
        }
      }
    },
    {
      "displayName": "File ID",
      "name": "fileId",
      "type": "string",
      "default": "",
      "description": "Field ID",
      "displayOptions": {
        "show": {
          "operation": [
            "delete"
          ],
          "resource": [
            "file"
          ]
        }
      }
    },
    {
      "displayName": "File ID",
      "name": "fileId",
      "type": "string",
      "default": "",
      "displayOptions": {
        "show": {
          "operation": [
            "download"
          ],
          "resource": [
            "file"
          ]
        }
      }
    },
    {
      "displayName": "Put Output File in Field",
      "name": "binaryPropertyName",
      "type": "string",
      "default": "data",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "download"
          ],
          "resource": [
            "file"
          ]
        }
      }
    },
    {
      "displayName": "File ID",
      "name": "fileId",
      "type": "string",
      "default": "",
      "description": "Field ID",
      "displayOptions": {
        "show": {
          "operation": [
            "get"
          ],
          "resource": [
            "file"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Fields",
          "name": "fields",
          "type": "string",
          "default": "",
          "description": "A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response."
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "get"
          ],
          "resource": [
            "file"
          ]
        }
      }
    },
    {
      "displayName": "Query",
      "name": "query",
      "type": "string",
      "default": "",
      "description": "The string to search for. This query is matched against item names, descriptions, text content of files, and various other fields of the different item types.",
      "displayOptions": {
        "show": {
          "operation": [
            "search"
          ],
          "resource": [
            "file"
          ]
        }
      }
    },
    {
      "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": [
            "file"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 100,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "operation": [
            "search"
          ],
          "resource": [
            "file"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 500
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Content Types",
          "name": "contet_types",
          "type": "string",
          "default": "",
          "description": "Limits search results to items with the given content types. Content types are defined as a comma-separated lists of Box recognized content types."
        },
        {
          "displayName": "Created At Range",
          "name": "createdRangeUi",
          "type": "fixedCollection",
          "typeOptions": {
            "multipleValues": false
          },
          "placeholder": "Add Range",
          "default": {},
          "options": [
            {
              "displayName": "Range",
              "name": "createdRangeValuesUi",
              "values": [
                {
                  "displayName": "From",
                  "name": "from",
                  "type": "dateTime",
                  "default": ""
                },
                {
                  "displayName": "To",
                  "name": "to",
                  "type": "dateTime",
                  "default": ""
                }
              ]
            }
          ]
        },
        {
          "displayName": "Direction",
          "name": "direction",
          "type": "options",
          "options": [
            {
              "name": "ASC",
              "value": "ASC"
            },
            {
              "name": "DESC",
              "value": "DESC"
            }
          ],
          "default": "",
          "description": "Defines the direction in which search results are ordered. Default value is DESC."
        },
        {
          "displayName": "Fields",
          "name": "fields",
          "type": "string",
          "default": "",
          "description": "A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response."
        },
        {
          "displayName": "File Extensions",
          "name": "file_extensions",
          "type": "string",
          "default": "",
          "placeholder": "pdf,png,gif",
          "description": "Limits search results to a comma-separated list of file extensions"
        },
        {
          "displayName": "Folder IDs",
          "name": "ancestor_folder_ids",
          "type": "string",
          "default": "",
          "description": "Limits search results to items within the given list of folders. Folders are defined as a comma-separated lists of folder IDs."
        },
        {
          "displayName": "Scope",
          "name": "scope",
          "type": "options",
          "options": [
            {
              "name": "User Content",
              "value": "user_content"
            },
            {
              "name": "Enterprise Content",
              "value": "enterprise_content"
            }
          ],
          "default": "",
          "description": "Limits search results to a user scope"
        },
        {
          "displayName": "Size Range",
          "name": "size_range",
          "type": "string",
          "default": "",
          "placeholder": "1000000,5000000",
          "description": "Limits search results to items within a given file size range. File size ranges are defined as comma-separated byte sizes."
        },
        {
          "displayName": "Sort",
          "name": "sort",
          "type": "options",
          "options": [
            {
              "name": "Relevance",
              "value": "relevance"
            },
            {
              "name": "Modified At",
              "value": "modified_at"
            }
          ],
          "default": "relevance",
          "description": "Returns the results ordered in descending order by date at which the item was last modified"
        },
        {
          "displayName": "Trash Content",
          "name": "trash_content",
          "type": "options",
          "options": [
            {
              "name": "Non Trashed Only",
              "value": "non_trashed_only"
            },
            {
              "name": "Trashed Only",
              "value": "trashed_only"
            }
          ],
          "default": "non_trashed_only",
          "description": "Controls if search results include the trash"
        },
        {
          "displayName": "Update At Range",
          "name": "updatedRangeUi",
          "type": "fixedCollection",
          "typeOptions": {
            "multipleValues": false
          },
          "placeholder": "Add Range",
          "default": {},
          "options": [
            {
              "displayName": "Range",
              "name": "updatedRangeValuesUi",
              "values": [
                {
                  "displayName": "From",
                  "name": "from",
                  "type": "dateTime",
                  "default": ""
                },
                {
                  "displayName": "To",
                  "name": "to",
                  "type": "dateTime",
                  "default": ""
                }
              ]
            }
          ]
        },
        {
          "displayName": "User IDs",
          "name": "owner_user_ids",
          "type": "string",
          "default": "",
          "description": "Limits search results to items owned by the given list of owners. Owners are defined as a comma-separated list of user IDs."
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "search"
          ],
          "resource": [
            "file"
          ]
        }
      }
    },
    {
      "displayName": "File ID",
      "name": "fileId",
      "type": "string",
      "default": "",
      "description": "The ID of the file to share",
      "displayOptions": {
        "show": {
          "operation": [
            "share"
          ],
          "resource": [
            "file"
          ]
        }
      }
    },
    {
      "displayName": "Accessible By",
      "name": "accessibleBy",
      "type": "options",
      "default": "",
      "description": "The type of object the file will be shared with",
      "options": [
        {
          "name": "Group",
          "value": "group"
        },
        {
          "name": "User",
          "value": "user"
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "share"
          ],
          "resource": [
            "file"
          ]
        }
      }
    },
    {
      "displayName": "Use Email",
      "name": "useEmail",
      "type": "boolean",
      "default": true,
      "description": "Whether identify the user by email or ID",
      "displayOptions": {
        "show": {
          "operation": [
            "share"
          ],
          "resource": [
            "file"
          ],
          "accessibleBy": [
            "user"
          ]
        }
      }
    },
    {
      "displayName": "Email",
      "name": "email",
      "type": "string",
      "default": "",
      "description": "The user's email address to share the file with",
      "displayOptions": {
        "show": {
          "operation": [
            "share"
          ],
          "resource": [
            "file"
          ],
          "useEmail": [
            true
          ],
          "accessibleBy": [
            "user"
          ]
        }
      }
    },
    {
      "displayName": "User ID",
      "name": "userId",
      "type": "string",
      "default": "",
      "description": "The user's ID to share the file with",
      "displayOptions": {
        "show": {
          "operation": [
            "share"
          ],
          "resource": [
            "file"
          ],
          "useEmail": [
            false
          ],
          "accessibleBy": [
            "user"
          ]
        }
      }
    },
    {
      "displayName": "Group ID",
      "name": "groupId",
      "type": "string",
      "default": "",
      "description": "The group's ID to share the file with",
      "displayOptions": {
        "show": {
          "operation": [
            "share"
          ],
          "resource": [
            "file"
          ],
          "accessibleBy": [
            "group"
          ]
        }
      }
    },
    {
      "displayName": "Role",
      "name": "role",
      "type": "options",
      "default": "editor",
      "description": "The level of access granted",
      "options": [
        {
          "name": "Co-Owner",
          "value": "coOwner",
          "description": "A Co-owner has all of functional read/write access that an editor does"
        },
        {
          "name": "Editor",
          "value": "editor",
          "description": "An editor has full read/write access to a folder or file"
        },
        {
          "name": "Previewer",
          "value": "previewer",
          "description": "A previewer has limited read access"
        },
        {
          "name": "Previewer Uploader",
          "value": "previewerUploader",
          "description": "This access level is a combination of Previewer and Uploader"
        },
        {
          "name": "Uploader",
          "value": "uploader",
          "description": "An uploader has limited write access"
        },
        {
          "name": "Viewer",
          "value": "viewer",
          "description": "A viewer has read access to a folder or file"
        },
        {
          "name": "Viewer Uploader",
          "value": "viewerUploader",
          "description": "This access level is a combination of Viewer and Uploader"
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "share"
          ],
          "resource": [
            "file"
          ]
        }
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Can View Path",
          "name": "can_view_path",
          "type": "boolean",
          "default": false,
          "description": "Whether the invited users can see the entire parent path to the associated folder. The user will not gain privileges in any parent folder and therefore cannot see content the user is not collaborated on."
        },
        {
          "displayName": "Expires At",
          "name": "expires_at",
          "type": "dateTime",
          "default": "",
          "description": "Set the expiration date for the collaboration. At this date, the collaboration will be automatically removed from the item."
        },
        {
          "displayName": "Fields",
          "name": "fields",
          "type": "string",
          "default": "",
          "description": "A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response."
        },
        {
          "displayName": "Notify",
          "name": "notify",
          "type": "boolean",
          "default": false,
          "description": "Whether if users should receive email notification for the action performed"
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "share"
          ],
          "resource": [
            "file"
          ]
        }
      }
    },
    {
      "displayName": "File Name",
      "name": "fileName",
      "type": "string",
      "default": "",
      "description": "The name the file should be saved as",
      "displayOptions": {
        "show": {
          "operation": [
            "upload"
          ],
          "resource": [
            "file"
          ]
        }
      }
    },
    {
      "displayName": "Binary File",
      "name": "binaryData",
      "type": "boolean",
      "default": false,
      "description": "Whether the data to upload should be taken from binary field",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "upload"
          ],
          "resource": [
            "file"
          ]
        }
      }
    },
    {
      "displayName": "File Content",
      "name": "fileContent",
      "type": "string",
      "default": "",
      "description": "The text content of the file",
      "required": true,
      "displayOptions": {
        "show": {
          "binaryData": [
            false
          ],
          "operation": [
            "upload"
          ],
          "resource": [
            "file"
          ]
        }
      }
    },
    {
      "displayName": "Input Binary Field",
      "name": "binaryPropertyName",
      "type": "string",
      "default": "data",
      "required": true,
      "displayOptions": {
        "show": {
          "binaryData": [
            true
          ],
          "operation": [
            "upload"
          ],
          "resource": [
            "file"
          ]
        }
      }
    },
    {
      "displayName": "Parent ID",
      "name": "parentId",
      "type": "string",
      "default": "",
      "description": "ID of the parent folder that will contain the file. If not it will be uploaded to the root folder.",
      "displayOptions": {
        "show": {
          "operation": [
            "upload"
          ],
          "resource": [
            "file"
          ]
        }
      }
    },
    {
      "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",
          "value": "get",
          "description": "Get a folder",
          "action": "Get a folder"
        },
        {
          "name": "Search",
          "value": "search",
          "description": "Search files",
          "action": "Search a folder"
        },
        {
          "name": "Share",
          "value": "share",
          "description": "Share a folder",
          "action": "Share a folder"
        },
        {
          "name": "Update",
          "value": "update",
          "description": "Update folder",
          "action": "Update a folder"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "folder"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Name",
      "name": "name",
      "type": "string",
      "default": "",
      "description": "Folder's name",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "create"
          ],
          "resource": [
            "folder"
          ]
        }
      }
    },
    {
      "displayName": "Parent ID",
      "name": "parentId",
      "type": "string",
      "default": "",
      "description": "ID of the folder you want to create the new folder in. if not defined it will be created on the root folder.",
      "displayOptions": {
        "show": {
          "operation": [
            "create"
          ],
          "resource": [
            "folder"
          ]
        }
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Access",
          "name": "access",
          "type": "options",
          "options": [
            {
              "name": "Collaborators",
              "value": "collaborators",
              "description": "Only emails from registered email addresses for collaborators will be accepted"
            },
            {
              "name": "Open",
              "value": "open",
              "description": "It will accept emails from any email addres"
            }
          ],
          "default": "",
          "description": "ID of the folder you want to create the new folder in"
        },
        {
          "displayName": "Fields",
          "name": "fields",
          "type": "string",
          "default": "",
          "description": "A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response."
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "create"
          ],
          "resource": [
            "folder"
          ]
        }
      }
    },
    {
      "displayName": "Folder ID",
      "name": "folderId",
      "type": "string",
      "default": "",
      "displayOptions": {
        "show": {
          "operation": [
            "get"
          ],
          "resource": [
            "folder"
          ]
        }
      }
    },
    {
      "displayName": "Folder ID",
      "name": "folderId",
      "type": "string",
      "default": "",
      "displayOptions": {
        "show": {
          "operation": [
            "delete"
          ],
          "resource": [
            "folder"
          ]
        }
      }
    },
    {
      "displayName": "Recursive",
      "name": "recursive",
      "type": "boolean",
      "default": false,
      "description": "Whether to delete a folder that is not empty by recursively deleting the folder and all of its content",
      "displayOptions": {
        "show": {
          "operation": [
            "delete"
          ],
          "resource": [
            "folder"
          ]
        }
      }
    },
    {
      "displayName": "Query",
      "name": "query",
      "type": "string",
      "default": "",
      "description": "The string to search for. This query is matched against item names, descriptions, text content of files, and various other fields of the different item types.",
      "displayOptions": {
        "show": {
          "operation": [
            "search"
          ],
          "resource": [
            "folder"
          ]
        }
      }
    },
    {
      "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": [
            "folder"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 100,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "operation": [
            "search"
          ],
          "resource": [
            "folder"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 500
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Content Types",
          "name": "contet_types",
          "type": "string",
          "default": "",
          "description": "Limits search results to items with the given content types. Content types are defined as a comma-separated lists of Box recognized content types."
        },
        {
          "displayName": "Created At Range",
          "name": "createdRangeUi",
          "type": "fixedCollection",
          "typeOptions": {
            "multipleValues": false
          },
          "placeholder": "Add Range",
          "default": {},
          "options": [
            {
              "displayName": "Range",
              "name": "createdRangeValuesUi",
              "values": [
                {
                  "displayName": "From",
                  "name": "from",
                  "type": "dateTime",
                  "default": ""
                },
                {
                  "displayName": "To",
                  "name": "to",
                  "type": "dateTime",
                  "default": ""
                }
              ]
            }
          ]
        },
        {
          "displayName": "Direction",
          "name": "direction",
          "type": "options",
          "options": [
            {
              "name": "ASC",
              "value": "ASC"
            },
            {
              "name": "DESC",
              "value": "DESC"
            }
          ],
          "default": "",
          "description": "Defines the direction in which search results are ordered. Default value is DESC."
        },
        {
          "displayName": "Fields",
          "name": "fields",
          "type": "string",
          "default": "",
          "description": "A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response."
        },
        {
          "displayName": "File Extensions",
          "name": "file_extensions",
          "type": "string",
          "default": "",
          "placeholder": "pdf,png,gif",
          "description": "Limits search results to a comma-separated list of file extensions"
        },
        {
          "displayName": "Folder IDs",
          "name": "ancestor_folder_ids",
          "type": "string",
          "default": "",
          "description": "Limits search results to items within the given list of folders. Folders are defined as a comma-separated lists of folder IDs."
        },
        {
          "displayName": "Scope",
          "name": "scope",
          "type": "options",
          "options": [
            {
              "name": "User Content",
              "value": "user_content"
            },
            {
              "name": "Enterprise Content",
              "value": "enterprise_content"
            }
          ],
          "default": "",
          "description": "Limits search results to a user scope"
        },
        {
          "displayName": "Size Range",
          "name": "size_range",
          "type": "string",
          "default": "",
          "placeholder": "1000000,5000000",
          "description": "Limits search results to items within a given file size range. File size ranges are defined as comma-separated byte sizes."
        },
        {
          "displayName": "Sort",
          "name": "sort",
          "type": "options",
          "options": [
            {
              "name": "Relevance",
              "value": "relevance"
            },
            {
              "name": "Modified At",
              "value": "modified_at"
            }
          ],
          "default": "relevance",
          "description": "Returns the results ordered in descending order by date at which the item was last modified"
        },
        {
          "displayName": "Trash Content",
          "name": "trash_content",
          "type": "options",
          "options": [
            {
              "name": "Non Trashed Only",
              "value": "non_trashed_only"
            },
            {
              "name": "Trashed Only",
              "value": "trashed_only"
            }
          ],
          "default": "non_trashed_only",
          "description": "Controls if search results include the trash"
        },
        {
          "displayName": "Update At Range",
          "name": "updatedRangeUi",
          "type": "fixedCollection",
          "typeOptions": {
            "multipleValues": false
          },
          "placeholder": "Add Range",
          "default": {},
          "options": [
            {
              "displayName": "Range",
              "name": "updatedRangeValuesUi",
              "values": [
                {
                  "displayName": "From",
                  "name": "from",
                  "type": "dateTime",
                  "default": ""
                },
                {
                  "displayName": "To",
                  "name": "to",
                  "type": "dateTime",
                  "default": ""
                }
              ]
            }
          ]
        },
        {
          "displayName": "User IDs",
          "name": "owner_user_ids",
          "type": "string",
          "default": "",
          "description": "Limits search results to items owned by the given list of owners. Owners are defined as a comma-separated list of user IDs."
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "search"
          ],
          "resource": [
            "folder"
          ]
        }
      }
    },
    {
      "displayName": "Folder ID",
      "name": "folderId",
      "type": "string",
      "default": "",
      "description": "The ID of the folder to share",
      "displayOptions": {
        "show": {
          "operation": [
            "share"
          ],
          "resource": [
            "folder"
          ]
        }
      }
    },
    {
      "displayName": "Accessible By",
      "name": "accessibleBy",
      "type": "options",
      "default": "user",
      "description": "The type of object the file will be shared with",
      "options": [
        {
          "name": "User",
          "value": "user"
        },
        {
          "name": "Group",
          "value": "group"
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "share"
          ],
          "resource": [
            "folder"
          ]
        }
      }
    },
    {
      "displayName": "Use Email",
      "name": "useEmail",
      "type": "boolean",
      "default": true,
      "description": "Whether identify the user by email or ID",
      "displayOptions": {
        "show": {
          "operation": [
            "share"
          ],
          "resource": [
            "folder"
          ],
          "accessibleBy": [
            "user"
          ]
        }
      }
    },
    {
      "displayName": "Email",
      "name": "email",
      "type": "string",
      "default": "",
      "description": "The user's email address to share the folder with",
      "displayOptions": {
        "show": {
          "operation": [
            "share"
          ],
          "resource": [
            "folder"
          ],
          "accessibleBy": [
            "user"
          ],
          "useEmail": [
            true
          ]
        }
      }
    },
    {
      "displayName": "User ID",
      "name": "userId",
      "type": "string",
      "default": "",
      "description": "The user's ID to share the folder with",
      "displayOptions": {
        "show": {
          "operation": [
            "share"
          ],
          "resource": [
            "folder"
          ],
          "accessibleBy": [
            "user"
          ],
          "useEmail": [
            false
          ]
        }
      }
    },
    {
      "displayName": "Group ID",
      "name": "groupId",
      "type": "string",
      "default": "",
      "description": "The group's ID to share the folder with",
      "displayOptions": {
        "show": {
          "operation": [
            "share"
          ],
          "resource": [
            "folder"
          ],
          "accessibleBy": [
            "group"
          ]
        }
      }
    },
    {
      "displayName": "Role",
      "name": "role",
      "type": "options",
      "default": "editor",
      "description": "The level of access granted",
      "options": [
        {
          "name": "Co-Owner",
          "value": "coOwner",
          "description": "A Co-owner has all of functional read/write access that an editor does"
        },
        {
          "name": "Editor",
          "value": "editor",
          "description": "An editor has full read/write access to a folder or file"
        },
        {
          "name": "Previewer",
          "value": "previewer",
          "description": "A previewer has limited read access"
        },
        {
          "name": "Previewer Uploader",
          "value": "previewerUploader",
          "description": "This access level is a combination of Previewer and Uploader"
        },
        {
          "name": "Uploader",
          "value": "uploader",
          "description": "An uploader has limited write access"
        },
        {
          "name": "Viewer",
          "value": "viewer",
          "description": "A viewer has read access to a folder or file"
        },
        {
          "name": "Viewer Uploader",
          "value": "viewerUploader",
          "description": "This access level is a combination of Viewer and Uploader"
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "share"
          ],
          "resource": [
            "folder"
          ]
        }
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Can View Path",
          "name": "can_view_path",
          "type": "boolean",
          "default": false,
          "description": "Whether the invited users can see the entire parent path to the associated folder. The user will not gain privileges in any parent folder and therefore cannot see content the user is not collaborated on."
        },
        {
          "displayName": "Expires At",
          "name": "expires_at",
          "type": "dateTime",
          "default": "",
          "description": "Set the expiration date for the collaboration. At this date, the collaboration will be automatically removed from the item."
        },
        {
          "displayName": "Fields",
          "name": "fields",
          "type": "string",
          "default": "",
          "description": "A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response."
        },
        {
          "displayName": "Notify",
          "name": "notify",
          "type": "boolean",
          "default": false,
          "description": "Whether if users should receive email notification for the action performed"
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "share"
          ],
          "resource": [
            "folder"
          ]
        }
      }
    },
    {
      "displayName": "Folder ID",
      "name": "folderId",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "update"
          ],
          "resource": [
            "folder"
          ]
        }
      }
    },
    {
      "displayName": "Update Fields",
      "name": "updateFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Can Non-Owners Invite",
          "name": "can_non_owners_invite",
          "type": "boolean",
          "default": false,
          "description": "Whether users who are not the owner of the folder can invite new collaborators to the folder"
        },
        {
          "displayName": "Can Non-Owners View Colaborators",
          "name": "can_non_owners_view_collaborators",
          "type": "boolean",
          "default": false,
          "description": "Whether to restrict collaborators who are not the owner of this folder from viewing other collaborations on this folder"
        },
        {
          "displayName": "Description",
          "name": "description",
          "type": "string",
          "default": "",
          "description": "The optional description of this folder"
        },
        {
          "displayName": "Fields",
          "name": "fields",
          "type": "string",
          "default": "",
          "description": "A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response."
        },
        {
          "displayName": "Is Collaboration Restricted To Enterprise",
          "name": "is_collaboration_restricted_to_enterprise",
          "type": "boolean",
          "default": false,
          "description": "Whether new invites to this folder are restricted to users within the enterprise. This does not affect existing collaborations."
        },
        {
          "displayName": "Name",
          "name": "name",
          "type": "string",
          "default": "",
          "description": "The optional new name for this folder"
        },
        {
          "displayName": "Parent ID",
          "name": "parentId",
          "type": "string",
          "default": "",
          "description": "The parent folder for this folder. Use this to move the folder or to restore it out of the trash."
        },
        {
          "displayName": "Shared Link",
          "name": "shared_link",
          "type": "collection",
          "typeOptions": {
            "multipleValues": false
          },
          "description": "Share link information",
          "placeholder": "Add Shared Link Config",
          "default": {},
          "options": [
            {
              "displayName": "Access",
              "name": "access",
              "type": "options",
              "options": [
                {
                  "name": "Collaborators",
                  "value": "collaborators",
                  "description": "Only those who have been invited to the folder"
                },
                {
                  "name": "Company",
                  "value": "company",
                  "description": "Only people within the company"
                },
                {
                  "name": "Open",
                  "value": "open",
                  "description": "Anyone with the link"
                }
              ],
              "default": "open"
            },
            {
              "displayName": "Password",
              "name": "password",
              "type": "string",
              "typeOptions": {
                "password": true
              },
              "displayOptions": {
                "show": {
                  "access": [
                    "open"
                  ]
                }
              },
              "default": "",
              "description": "The password required to access the shared link. Set the password to null to remove it."
            },
            {
              "displayName": "Permissions",
              "name": "permissions",
              "type": "collection",
              "placeholder": "Add Permition",
              "default": {},
              "options": [
                {
                  "displayName": "Can Download",
                  "name": "can_download",
                  "type": "boolean",
                  "default": false,
                  "description": "Whether the shared link allows for downloading of files"
                },
                {
                  "displayName": "Unshared At",
                  "name": "unshared_at",
                  "type": "dateTime",
                  "default": "",
                  "description": "The timestamp at which this shared link will expire"
                },
                {
                  "displayName": "Vanity Name",
                  "name": "vanity_name",
                  "type": "string",
                  "default": "",
                  "description": "Defines a custom vanity name to use in the shared link URL, for example https://app.box.com/v/my-shared-link"
                }
              ]
            },
            {
              "displayName": "Tags",
              "name": "tags",
              "type": "string",
              "default": "",
              "description": "The tags for this item. These tags are shown in the Box web app and mobile apps next to an item."
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "update"
          ],
          "resource": [
            "folder"
          ]
        }
      }
    }
  ]

operations:
  [
    {
      "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": "get",
      "name": "Get",
      "description": "Get a file",
      "resource": "file"
    },
    {
      "operation": "search",
      "name": "Search",
      "description": "Search files",
      "resource": "file"
    },
    {
      "operation": "share",
      "name": "Share",
      "description": "Share a file",
      "resource": "file"
    },
    {
      "operation": "upload",
      "name": "Upload",
      "description": "Upload a file",
      "resource": "file"
    },
    {
      "operation": "create",
      "name": "Create",
      "description": "Create a folder",
      "resource": "folder"
    },
    {
      "operation": "delete",
      "name": "Delete",
      "description": "Delete a folder",
      "resource": "folder"
    },
    {
      "operation": "get",
      "name": "Get",
      "description": "Get a folder",
      "resource": "folder"
    },
    {
      "operation": "search",
      "name": "Search",
      "description": "Search files",
      "resource": "folder"
    },
    {
      "operation": "share",
      "name": "Share",
      "description": "Share a folder",
      "resource": "folder"
    },
    {
      "operation": "update",
      "name": "Update",
      "description": "Update folder",
      "resource": "folder"
    }
  ]


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

outputs:
  [
  "main"
  ]

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

  # Box Trigger node

  [Box](https://www.box.com/){:target=_blank .external-link} is a cloud computing company which provides file sharing, collaborating, and other tools for working with files uploaded to its servers.

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

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

  ## Find your Box Target ID

  To get your Target ID in Box:

  1. Open the file/folder that you would like to monitor.
  2. Copy the string of characters after `folder/` in your URL. This is the target ID. For example, if the URL is `https://app.box.com/folder/12345`, then `12345` is the target ID.
  3. Paste it in the **Target ID** field in n8n.

properties_schema:
  [
    {
      "displayName": "Events",
      "name": "events",
      "type": "multiOptions",
      "default": [],
      "description": "The events to listen to",
      "options": [
        {
          "name": "Collaboration Accepted",
          "value": "COLLABORATION.ACCEPTED",
          "description": "A collaboration has been accepted"
        },
        {
          "name": "Collaboration Created",
          "value": "COLLABORATION.CREATED",
          "description": "A collaboration is created"
        },
        {
          "name": "Collaboration Rejected",
          "value": "COLLABORATION.REJECTED",
          "description": "A collaboration has been rejected"
        },
        {
          "name": "Collaboration Removed",
          "value": "COLLABORATION.REMOVED",
          "description": "A collaboration has been removed"
        },
        {
          "name": "Collaboration Updated",
          "value": "COLLABORATION.UPDATED",
          "description": "A collaboration has been updated"
        },
        {
          "name": "Comment Created",
          "value": "COMMENT.CREATED",
          "description": "A comment object is created"
        },
        {
          "name": "Comment Deleted",
          "value": "COMMENT.DELETED",
          "description": "A comment object is removed"
        },
        {
          "name": "Comment Updated",
          "value": "COMMENT.UPDATED",
          "description": "A comment object is edited"
        },
        {
          "name": "File Copied",
          "value": "FILE.COPIED",
          "description": "A file is copied"
        },
        {
          "name": "File Deleted",
          "value": "FILE.DELETED",
          "description": "A file is moved to the trash"
        },
        {
          "name": "File Downloaded",
          "value": "FILE.DOWNLOADED",
          "description": "A file is downloaded"
        },
        {
          "name": "File Locked",
          "value": "FILE.LOCKED",
          "description": "A file is locked"
        },
        {
          "name": "File Moved",
          "value": "FILE.MOVED",
          "description": "A file is moved from one folder to another"
        },
        {
          "name": "File Previewed",
          "value": "FILE.PREVIEWED",
          "description": "A file is previewed"
        },
        {
          "name": "File Renamed",
          "value": "FILE.RENAMED",
          "description": "A file was renamed"
        },
        {
          "name": "File Restored",
          "value": "FILE.RESTORED",
          "description": "A file is restored from the trash"
        },
        {
          "name": "File Trashed",
          "value": "FILE.TRASHED",
          "description": "A file is moved to the trash"
        },
        {
          "name": "File Unlocked",
          "value": "FILE.UNLOCKED",
          "description": "A file is unlocked"
        },
        {
          "name": "File Uploaded",
          "value": "FILE.UPLOADED",
          "description": "A file is uploaded to or moved to this folder"
        },
        {
          "name": "Folder Copied",
          "value": "FOLDER.COPIED",
          "description": "A copy of a folder is made"
        },
        {
          "name": "Folder Created",
          "value": "FOLDER.CREATED",
          "description": "A folder is created"
        },
        {
          "name": "Folder Deleted",
          "value": "FOLDER.DELETED",
          "description": "A folder is permanently removed"
        },
        {
          "name": "Folder Downloaded",
          "value": "FOLDER.DOWNLOADED",
          "description": "A folder is downloaded"
        },
        {
          "name": "Folder Moved",
          "value": "FOLDER.MOVED",
          "description": "A folder is moved to a different folder"
        },
        {
          "name": "Folder Renamed",
          "value": "FOLDER.RENAMED",
          "description": "A folder was renamed"
        },
        {
          "name": "Folder Restored",
          "value": "FOLDER.RESTORED",
          "description": "A folder is restored from the trash"
        },
        {
          "name": "Folder Trashed",
          "value": "FOLDER.TRASHED",
          "description": "A folder is moved to the trash"
        },
        {
          "name": "Metadata Instance Created",
          "value": "METADATA_INSTANCE.CREATED",
          "description": "A new metadata template instance is associated with a file or folder"
        },
        {
          "name": "Metadata Instance Deleted",
          "value": "METADATA_INSTANCE.DELETED",
          "description": "An existing metadata template instance associated with a file or folder is deleted"
        },
        {
          "name": "Metadata Instance Updated",
          "value": "METADATA_INSTANCE.UPDATED",
          "description": "An attribute (value) is updated/deleted for an existing metadata template instance associated with a file or folder"
        },
        {
          "name": "Sharedlink Created",
          "value": "SHARED_LINK.CREATED",
          "description": "A shared link was created"
        },
        {
          "name": "Sharedlink Deleted",
          "value": "SHARED_LINK.DELETED",
          "description": "A shared link was deleted"
        },
        {
          "name": "Sharedlink Updated",
          "value": "SHARED_LINK.UPDATED",
          "description": "A shared link was updated"
        },
        {
          "name": "Task Assignment Created",
          "value": "TASK_ASSIGNMENT.CREATED",
          "description": "A task is created"
        },
        {
          "name": "Task Assignment Updated",
          "value": "TASK_ASSIGNMENT.UPDATED",
          "description": "A task is updated"
        },
        {
          "name": "Webhook Deleted",
          "value": "WEBHOOK.DELETED",
          "description": "When a webhook is deleted"
        }
      ],
      "required": true
    },
    {
      "displayName": "Target Type",
      "name": "targetType",
      "type": "options",
      "default": "",
      "description": "The type of item to trigger a webhook",
      "options": [
        {
          "name": "File",
          "value": "file"
        },
        {
          "name": "Folder",
          "value": "folder"
        }
      ]
    },
    {
      "displayName": "Target ID",
      "name": "targetId",
      "type": "string",
      "default": "",
      "description": "The ID of the item to trigger a webhook"
    }
  ]


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

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

output_names:
  [
  "Tool"
  ]

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

  # Brandfetch node

  Use the Brandfetch node to automate work in Brandfetch, and integrate Brandfetch with other applications. n8n has built-in support for a wide range of Brandfetch features, including returning a company’s information.

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

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

  ## Operations

  * Return a company's colors
  * Return a company's data
  * Return a company's fonts
  * Return a company's industry
  * Return a company's logo & icon

  ## Templates and examples

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

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 Brandfetch"
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "logo",
      "options": [
        {
          "name": "Color",
          "value": "color",
          "description": "Return a company's colors",
          "action": "Return a company's colors"
        },
        {
          "name": "Company",
          "value": "company",
          "description": "Return a company's data",
          "action": "Return a company's data"
        },
        {
          "name": "Font",
          "value": "font",
          "description": "Return a company's fonts",
          "action": "Return a company's fonts"
        },
        {
          "name": "Industry",
          "value": "industry",
          "description": "Return a company's industry",
          "action": "Return a company's industry"
        },
        {
          "name": "Logo",
          "value": "logo",
          "description": "Return a company's logo & icon",
          "action": "Return a company's logo & icon"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "Domain",
      "name": "domain",
      "type": "string",
      "default": "",
      "description": "The domain name of the company",
      "required": true
    },
    {
      "displayName": "Download",
      "name": "download",
      "type": "boolean",
      "default": false,
      "description": "Name of the binary property to which to write the data of the read file",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "logo"
          ]
        }
      }
    },
    {
      "displayName": "Image Type",
      "name": "imageTypes",
      "type": "multiOptions",
      "default": [
        "logo",
        "icon"
      ],
      "options": [
        {
          "name": "Icon",
          "value": "icon"
        },
        {
          "name": "Logo",
          "value": "logo"
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "logo"
          ],
          "download": [
            true
          ]
        }
      }
    },
    {
      "displayName": "Image Format",
      "name": "imageFormats",
      "type": "multiOptions",
      "default": [
        "png"
      ],
      "description": "The image format in which the logo should be returned as",
      "options": [
        {
          "name": "PNG",
          "value": "png"
        },
        {
          "name": "SVG",
          "value": "svg"
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "logo"
          ],
          "download": [
            true
          ]
        }
      }
    }
  ]

operations:
  [
    {
      "operation": "color",
      "name": "Color",
      "description": "Return a company's colors"
    },
    {
      "operation": "company",
      "name": "Company",
      "description": "Return a company's data"
    },
    {
      "operation": "font",
      "name": "Font",
      "description": "Return a company's fonts"
    },
    {
      "operation": "industry",
      "name": "Industry",
      "description": "Return a company's industry"
    },
    {
      "operation": "logo",
      "name": "Logo",
      "description": "Return a company's logo & icon"
    }
  ]


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

outputs:
  [
  "main"
  ]

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

  # Brandfetch node

  Use the Brandfetch node to automate work in Brandfetch, and integrate Brandfetch with other applications. n8n has built-in support for a wide range of Brandfetch features, including returning a company’s information.

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

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

  ## Operations

  * Return a company's colors
  * Return a company's data
  * Return a company's fonts
  * Return a company's industry
  * Return a company's logo & icon

  ## Templates and examples

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

properties_schema:
  [
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "logo",
      "options": [
        {
          "name": "Color",
          "value": "color",
          "description": "Return a company's colors",
          "action": "Return a company's colors"
        },
        {
          "name": "Company",
          "value": "company",
          "description": "Return a company's data",
          "action": "Return a company's data"
        },
        {
          "name": "Font",
          "value": "font",
          "description": "Return a company's fonts",
          "action": "Return a company's fonts"
        },
        {
          "name": "Industry",
          "value": "industry",
          "description": "Return a company's industry",
          "action": "Return a company's industry"
        },
        {
          "name": "Logo",
          "value": "logo",
          "description": "Return a company's logo & icon",
          "action": "Return a company's logo & icon"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "Domain",
      "name": "domain",
      "type": "string",
      "default": "",
      "description": "The domain name of the company",
      "required": true
    },
    {
      "displayName": "Download",
      "name": "download",
      "type": "boolean",
      "default": false,
      "description": "Name of the binary property to which to write the data of the read file",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "logo"
          ]
        }
      }
    },
    {
      "displayName": "Image Type",
      "name": "imageTypes",
      "type": "multiOptions",
      "default": [
        "logo",
        "icon"
      ],
      "options": [
        {
          "name": "Icon",
          "value": "icon"
        },
        {
          "name": "Logo",
          "value": "logo"
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "logo"
          ],
          "download": [
            true
          ]
        }
      }
    },
    {
      "displayName": "Image Format",
      "name": "imageFormats",
      "type": "multiOptions",
      "default": [
        "png"
      ],
      "description": "The image format in which the logo should be returned as",
      "options": [
        {
          "name": "PNG",
          "value": "png"
        },
        {
          "name": "SVG",
          "value": "svg"
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "logo"
          ],
          "download": [
            true
          ]
        }
      }
    }
  ]

operations:
  [
    {
      "operation": "color",
      "name": "Color",
      "description": "Return a company's colors"
    },
    {
      "operation": "company",
      "name": "Company",
      "description": "Return a company's data"
    },
    {
      "operation": "font",
      "name": "Font",
      "description": "Return a company's fonts"
    },
    {
      "operation": "industry",
      "name": "Industry",
      "description": "Return a company's industry"
    },
    {
      "operation": "logo",
      "name": "Logo",
      "description": "Return a company's logo & icon"
    }
  ]


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

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

output_names:
  [
  "Tool"
  ]

updated_at: 2026-07-16 12:10:22
tool_variant_of: nodes-base.bubble
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: Bubble node documentation
  description: Learn how to use the Bubble node in n8n. Follow technical documentation to integrate Bubble node into your workflows.
  contentType: [integration, reference]
  priority: medium
  ---

  # Bubble node

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

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

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

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

  ## Operations

  * Object
      * Create
      * Delete
      * Get
      * Get All
      * Update

  ## Templates and examples

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

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 Bubble"
    },
    {
      "displayName": "Resource",
      "name": "resource",
      "type": "options",
      "default": "object",
      "options": [
        {
          "name": "Object",
          "value": "object"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "get",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "action": "Create an object"
        },
        {
          "name": "Delete",
          "value": "delete",
          "action": "Delete an object"
        },
        {
          "name": "Get",
          "value": "get",
          "action": "Get an object"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "action": "Get many objects"
        },
        {
          "name": "Update",
          "value": "update",
          "action": "Update an object"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "object"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Type Name",
      "name": "typeName",
      "type": "string",
      "default": "",
      "description": "Name of data type of the object to create",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "object"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Properties",
      "name": "properties",
      "type": "fixedCollection",
      "default": {},
      "options": [
        {
          "displayName": "Property",
          "name": "property",
          "values": [
            {
              "displayName": "Key",
              "name": "key",
              "type": "string",
              "default": "",
              "description": "Field to set for the object to create"
            },
            {
              "displayName": "Value",
              "name": "value",
              "type": "string",
              "default": "",
              "description": "Value to set for the object to create"
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "object"
          ],
          "operation": [
            "create"
          ]
        }
      },
      "typeOptions": {
        "multipleValues": true
      }
    },
    {
      "displayName": "Type Name",
      "name": "typeName",
      "type": "string",
      "default": "",
      "description": "Name of data type of the object to retrieve",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "object"
          ],
          "operation": [
            "get",
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "Object ID",
      "name": "objectId",
      "type": "string",
      "default": "",
      "description": "ID of the object to retrieve",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "object"
          ],
          "operation": [
            "get",
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "Type Name",
      "name": "typeName",
      "type": "string",
      "default": "",
      "description": "Name of data type of the object to update",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "object"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Object ID",
      "name": "objectId",
      "type": "string",
      "default": "",
      "description": "ID of the object to update",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "object"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Properties",
      "name": "properties",
      "type": "fixedCollection",
      "default": {},
      "options": [
        {
          "displayName": "Property",
          "name": "property",
          "values": [
            {
              "displayName": "Key",
              "name": "key",
              "type": "string",
              "default": "",
              "description": "Field to set for the object to create"
            },
            {
              "displayName": "Value",
              "name": "value",
              "type": "string",
              "default": "",
              "description": "Value to set for the object to create"
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "object"
          ],
          "operation": [
            "update"
          ]
        }
      },
      "typeOptions": {
        "multipleValues": true
      }
    },
    {
      "displayName": "Type Name",
      "name": "typeName",
      "type": "string",
      "default": "",
      "description": "Name of data type of the object to create",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "object"
          ],
          "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": [
            "object"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 100,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "object"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 100
      }
    },
    {
      "displayName": "JSON Parameters",
      "name": "jsonParameters",
      "type": "boolean",
      "default": false,
      "displayOptions": {
        "show": {
          "resource": [
            "object"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Filters",
          "name": "filters",
          "placeholder": "Add Filter",
          "type": "fixedCollection",
          "typeOptions": {
            "multipleValues": true
          },
          "displayOptions": {
            "show": {
              "/jsonParameters": [
                false
              ]
            }
          },
          "default": {},
          "options": [
            {
              "displayName": "Filter",
              "name": "filter",
              "values": [
                {
                  "displayName": "Key",
                  "name": "key",
                  "type": "string",
                  "default": "",
                  "description": "Field to set for the object to create"
                },
                {
                  "displayName": "Constrain",
                  "name": "constraint_type",
                  "type": "options",
                  "options": [
                    {
                      "name": "Equals",
                      "value": "equals",
                      "description": "Use to test strict equality, for all field types"
                    },
                    {
                      "name": "Not Equal",
                      "value": "not equal",
                      "description": "Use to test strict equality, for all field types"
                    },
                    {
                      "name": "Is Empty",
                      "value": "is_empty",
                      "description": "Use to test whether a thing's given field is empty, for all field types"
                    },
                    {
                      "name": "Is Not Empty",
                      "value": "is_not_empty",
                      "description": "Use to test whether a thing's given field is not empty, for all field types"
                    },
                    {
                      "name": "Text Contains",
                      "value": "text contains",
                      "description": "Use to test if a text field contains a string, for text fields only"
                    },
                    {
                      "name": "Not Text Contains",
                      "value": "not text contains",
                      "description": "Use to test if a text field does not contain a string, for text fields only"
                    },
                    {
                      "name": "Greater Than",
                      "value": "greater than",
                      "description": "Use to compare a thing's field value relative to a string or number, for text, number, and date fields"
                    },
                    {
                      "name": "Less Than",
                      "value": "less than",
                      "description": "Use to compare a thing's field value relative to a string or number, for text, number, and date fields"
                    },
                    {
                      "name": "In",
                      "value": "in",
                      "description": "Use to test whether a thing's field is in a list, for all field types"
                    },
                    {
                      "name": "Not In",
                      "value": "not in",
                      "description": "Use to test whether a thing's field is not in a list, for all field types"
                    },
                    {
                      "name": "Contains",
                      "value": "contains",
                      "description": "Use to test whether a list field contains an entry, for list fields only"
                    },
                    {
                      "name": "Not Contains",
                      "value": "not contains",
                      "description": "Use to test whether a list field does not contains an entry, for list fields only"
                    },
                    {
                      "name": "Empty",
                      "value": "empty",
                      "description": "Use to test whether a list field is empty, for list fields only"
                    },
                    {
                      "name": "Not Empty",
                      "value": "not empty",
                      "description": "Use to test whether a list field is not empty, for list fields only"
                    },
                    {
                      "name": "Geographic Search",
                      "value": "geographic_search",
                      "description": "Use to test if the current thing is within a radius from a central address. To use this, the value sent with the constraint must have an address and a range. See <a href=\"https://manual.bubble.io/core-resources/api/data-api\">link</a>."
                    }
                  ],
                  "default": ""
                },
                {
                  "displayName": "Value",
                  "name": "value",
                  "type": "string",
                  "displayOptions": {
                    "hide": {
                      "constraint_type": [
                        "is_empty",
                        "is_not_empty",
                        "empty",
                        "not empty"
                      ]
                    }
                  },
                  "default": "",
                  "description": "Value to set for the object to create"
                }
              ]
            }
          ]
        },
        {
          "displayName": "Filters (JSON)",
          "name": "filtersJson",
          "type": "json",
          "default": "",
          "displayOptions": {
            "show": {
              "/jsonParameters": [
                true
              ]
            }
          },
          "placeholder": "[ { \"key\": \"name\", \"constraint_type\": \"text contains\", \"value\": \"cafe\" } , { \"key\": \"address\", \"constraint_type\": \"geographic_search\", \"value\": { \"range\":10, \"origin_address\":\"New York\" } } ]",
          "description": "Refine the list that is returned by the Data API with search constraints, exactly as you define a search in Bubble. See <a href=\"https://manual.bubble.io/core-resources/api/data-api#search-constraints\">link</a>."
        },
        {
          "displayName": "Sort",
          "name": "sort",
          "placeholder": "Add Sort",
          "type": "fixedCollection",
          "typeOptions": {
            "multipleValues": false
          },
          "default": {},
          "options": [
            {
              "displayName": "Sort",
              "name": "sortValue",
              "values": [
                {
                  "displayName": "Sort Field",
                  "name": "sort_field",
                  "type": "string",
                  "default": "",
                  "description": "Specify the field to use for sorting. Either use a fielddefined for the current typeor use <code>_random_sorting</code> to get the entries in a random order."
                },
                {
                  "displayName": "Descending",
                  "name": "descending",
                  "type": "boolean",
                  "default": false
                },
                {
                  "displayName": "Geo Reference",
                  "name": "geo_reference",
                  "type": "string",
                  "default": "",
                  "description": "When the field's type is geographic address, you need to add another parameter geo_reference and provide an address as a string"
                }
              ]
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "object"
          ]
        }
      }
    }
  ]

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


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

outputs:
  [
  "main"
  ]

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

  # Bubble node

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

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

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

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

  ## Operations

  * Object
      * Create
      * Delete
      * Get
      * Get All
      * Update

  ## Templates and examples

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

properties_schema:
  [
    {
      "displayName": "Resource",
      "name": "resource",
      "type": "options",
      "default": "object",
      "options": [
        {
          "name": "Object",
          "value": "object"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "get",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "action": "Create an object"
        },
        {
          "name": "Delete",
          "value": "delete",
          "action": "Delete an object"
        },
        {
          "name": "Get",
          "value": "get",
          "action": "Get an object"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "action": "Get many objects"
        },
        {
          "name": "Update",
          "value": "update",
          "action": "Update an object"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "object"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Type Name",
      "name": "typeName",
      "type": "string",
      "default": "",
      "description": "Name of data type of the object to create",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "object"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Properties",
      "name": "properties",
      "type": "fixedCollection",
      "default": {},
      "options": [
        {
          "displayName": "Property",
          "name": "property",
          "values": [
            {
              "displayName": "Key",
              "name": "key",
              "type": "string",
              "default": "",
              "description": "Field to set for the object to create"
            },
            {
              "displayName": "Value",
              "name": "value",
              "type": "string",
              "default": "",
              "description": "Value to set for the object to create"
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "object"
          ],
          "operation": [
            "create"
          ]
        }
      },
      "typeOptions": {
        "multipleValues": true
      }
    },
    {
      "displayName": "Type Name",
      "name": "typeName",
      "type": "string",
      "default": "",
      "description": "Name of data type of the object to retrieve",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "object"
          ],
          "operation": [
            "get",
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "Object ID",
      "name": "objectId",
      "type": "string",
      "default": "",
      "description": "ID of the object to retrieve",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "object"
          ],
          "operation": [
            "get",
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "Type Name",
      "name": "typeName",
      "type": "string",
      "default": "",
      "description": "Name of data type of the object to update",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "object"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Object ID",
      "name": "objectId",
      "type": "string",
      "default": "",
      "description": "ID of the object to update",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "object"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Properties",
      "name": "properties",
      "type": "fixedCollection",
      "default": {},
      "options": [
        {
          "displayName": "Property",
          "name": "property",
          "values": [
            {
              "displayName": "Key",
              "name": "key",
              "type": "string",
              "default": "",
              "description": "Field to set for the object to create"
            },
            {
              "displayName": "Value",
              "name": "value",
              "type": "string",
              "default": "",
              "description": "Value to set for the object to create"
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "object"
          ],
          "operation": [
            "update"
          ]
        }
      },
      "typeOptions": {
        "multipleValues": true
      }
    },
    {
      "displayName": "Type Name",
      "name": "typeName",
      "type": "string",
      "default": "",
      "description": "Name of data type of the object to create",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "object"
          ],
          "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": [
            "object"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 100,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "object"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 100
      }
    },
    {
      "displayName": "JSON Parameters",
      "name": "jsonParameters",
      "type": "boolean",
      "default": false,
      "displayOptions": {
        "show": {
          "resource": [
            "object"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Filters",
          "name": "filters",
          "placeholder": "Add Filter",
          "type": "fixedCollection",
          "typeOptions": {
            "multipleValues": true
          },
          "displayOptions": {
            "show": {
              "/jsonParameters": [
                false
              ]
            }
          },
          "default": {},
          "options": [
            {
              "displayName": "Filter",
              "name": "filter",
              "values": [
                {
                  "displayName": "Key",
                  "name": "key",
                  "type": "string",
                  "default": "",
                  "description": "Field to set for the object to create"
                },
                {
                  "displayName": "Constrain",
                  "name": "constraint_type",
                  "type": "options",
                  "options": [
                    {
                      "name": "Equals",
                      "value": "equals",
                      "description": "Use to test strict equality, for all field types"
                    },
                    {
                      "name": "Not Equal",
                      "value": "not equal",
                      "description": "Use to test strict equality, for all field types"
                    },
                    {
                      "name": "Is Empty",
                      "value": "is_empty",
                      "description": "Use to test whether a thing's given field is empty, for all field types"
                    },
                    {
                      "name": "Is Not Empty",
                      "value": "is_not_empty",
                      "description": "Use to test whether a thing's given field is not empty, for all field types"
                    },
                    {
                      "name": "Text Contains",
                      "value": "text contains",
                      "description": "Use to test if a text field contains a string, for text fields only"
                    },
                    {
                      "name": "Not Text Contains",
                      "value": "not text contains",
                      "description": "Use to test if a text field does not contain a string, for text fields only"
                    },
                    {
                      "name": "Greater Than",
                      "value": "greater than",
                      "description": "Use to compare a thing's field value relative to a string or number, for text, number, and date fields"
                    },
                    {
                      "name": "Less Than",
                      "value": "less than",
                      "description": "Use to compare a thing's field value relative to a string or number, for text, number, and date fields"
                    },
                    {
                      "name": "In",
                      "value": "in",
                      "description": "Use to test whether a thing's field is in a list, for all field types"
                    },
                    {
                      "name": "Not In",
                      "value": "not in",
                      "description": "Use to test whether a thing's field is not in a list, for all field types"
                    },
                    {
                      "name": "Contains",
                      "value": "contains",
                      "description": "Use to test whether a list field contains an entry, for list fields only"
                    },
                    {
                      "name": "Not Contains",
                      "value": "not contains",
                      "description": "Use to test whether a list field does not contains an entry, for list fields only"
                    },
                    {
                      "name": "Empty",
                      "value": "empty",
                      "description": "Use to test whether a list field is empty, for list fields only"
                    },
                    {
                      "name": "Not Empty",
                      "value": "not empty",
                      "description": "Use to test whether a list field is not empty, for list fields only"
                    },
                    {
                      "name": "Geographic Search",
                      "value": "geographic_search",
                      "description": "Use to test if the current thing is within a radius from a central address. To use this, the value sent with the constraint must have an address and a range. See <a href=\"https://manual.bubble.io/core-resources/api/data-api\">link</a>."
                    }
                  ],
                  "default": ""
                },
                {
                  "displayName": "Value",
                  "name": "value",
                  "type": "string",
                  "displayOptions": {
                    "hide": {
                      "constraint_type": [
                        "is_empty",
                        "is_not_empty",
                        "empty",
                        "not empty"
                      ]
                    }
                  },
                  "default": "",
                  "description": "Value to set for the object to create"
                }
              ]
            }
          ]
        },
        {
          "displayName": "Filters (JSON)",
          "name": "filtersJson",
          "type": "json",
          "default": "",
          "displayOptions": {
            "show": {
              "/jsonParameters": [
                true
              ]
            }
          },
          "placeholder": "[ { \"key\": \"name\", \"constraint_type\": \"text contains\", \"value\": \"cafe\" } , { \"key\": \"address\", \"constraint_type\": \"geographic_search\", \"value\": { \"range\":10, \"origin_address\":\"New York\" } } ]",
          "description": "Refine the list that is returned by the Data API with search constraints, exactly as you define a search in Bubble. See <a href=\"https://manual.bubble.io/core-resources/api/data-api#search-constraints\">link</a>."
        },
        {
          "displayName": "Sort",
          "name": "sort",
          "placeholder": "Add Sort",
          "type": "fixedCollection",
          "typeOptions": {
            "multipleValues": false
          },
          "default": {},
          "options": [
            {
              "displayName": "Sort",
              "name": "sortValue",
              "values": [
                {
                  "displayName": "Sort Field",
                  "name": "sort_field",
                  "type": "string",
                  "default": "",
                  "description": "Specify the field to use for sorting. Either use a fielddefined for the current typeor use <code>_random_sorting</code> to get the entries in a random order."
                },
                {
                  "displayName": "Descending",
                  "name": "descending",
                  "type": "boolean",
                  "default": false
                },
                {
                  "displayName": "Geo Reference",
                  "name": "geo_reference",
                  "type": "string",
                  "default": "",
                  "description": "When the field's type is geographic address, you need to add another parameter geo_reference and provide an address as a string"
                }
              ]
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "object"
          ]
        }
      }
    }
  ]

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


node_type: nodes-base.calTrigger
package_name: n8n-nodes-base
display_name: Cal.com Trigger
description: Handle Cal.com events via webhooks
category: trigger
development_style: programmatic
version: 2
operations: []
credentials_required:
  [
  {
  "name": "calApi",
  "required": true
  }
  ]

outputs:
  [
  "main"
  ]

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

  # Cal Trigger node

  [Cal](https://cal.com/) is the event-juggling scheduler for everyone. Focus on meeting, not making meetings.

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

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

properties_schema:
  [
    {
      "displayName": "Events",
      "name": "events",
      "type": "multiOptions",
      "default": [],
      "options": [
        {
          "name": "Booking Cancelled",
          "value": "BOOKING_CANCELLED",
          "description": "Receive notifications when a Cal event is canceled"
        },
        {
          "name": "Booking Created",
          "value": "BOOKING_CREATED",
          "description": "Receive notifications when a new Cal event is created"
        },
        {
          "name": "Booking Rescheduled",
          "value": "BOOKING_RESCHEDULED",
          "description": "Receive notifications when a Cal event is rescheduled"
        },
        {
          "name": "Meeting Ended",
          "value": "MEETING_ENDED",
          "description": "Receive notifications when a Cal event or meeting has ended"
        }
      ],
      "required": true
    },
    {
      "displayName": "API Version",
      "name": "version",
      "type": "options",
      "default": 1,
      "options": [
        {
          "name": "Before v2.0",
          "value": 1
        },
        {
          "name": "v2.0 Onwards",
          "value": 2
        }
      ],
      "displayOptions": {
        "show": {
          "@version": [
            1
          ]
        }
      }
    },
    {
      "displayName": "API Version",
      "name": "version",
      "type": "options",
      "default": 2,
      "options": [
        {
          "name": "Before v2.0",
          "value": 1
        },
        {
          "name": "v2.0 Onwards",
          "value": 2
        }
      ],
      "displayOptions": {
        "show": {
          "@version": [
            2
          ]
        }
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "App ID",
          "name": "appId",
          "type": "string",
          "description": "The ID of the App to monitor",
          "default": ""
        },
        {
          "displayName": "EventType Name or ID",
          "name": "eventTypeId",
          "type": "options",
          "typeOptions": {
            "loadOptionsMethod": "getEventTypes"
          },
          "description": "The EventType to monitor. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
          "default": ""
        },
        {
          "displayName": "Payload Template",
          "name": "payloadTemplate",
          "type": "string",
          "description": "Template to customize the webhook payload",
          "default": "",
          "typeOptions": {
            "rows": 4
          }
        }
      ]
    }
  ]


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

outputs:
  [
  "main"
  ]

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

  # Calendly Trigger node

  [Calendly](https://calendly.com/){:target=_blank .external-link} is an automated scheduling software that's designed to help find meeting times.

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

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

properties_schema:
  [
    {
      "displayName": "Scope",
      "name": "scope",
      "type": "options",
      "default": "user",
      "options": [
        {
          "name": "Organization",
          "value": "organization",
          "description": "Triggers the webhook for all subscribed events within the organization"
        },
        {
          "name": "User",
          "value": "user",
          "description": "Triggers the webhook for subscribed events that belong to the current user"
        }
      ],
      "required": true
    },
    {
      "displayName": "Events",
      "name": "events",
      "type": "multiOptions",
      "default": [],
      "options": [
        {
          "name": "Event Created",
          "value": "invitee.created",
          "description": "Receive notifications when a new Calendly event is created"
        },
        {
          "name": "Event Canceled",
          "value": "invitee.canceled",
          "description": "Receive notifications when a Calendly event is canceled"
        }
      ],
      "required": true
    }
  ]


node_type: nodes-base.chargebeeTool
package_name: n8n-nodes-base
display_name: Chargebee Tool
description: Retrieve data from Chargebee API (AI Tool variant for use with AI Agents)
category: input
development_style: programmatic
version: 1
credentials_required:
  [
  {
  "name": "chargebeeApi",
  "required": true
  }
  ]

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

output_names:
  [
  "Tool"
  ]

updated_at: 2026-07-16 12:10:22
tool_variant_of: nodes-base.chargebee
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: Chargebee node documentation
  description: Learn how to use the Chargebee node in n8n. Follow technical documentation to integrate Chargebee node into your workflows.
  contentType: [integration, reference]
  ---

  # Chargebee node

  Use the Chargebee node to automate work in Chargebee, and integrate Chargebee with other applications. n8n has built-in support for a wide range of Chargebee features, including creating customers, returning invoices, and canceling subscriptions.

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

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

  ## Operations

  * Customer
      * Create a customer
  * Invoice
      * Return the invoices
      * Get URL for the invoice PDF
  * Subscription
      * Cancel a subscription
      * Delete a subscription

  ## Templates and examples

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

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 Chargebee"
    },
    {
      "displayName": "Resource",
      "name": "resource",
      "type": "options",
      "default": "invoice",
      "options": [
        {
          "name": "Customer",
          "value": "customer"
        },
        {
          "name": "Invoice",
          "value": "invoice"
        },
        {
          "name": "Subscription",
          "value": "subscription"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create a customer",
          "action": "Create a customer"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "customer"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Properties",
      "name": "properties",
      "type": "collection",
      "default": {},
      "description": "Properties to set on the new user",
      "options": [
        {
          "displayName": "User ID",
          "name": "id",
          "type": "string",
          "default": "",
          "description": "ID for the new customer. If not given, this will be auto-generated."
        },
        {
          "displayName": "First Name",
          "name": "first_name",
          "type": "string",
          "default": "",
          "description": "The first name of the customer"
        },
        {
          "displayName": "Last Name",
          "name": "last_name",
          "type": "string",
          "default": "",
          "description": "The last name of the customer"
        },
        {
          "displayName": "Email",
          "name": "email",
          "type": "string",
          "placeholder": "name@email.com",
          "default": "",
          "description": "The email address of the customer"
        },
        {
          "displayName": "Phone",
          "name": "phone",
          "type": "string",
          "default": "",
          "description": "The phone number of the customer"
        },
        {
          "displayName": "Company",
          "name": "company",
          "type": "string",
          "default": "",
          "description": "The company of the customer"
        },
        {
          "displayName": "Custom Properties",
          "name": "customProperties",
          "placeholder": "Add Custom Property",
          "description": "Adds a custom property to set also values which have not been predefined",
          "type": "fixedCollection",
          "typeOptions": {
            "multipleValues": true
          },
          "default": {},
          "options": [
            {
              "name": "property",
              "displayName": "Property",
              "values": [
                {
                  "displayName": "Property Name",
                  "name": "name",
                  "type": "string",
                  "default": "",
                  "description": "Name of the property to set"
                },
                {
                  "displayName": "Property Value",
                  "name": "value",
                  "type": "string",
                  "default": "",
                  "description": "Value of the property to set"
                }
              ]
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "create"
          ],
          "resource": [
            "customer"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "list",
      "options": [
        {
          "name": "List",
          "value": "list",
          "description": "Return the invoices",
          "action": "List an invoice"
        },
        {
          "name": "PDF Invoice URL",
          "value": "pdfUrl",
          "description": "Get URL for the invoice PDF",
          "action": "Get URL for the invoice PDF"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "invoice"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Max Results",
      "name": "maxResults",
      "type": "number",
      "default": 10,
      "description": "Max. amount of results to return(< 100).",
      "displayOptions": {
        "show": {
          "operation": [
            "list"
          ],
          "resource": [
            "invoice"
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 100
      }
    },
    {
      "displayName": "Filters",
      "name": "filters",
      "type": "fixedCollection",
      "default": {},
      "description": "Filter for invoices",
      "options": [
        {
          "name": "date",
          "displayName": "Invoice Date",
          "values": [
            {
              "displayName": "Operation",
              "name": "operation",
              "type": "options",
              "noDataExpression": true,
              "options": [
                {
                  "name": "Is",
                  "value": "is"
                },
                {
                  "name": "Is Not",
                  "value": "is_not"
                },
                {
                  "name": "After",
                  "value": "after"
                },
                {
                  "name": "Before",
                  "value": "before"
                }
              ],
              "default": "after",
              "description": "Operation to decide where the data should be mapped to"
            },
            {
              "displayName": "Date",
              "name": "value",
              "type": "dateTime",
              "default": "",
              "description": "Query date"
            }
          ]
        },
        {
          "name": "total",
          "displayName": "Invoice Amount",
          "values": [
            {
              "displayName": "Operation",
              "name": "operation",
              "type": "options",
              "noDataExpression": true,
              "options": [
                {
                  "name": "Greater Equal Than",
                  "value": "gte"
                },
                {
                  "name": "Greater Than",
                  "value": "gt"
                },
                {
                  "name": "Is",
                  "value": "is"
                },
                {
                  "name": "Is Not",
                  "value": "is_not"
                },
                {
                  "name": "Less Equal Than",
                  "value": "lte"
                },
                {
                  "name": "Less Than",
                  "value": "lt"
                }
              ],
              "default": "gt",
              "description": "Operation to decide where the data should be mapped to"
            },
            {
              "displayName": "Amount",
              "name": "value",
              "type": "number",
              "typeOptions": {
                "numberPrecision": 2
              },
              "default": 0,
              "description": "Query amount"
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "list"
          ],
          "resource": [
            "invoice"
          ]
        }
      },
      "typeOptions": {
        "multipleValues": true
      }
    },
    {
      "displayName": "Invoice ID",
      "name": "invoiceId",
      "type": "string",
      "default": "",
      "description": "The ID of the invoice to get",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "pdfUrl"
          ],
          "resource": [
            "invoice"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "delete",
      "options": [
        {
          "name": "Cancel",
          "value": "cancel",
          "description": "Cancel a subscription",
          "action": "Cancel a subscription"
        },
        {
          "name": "Delete",
          "value": "delete",
          "description": "Delete a subscription",
          "action": "Delete a subscription"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "subscription"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Subscription ID",
      "name": "subscriptionId",
      "type": "string",
      "default": "",
      "description": "The ID of the subscription to cancel",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "cancel"
          ],
          "resource": [
            "subscription"
          ]
        }
      }
    },
    {
      "displayName": "Schedule End of Term",
      "name": "endOfTerm",
      "type": "boolean",
      "default": false,
      "description": "Whether it will not cancel it directly in will instead schedule the cancelation for the end of the term",
      "displayOptions": {
        "show": {
          "operation": [
            "cancel"
          ],
          "resource": [
            "subscription"
          ]
        }
      }
    },
    {
      "displayName": "Subscription ID",
      "name": "subscriptionId",
      "type": "string",
      "default": "",
      "description": "The ID of the subscription to delete",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "delete"
          ],
          "resource": [
            "subscription"
          ]
        }
      }
    }
  ]

operations:
  [
    {
      "operation": "create",
      "name": "Create",
      "description": "Create a customer",
      "resource": "customer"
    },
    {
      "operation": "list",
      "name": "List",
      "description": "Return the invoices",
      "resource": "invoice"
    },
    {
      "operation": "pdfUrl",
      "name": "PDF Invoice URL",
      "description": "Get URL for the invoice PDF",
      "resource": "invoice"
    },
    {
      "operation": "cancel",
      "name": "Cancel",
      "description": "Cancel a subscription",
      "resource": "subscription"
    },
    {
      "operation": "delete",
      "name": "Delete",
      "description": "Delete a subscription",
      "resource": "subscription"
    }
  ]


node_type: nodes-base.chargebee
package_name: n8n-nodes-base
display_name: Chargebee
description: Retrieve data from Chargebee API
category: input
development_style: programmatic
version: 1
credentials_required:
  [
  {
  "name": "chargebeeApi",
  "required": true
  }
  ]

outputs:
  [
  "main"
  ]

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

  # Chargebee node

  Use the Chargebee node to automate work in Chargebee, and integrate Chargebee with other applications. n8n has built-in support for a wide range of Chargebee features, including creating customers, returning invoices, and canceling subscriptions.

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

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

  ## Operations

  * Customer
      * Create a customer
  * Invoice
      * Return the invoices
      * Get URL for the invoice PDF
  * Subscription
      * Cancel a subscription
      * Delete a subscription

  ## Templates and examples

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

properties_schema:
  [
    {
      "displayName": "Resource",
      "name": "resource",
      "type": "options",
      "default": "invoice",
      "options": [
        {
          "name": "Customer",
          "value": "customer"
        },
        {
          "name": "Invoice",
          "value": "invoice"
        },
        {
          "name": "Subscription",
          "value": "subscription"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create a customer",
          "action": "Create a customer"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "customer"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Properties",
      "name": "properties",
      "type": "collection",
      "default": {},
      "description": "Properties to set on the new user",
      "options": [
        {
          "displayName": "User ID",
          "name": "id",
          "type": "string",
          "default": "",
          "description": "ID for the new customer. If not given, this will be auto-generated."
        },
        {
          "displayName": "First Name",
          "name": "first_name",
          "type": "string",
          "default": "",
          "description": "The first name of the customer"
        },
        {
          "displayName": "Last Name",
          "name": "last_name",
          "type": "string",
          "default": "",
          "description": "The last name of the customer"
        },
        {
          "displayName": "Email",
          "name": "email",
          "type": "string",
          "placeholder": "name@email.com",
          "default": "",
          "description": "The email address of the customer"
        },
        {
          "displayName": "Phone",
          "name": "phone",
          "type": "string",
          "default": "",
          "description": "The phone number of the customer"
        },
        {
          "displayName": "Company",
          "name": "company",
          "type": "string",
          "default": "",
          "description": "The company of the customer"
        },
        {
          "displayName": "Custom Properties",
          "name": "customProperties",
          "placeholder": "Add Custom Property",
          "description": "Adds a custom property to set also values which have not been predefined",
          "type": "fixedCollection",
          "typeOptions": {
            "multipleValues": true
          },
          "default": {},
          "options": [
            {
              "name": "property",
              "displayName": "Property",
              "values": [
                {
                  "displayName": "Property Name",
                  "name": "name",
                  "type": "string",
                  "default": "",
                  "description": "Name of the property to set"
                },
                {
                  "displayName": "Property Value",
                  "name": "value",
                  "type": "string",
                  "default": "",
                  "description": "Value of the property to set"
                }
              ]
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "create"
          ],
          "resource": [
            "customer"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "list",
      "options": [
        {
          "name": "List",
          "value": "list",
          "description": "Return the invoices",
          "action": "List an invoice"
        },
        {
          "name": "PDF Invoice URL",
          "value": "pdfUrl",
          "description": "Get URL for the invoice PDF",
          "action": "Get URL for the invoice PDF"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "invoice"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Max Results",
      "name": "maxResults",
      "type": "number",
      "default": 10,
      "description": "Max. amount of results to return(< 100).",
      "displayOptions": {
        "show": {
          "operation": [
            "list"
          ],
          "resource": [
            "invoice"
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 100
      }
    },
    {
      "displayName": "Filters",
      "name": "filters",
      "type": "fixedCollection",
      "default": {},
      "description": "Filter for invoices",
      "options": [
        {
          "name": "date",
          "displayName": "Invoice Date",
          "values": [
            {
              "displayName": "Operation",
              "name": "operation",
              "type": "options",
              "noDataExpression": true,
              "options": [
                {
                  "name": "Is",
                  "value": "is"
                },
                {
                  "name": "Is Not",
                  "value": "is_not"
                },
                {
                  "name": "After",
                  "value": "after"
                },
                {
                  "name": "Before",
                  "value": "before"
                }
              ],
              "default": "after",
              "description": "Operation to decide where the data should be mapped to"
            },
            {
              "displayName": "Date",
              "name": "value",
              "type": "dateTime",
              "default": "",
              "description": "Query date"
            }
          ]
        },
        {
          "name": "total",
          "displayName": "Invoice Amount",
          "values": [
            {
              "displayName": "Operation",
              "name": "operation",
              "type": "options",
              "noDataExpression": true,
              "options": [
                {
                  "name": "Greater Equal Than",
                  "value": "gte"
                },
                {
                  "name": "Greater Than",
                  "value": "gt"
                },
                {
                  "name": "Is",
                  "value": "is"
                },
                {
                  "name": "Is Not",
                  "value": "is_not"
                },
                {
                  "name": "Less Equal Than",
                  "value": "lte"
                },
                {
                  "name": "Less Than",
                  "value": "lt"
                }
              ],
              "default": "gt",
              "description": "Operation to decide where the data should be mapped to"
            },
            {
              "displayName": "Amount",
              "name": "value",
              "type": "number",
              "typeOptions": {
                "numberPrecision": 2
              },
              "default": 0,
              "description": "Query amount"
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "list"
          ],
          "resource": [
            "invoice"
          ]
        }
      },
      "typeOptions": {
        "multipleValues": true
      }
    },
    {
      "displayName": "Invoice ID",
      "name": "invoiceId",
      "type": "string",
      "default": "",
      "description": "The ID of the invoice to get",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "pdfUrl"
          ],
          "resource": [
            "invoice"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "delete",
      "options": [
        {
          "name": "Cancel",
          "value": "cancel",
          "description": "Cancel a subscription",
          "action": "Cancel a subscription"
        },
        {
          "name": "Delete",
          "value": "delete",
          "description": "Delete a subscription",
          "action": "Delete a subscription"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "subscription"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Subscription ID",
      "name": "subscriptionId",
      "type": "string",
      "default": "",
      "description": "The ID of the subscription to cancel",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "cancel"
          ],
          "resource": [
            "subscription"
          ]
        }
      }
    },
    {
      "displayName": "Schedule End of Term",
      "name": "endOfTerm",
      "type": "boolean",
      "default": false,
      "description": "Whether it will not cancel it directly in will instead schedule the cancelation for the end of the term",
      "displayOptions": {
        "show": {
          "operation": [
            "cancel"
          ],
          "resource": [
            "subscription"
          ]
        }
      }
    },
    {
      "displayName": "Subscription ID",
      "name": "subscriptionId",
      "type": "string",
      "default": "",
      "description": "The ID of the subscription to delete",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "delete"
          ],
          "resource": [
            "subscription"
          ]
        }
      }
    }
  ]

operations:
  [
    {
      "operation": "create",
      "name": "Create",
      "description": "Create a customer",
      "resource": "customer"
    },
    {
      "operation": "list",
      "name": "List",
      "description": "Return the invoices",
      "resource": "invoice"
    },
    {
      "operation": "pdfUrl",
      "name": "PDF Invoice URL",
      "description": "Get URL for the invoice PDF",
      "resource": "invoice"
    },
    {
      "operation": "cancel",
      "name": "Cancel",
      "description": "Cancel a subscription",
      "resource": "subscription"
    },
    {
      "operation": "delete",
      "name": "Delete",
      "description": "Delete a subscription",
      "resource": "subscription"
    }
  ]


