# nodes

node_type: phantombuster
package_name: n8n-nodes-base
display_name: Phantombuster
description: Consume Phantombuster API
category: input
development_style: programmatic
version: 1
credentials_required: [{"name":"phantombusterApi","required":true}]
updated_at: 2025-06-12 12:00:45
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: PhantomBuster node documentation
  description: Learn how to use the PhantomBuster node in n8n. Follow technical documentation to integrate PhantomBuster node into your workflows.
  contentType: [integration, reference]
  ---

  # PhantomBuster node

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

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

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

  ## Operations

  * Agent
      * Delete an agent by ID.
      * Get an agent by ID.
      * Get all agents of the current user's organization.
      * Get the output of the most recent container of an agent.
      * Add an agent to the launch queue.

  ## Templates and examples

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

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

properties_schema:
  [{"displayName":"Resource","name":"resource","type":"options","noDataExpression":true,"options":[{"name":"Agent","value":"agent"}],"default":"agent"},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["agent"]}},"options":[{"name":"Delete","value":"delete","description":"Delete an agent by ID","action":"Delete an agent"},{"name":"Get","value":"get","description":"Get an agent by ID","action":"Get an agent"},{"name":"Get Many","value":"getAll","description":"Get many agents of the current user's organization","action":"Get many agents"},{"name":"Get Output","value":"getOutput","description":"Get the output of the most recent container of an agent","action":"Get the output of an agent"},{"name":"Launch","value":"launch","description":"Add an agent to the launch queue","action":"Add an agent to the launch queue"}],"default":"launch"},{"displayName":"Agent Name or ID","name":"agentId","type":"options","description":"Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>","typeOptions":{"loadOptionsMethod":"getAgents"},"required":true,"displayOptions":{"show":{"operation":["delete"],"resource":["agent"]}},"default":""},{"displayName":"Agent ID","name":"agentId","type":"string","required":true,"displayOptions":{"show":{"operation":["get"],"resource":["agent"]}},"default":""},{"displayName":"Return All","name":"returnAll","type":"boolean","displayOptions":{"show":{"operation":["getAll"],"resource":["agent"]}},"default":false,"description":"Whether to return all results or only up to a given limit"},{"displayName":"Limit","name":"limit","type":"number","displayOptions":{"show":{"operation":["getAll"],"resource":["agent"],"returnAll":[false]}},"typeOptions":{"minValue":1,"maxValue":50},"default":25,"description":"Max number of results to return"},{"displayName":"Agent Name or ID","name":"agentId","type":"options","description":"Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>","typeOptions":{"loadOptionsMethod":"getAgents"},"required":true,"displayOptions":{"show":{"operation":["getOutput"],"resource":["agent"]}},"default":""},{"displayName":"Resolve Data","name":"resolveData","type":"boolean","default":true,"displayOptions":{"show":{"operation":["getOutput"],"resource":["agent"]}},"description":"By default the outpout is presented as string. If this option gets activated, it will resolve the data automatically."},{"displayName":"Additional Fields","name":"additionalFields","type":"collection","placeholder":"Add Field","displayOptions":{"show":{"resource":["agent"],"operation":["getOutput"]}},"default":{},"options":[{"displayName":"Prev Container ID","name":"prevContainerId","type":"string","default":"","description":"If set, the output will be retrieved from the container after the specified previous container ID"},{"displayName":"Prev Status","name":"prevStatus","type":"options","options":[{"name":"Finished","value":"finished"},{"name":"Launch Error","value":"lauch error"},{"name":"Never Launched","value":"never launched"},{"name":"Running","value":"running"},{"name":"Starting","value":"starting"},{"name":"Unknown","value":"unknown"}],"default":"","description":"If set, allows to define which status was previously retrieved on user-side"},{"displayName":"Pre Runtime Event Index","name":"prevRuntimeEventIndex","type":"number","default":0,"description":"If set, the container's runtime events will be returned in the response starting from the provided previous runtime event index"}]},{"displayName":"Agent Name or ID","name":"agentId","type":"options","description":"Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>","typeOptions":{"loadOptionsMethod":"getAgents"},"required":true,"displayOptions":{"show":{"operation":["launch"],"resource":["agent"]}},"default":""},{"displayName":"Resolve Data","name":"resolveData","type":"boolean","default":true,"displayOptions":{"show":{"operation":["launch"],"resource":["agent"]}},"description":"By default the launch just include the container ID. If this option gets activated, it will resolve the data automatically."},{"displayName":"JSON Parameters","name":"jsonParameters","type":"boolean","default":false,"displayOptions":{"show":{"operation":["launch"],"resource":["agent"]}}},{"displayName":"Additional Fields","name":"additionalFields","type":"collection","placeholder":"Add Field","displayOptions":{"show":{"resource":["agent"],"operation":["launch"]}},"default":{},"options":[{"displayName":"Arguments (JSON)","name":"argumentsJson","type":"json","displayOptions":{"show":{"/jsonParameters":[true]}},"default":"","description":"Agent argument. Can either be a JSON string or a plain object. The argument can be retrieved with buster.argument in the agent’s script."},{"displayName":"Arguments","name":"argumentsUi","placeholder":"Add Argument","type":"fixedCollection","default":{},"typeOptions":{"multipleValues":true},"displayOptions":{"show":{"/jsonParameters":[false]}},"options":[{"name":"argumentValues","displayName":"Argument","values":[{"displayName":"Key","name":"key","type":"string","default":"","description":"Name of the argument key to add"},{"displayName":"Value","name":"value","type":"string","default":"","description":"Value to set for the argument key"}]}]},{"displayName":"Bonus Argument","name":"bonusArgumentUi","placeholder":"Add Bonus Argument","type":"fixedCollection","default":{},"typeOptions":{"multipleValues":true},"displayOptions":{"show":{"/jsonParameters":[false]}},"options":[{"name":"bonusArgumentValue","displayName":"Bonus Argument","values":[{"displayName":"Key","name":"key","type":"string","default":"","description":"Name of the argument key to add"},{"displayName":"Value","name":"value","type":"string","default":"","description":"Value to set for the argument key"}]}]},{"displayName":"Bonus Argument (JSON)","name":"bonusArgumentJson","type":"string","displayOptions":{"show":{"/jsonParameters":[true]}},"default":"","description":"Agent bonus argument. Can either be a JSON string or a plain object. This bonus argument is single-use, it will only be used for the current launch. If present, it will be merged with the original argument, resulting in an effective argument that can be retrieved with buster.argument in the agent’s script."},{"displayName":"Manual Launch","name":"manualLaunch","type":"boolean","default":false,"description":"Whether the agent will be considered as \"launched manually\""},{"displayName":"Max Instance Count","name":"maxInstanceCount","type":"number","default":0,"description":"If set, the agent will only be launched if the number of already running instances is below the specified number"},{"displayName":"Save Argument","name":"saveArgument","type":"string","default":"","description":"If true, argument will be saved as the default launch options for the agent"}]}]

operations:
  [{"type":"resource","resource":"agent","name":"Agent"},{"type":"operation","operation":"delete","name":"Delete","action":"Delete an agent","resources":["agent"]},{"type":"operation","operation":"get","name":"Get","action":"Get an agent","resources":["agent"]},{"type":"operation","operation":"getAll","name":"Get Many","action":"Get many agents","resources":["agent"]},{"type":"operation","operation":"getOutput","name":"Get Output","action":"Get the output of an agent","resources":["agent"]},{"type":"operation","operation":"launch","name":"Launch","action":"Add an agent to the launch queue","resources":["agent"]}]


node_type: philipsHue
package_name: n8n-nodes-base
display_name: Philips Hue
description: Consume Philips Hue API
category: input
development_style: programmatic
version: 1
credentials_required: [{"name":"philipsHueOAuth2Api","required":true}]
updated_at: 2025-06-12 12:00:45
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: Philips Hue node documentation
  description: Learn how to use the Philips Hue node in n8n. Follow technical documentation to integrate Philips Hue node into your workflows.
  contentType: [integration, reference]
  ---

  # Philips Hue node

  Use the Philips Hue node to automate work in Philips Hue, and integrate Philips Hue with other applications. n8n has built-in support for a wide range of Philips Hue features, including deleting, retrieving, and updating lights. 

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

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

  ## Operations

  * Light
      * Delete a light
      * Retrieve a light
      * Retrieve all lights
      * Update a light

  ## Templates and examples

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

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

properties_schema:
  [{"displayName":"Resource","name":"resource","type":"options","noDataExpression":true,"options":[{"name":"Light","value":"light"}],"default":"light"},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["light"]}},"options":[{"name":"Delete","value":"delete","description":"Delete a light","action":"Delete a light"},{"name":"Get","value":"get","description":"Retrieve a light","action":"Get a light"},{"name":"Get Many","value":"getAll","description":"Retrieve many lights","action":"Get many lights"},{"name":"Update","value":"update","description":"Update a light","action":"Update a light"}],"default":"update"},{"displayName":"Light ID","name":"lightId","type":"string","required":true,"displayOptions":{"show":{"operation":["delete"],"resource":["light"]}},"default":""},{"displayName":"Return All","name":"returnAll","type":"boolean","displayOptions":{"show":{"operation":["getAll"],"resource":["light"]}},"default":false,"description":"Whether to return all results or only up to a given limit"},{"displayName":"Limit","name":"limit","type":"number","displayOptions":{"show":{"operation":["getAll"],"resource":["light"],"returnAll":[false]}},"typeOptions":{"minValue":1,"maxValue":500},"default":100,"description":"Max number of results to return"},{"displayName":"Light ID","name":"lightId","type":"string","required":true,"displayOptions":{"show":{"operation":["get"],"resource":["light"]}},"default":""},{"displayName":"Light Name or ID","name":"lightId","type":"options","description":"Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>","typeOptions":{"loadOptionsMethod":"getLights"},"required":true,"displayOptions":{"show":{"operation":["update"],"resource":["light"]}},"default":""},{"displayName":"On","name":"on","type":"boolean","required":true,"displayOptions":{"show":{"operation":["update"],"resource":["light"]}},"default":true,"description":"On/Off state of the light"},{"displayName":"Additional Fields","name":"additionalFields","type":"collection","placeholder":"Add Field","displayOptions":{"show":{"resource":["light"],"operation":["update"]}},"default":{},"options":[{"displayName":"Alert Effect","name":"alert","type":"options","options":[{"name":"None","value":"none","description":"The light is not performing an alert effect"},{"name":"Select","value":"select","description":"The light is performing one breathe cycle"},{"name":"LSelect","value":"lselect","description":"The light is performing breathe cycles for 15 seconds or until an \"alert\": \"none\" command is received"}],"default":"","description":"The alert effect, is a temporary change to the bulb’s state"},{"displayName":"Brightness","name":"bri","type":"number","typeOptions":{"minValue":1,"maxValue":254},"default":100,"description":"The brightness value to set the light to. Brightness is a scale from 1 (the minimum the light is capable of) to 254 (the maximum)."},{"displayName":"Brightness Increments","name":"bri_inc","type":"number","typeOptions":{"minValue":-254,"maxValue":254},"default":0,"description":"Increments or decrements the value of the brightness. This value is ignored if the Brightness attribute is provided."},{"displayName":"Color Temperature","name":"ct","type":"number","default":0,"description":"The Mired color temperature of the light. 2012 connected lights are capable of 153 (6500K) to 500 (2000K)."},{"displayName":"Color Temperature Increments","name":"ct_inc","type":"number","typeOptions":{"minValue":-65534,"maxValue":65534},"default":0,"description":"Increments or decrements the value of the ct. ct_inc is ignored if the ct attribute is provided."},{"displayName":"Coordinates","name":"xy","type":"string","default":"","placeholder":"0.64394,0.33069","description":"The x and y coordinates of a color in CIE color space. The first entry is the x coordinate and the second entry is the y coordinate. Both x and y are between 0 and 1"},{"displayName":"Coordinates Increments","name":"xy_inc","type":"string","default":"","placeholder":"0.5,0.5","description":"Increments or decrements the value of the xy. This value is ignored if the Coordinates attribute is provided. Any ongoing color transition is stopped. Max value [0.5, 0.5]"},{"displayName":"Dynamic Effect","name":"effect","type":"options","options":[{"name":"None","value":"none"},{"name":"Color Loop","value":"colorloop"}],"default":"","description":"The dynamic effect of the light"},{"displayName":"Hue","name":"hue","type":"number","typeOptions":{"minValue":0,"maxValue":65535},"default":0,"description":"The hue value to set light to.The hue value is a wrapping value between 0 and 65535. Both 0 and 65535 are red, 25500 is green and 46920 is blue."},{"displayName":"Hue Increments","name":"hue_inc","type":"number","typeOptions":{"minValue":-65534,"maxValue":65534},"default":0,"description":"Increments or decrements the value of the hue. Hue Increments is ignored if the Hue attribute is provided."},{"displayName":"Saturation","name":"sat","type":"number","typeOptions":{"minValue":0,"maxValue":254},"default":0,"description":"Saturation of the light. 254 is the most saturated (colored) and 0 is the least saturated (white)."},{"displayName":"Saturation Increments","name":"sat_inc","type":"number","typeOptions":{"minValue":-254,"maxValue":254},"default":0,"description":"Increments or decrements the value of the sat. This value is ignored if the Saturation attribute is provided."},{"displayName":"Transition Time","name":"transitiontime","type":"number","typeOptions":{"minVale":1},"default":4,"description":"The duration in seconds of the transition from the light’s current state to the new state"}]}]

operations:
  [{"type":"resource","resource":"light","name":"Light"},{"type":"operation","operation":"delete","name":"Delete","action":"Delete a light","resources":["light"]},{"type":"operation","operation":"get","name":"Get","action":"Get a light","resources":["light"]},{"type":"operation","operation":"getAll","name":"Get Many","action":"Get many lights","resources":["light"]},{"type":"operation","operation":"update","name":"Update","action":"Update a light","resources":["light"]}]


node_type: pipedrive
package_name: n8n-nodes-base
display_name: Pipedrive
description: Create and edit data in Pipedrive
category: transform
development_style: programmatic
version: 1
updated_at: 2025-06-12 12:00:45
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: Pipedrive node documentation
  description: Learn how to use the Pipedrive node in n8n. Follow technical documentation to integrate Pipedrive node into your workflows.
  contentType: [integration, reference]
  priority: medium
  ---

  # Pipedrive node

  Use the Pipedrive node to automate work in Pipedrive, and integrate Pipedrive with other applications. n8n has built-in support for a wide range of Pipedrive features, including creating, updating, deleting, and getting activity, files, notes, organizations, and leads. 

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

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

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

  ## Operations

  * Activity
      * Create an activity
      * Delete an activity
      * Get data of an activity
      * Get data of all activities
      * Update an activity
  * Deal
      * Create a deal
      * Delete a deal
      * Duplicate a deal
      * Get data of a deal
      * Get data of all deals
      * Search a deal
      * Update a deal
  * Deal Activity
      * Get all activities of a deal
  * Deal Product
      * Add a product to a deal
      * Get all products in a deal
      * Remove a product from a deal
      * Update a product in a deal
  * File
      * Create a file
      * Delete a file
      * Download a file
      * Get data of a file
  * Lead
      * Create a lead
      * Delete a lead
      * Get data of a lead
      * Get data of all leads
      * Update a lead
  * Note
      * Create a note
      * Delete a note
      * Get data of a note
      * Get data of all notes
      * Update a note
  * Organization
      * Create an organization
      * Delete an organization
      * Get data of an organization
      * Get data of all organizations
      * Update an organization
      * Search organizations
  * Person
      * Create a person
      * Delete a person
      * Get data of a person
      * Get data of all persons
      * Search all persons
      * Update a person
  * Product
      * Get data of all products

  ## Templates and examples

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

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

properties_schema:
  [{"displayName":"Authentication","name":"authentication","type":"options","options":[{"name":"API Token","value":"apiToken"},{"name":"OAuth2","value":"oAuth2"}],"default":"apiToken"},{"displayName":"Resource","name":"resource","type":"options","noDataExpression":true,"options":[{"name":"Activity","value":"activity"},{"name":"Deal","value":"deal"},{"name":"Deal Activity","value":"dealActivity"},{"name":"Deal Product","value":"dealProduct"},{"name":"File","value":"file"},{"name":"Lead","value":"lead"},{"name":"Note","value":"note"},{"name":"Organization","value":"organization"},{"name":"Person","value":"person"},{"name":"Product","value":"product"}],"default":"deal"},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["activity"]}},"options":[{"name":"Create","value":"create","description":"Create an activity","action":"Create an activity"},{"name":"Delete","value":"delete","description":"Delete an activity","action":"Delete an activity"},{"name":"Get","value":"get","description":"Get data of an activity","action":"Get an activity"},{"name":"Get Many","value":"getAll","description":"Get data of many activities","action":"Get many activities"},{"name":"Update","value":"update","description":"Update an activity","action":"Update an activity"}],"default":"create"},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["deal"]}},"options":[{"name":"Create","value":"create","description":"Create a deal","action":"Create a deal"},{"name":"Delete","value":"delete","description":"Delete a deal","action":"Delete a deal"},{"name":"Duplicate","value":"duplicate","description":"Duplicate a deal","action":"Duplicate a deal"},{"name":"Get","value":"get","description":"Get data of a deal","action":"Get a deal"},{"name":"Get Many","value":"getAll","description":"Get data of many deals","action":"Get many deals"},{"name":"Search","value":"search","description":"Search a deal","action":"Search a deal"},{"name":"Update","value":"update","description":"Update a deal","action":"Update a deal"}],"default":"create"},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["dealActivity"]}},"options":[{"name":"Get Many","value":"getAll","description":"Get many activities of a deal","action":"Get many deal activities"}],"default":"getAll"},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["dealProduct"]}},"options":[{"name":"Add","value":"add","description":"Add a product to a deal","action":"Add a deal product"},{"name":"Get Many","value":"getAll","description":"Get many products in a deal","action":"Get many deal products"},{"name":"Remove","value":"remove","description":"Remove a product from a deal","action":"Remove a deal product"},{"name":"Update","value":"update","description":"Update a product in a deal","action":"Update a deal product"}],"default":"add"},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["file"]}},"options":[{"name":"Create","value":"create","description":"Create a file","action":"Create 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 data of a file","action":"Get a file"},{"name":"Update","value":"update","description":"Update file details","action":"update details of a file"}],"default":"create"},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["lead"]}},"options":[{"name":"Create","value":"create","description":"Create a lead","action":"Create a lead"},{"name":"Delete","value":"delete","description":"Delete a lead","action":"Delete a lead"},{"name":"Get","value":"get","description":"Get data of a lead","action":"Get a lead"},{"name":"Get Many","value":"getAll","description":"Get data of many leads","action":"Get many leads"},{"name":"Update","value":"update","description":"Update a lead","action":"Update a lead"}],"default":"create"},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["note"]}},"options":[{"name":"Create","value":"create","description":"Create a note","action":"Create a note"},{"name":"Delete","value":"delete","description":"Delete a note","action":"Delete a note"},{"name":"Get","value":"get","description":"Get data of a note","action":"Get a note"},{"name":"Get Many","value":"getAll","description":"Get data of many notes","action":"Get many notes"},{"name":"Update","value":"update","description":"Update a note","action":"Update a note"}],"default":"create"},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["organization"]}},"options":[{"name":"Create","value":"create","description":"Create an organization","action":"Create an organization"},{"name":"Delete","value":"delete","description":"Delete an organization","action":"Delete an organization"},{"name":"Get","value":"get","description":"Get data of an organization","action":"Get an organization"},{"name":"Get Many","value":"getAll","description":"Get data of many organizations","action":"Get many organizations"},{"name":"Search","value":"search","description":"Search organizations","action":"Search an organization"},{"name":"Update","value":"update","description":"Update an organization","action":"Update an organization"}],"default":"create"},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["person"]}},"options":[{"name":"Create","value":"create","description":"Create a person","action":"Create a person"},{"name":"Delete","value":"delete","description":"Delete a person","action":"Delete a person"},{"name":"Get","value":"get","description":"Get data of a person","action":"Get a person"},{"name":"Get Many","value":"getAll","description":"Get data of many persons","action":"Get many people"},{"name":"Search","value":"search","description":"Search all persons","action":"Search a person"},{"name":"Update","value":"update","description":"Update a person","action":"Update a person"}],"default":"create"},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["product"]}},"options":[{"name":"Get Many","value":"getAll","description":"Get data of many products","action":"Get many products"}],"default":"getAll"},{"displayName":"Subject","name":"subject","type":"string","default":"","required":true,"displayOptions":{"show":{"operation":["create"],"resource":["activity"]}},"description":"The subject of the activity to create"},{"displayName":"Done","name":"done","type":"options","displayOptions":{"show":{"operation":["create"],"resource":["activity"]}},"options":[{"name":"Not Done","value":"0"},{"name":"Done","value":"1"}],"default":"0","description":"Whether the activity is done or not"},{"displayName":"Type","name":"type","type":"string","default":"","required":true,"displayOptions":{"show":{"operation":["create"],"resource":["activity"]}},"placeholder":"call","description":"Type of the activity like \"call\", \"meeting\", etc"},{"displayName":"Additional Fields","name":"additionalFields","type":"collection","placeholder":"Add Field","displayOptions":{"show":{"operation":["create"],"resource":["activity"]}},"default":{},"options":[{"displayName":"Deal ID","name":"deal_id","type":"number","default":0,"description":"ID of the deal this activity will be associated with"},{"displayName":"Due Date","name":"due_date","type":"dateTime","default":"","description":"Due Date to activity be done YYYY-MM-DD"},{"displayName":"Note","name":"note","type":"string","typeOptions":{"rows":5},"default":"","description":"Note of the activity (HTML format)"},{"displayName":"Organization Name or ID","name":"org_id","type":"options","typeOptions":{"loadOptionsMethod":"getOrganizationIds"},"default":"","description":"ID of the organization this activity will be associated with. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Person ID","name":"person_id","type":"number","default":0,"description":"ID of the person this activity will be associated with"},{"displayName":"User Name or ID","name":"user_id","type":"options","typeOptions":{"loadOptionsMethod":"getUserIds"},"default":"","description":"ID of the active user whom the activity will be assigned to. If omitted, the activity will be assigned to the authorized user. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"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"}]}]}]},{"displayName":"Activity ID","name":"activityId","type":"number","displayOptions":{"show":{"operation":["delete"],"resource":["activity"]}},"default":0,"required":true,"description":"ID of the activity to delete"},{"displayName":"Activity ID","name":"activityId","type":"number","displayOptions":{"show":{"operation":["get"],"resource":["activity"]}},"default":0,"required":true,"description":"ID of the activity to get"},{"displayName":"Activity ID","name":"activityId","type":"number","displayOptions":{"show":{"operation":["update"],"resource":["activity"]}},"default":0,"required":true,"description":"ID of the activity to update"},{"displayName":"Update Fields","name":"updateFields","type":"collection","placeholder":"Add Field","displayOptions":{"show":{"operation":["update"],"resource":["activity"]}},"default":{},"options":[{"displayName":"Deal ID","name":"deal_id","type":"number","default":0,"description":"ID of the deal this activity will be associated with"},{"displayName":"Due Date","name":"due_date","type":"dateTime","default":"","description":"Due Date to activity be done YYYY-MM-DD"},{"displayName":"Done","name":"done","type":"options","options":[{"name":"Not Done","value":"0"},{"name":"Done","value":"1"}],"default":"0","description":"Whether the activity is done or not"},{"displayName":"Note","name":"note","type":"string","typeOptions":{"rows":5},"default":"","description":"Note of the activity (HTML format)"},{"displayName":"Organization Name or ID","name":"org_id","type":"options","typeOptions":{"loadOptionsMethod":"getOrganizationIds"},"default":"","description":"ID of the organization this activity will be associated with. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Person ID","name":"person_id","type":"number","default":0,"description":"ID of the person this activity will be associated with"},{"displayName":"Subject","name":"subject","type":"string","default":"","description":"The subject of the activity"},{"displayName":"Type","name":"type","type":"string","default":"","placeholder":"call","description":"Type of the activity like \"call\", \"meeting\", etc"},{"displayName":"User Name or ID","name":"user_id","type":"options","typeOptions":{"loadOptionsMethod":"getUserIds"},"default":"","description":"ID of the active user whom the activity will be assigned to. If omitted, the activity will be assigned to the authorized user. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"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"}]}]}]},{"displayName":"Title","name":"title","type":"string","default":"","required":true,"displayOptions":{"show":{"operation":["create"],"resource":["deal"]}},"description":"The title of the deal to create"},{"displayName":"Associate With","name":"associateWith","type":"options","options":[{"name":"Organization","value":"organization"},{"name":"Person","value":"person"}],"default":"organization","description":"Type of entity to link to this deal","required":true,"displayOptions":{"show":{"resource":["deal"],"operation":["create"]}}},{"displayName":"Organization ID","name":"org_id","type":"number","default":0,"description":"ID of the organization this deal will be associated with","required":true,"displayOptions":{"show":{"operation":["create"],"resource":["deal"],"associateWith":["organization"]}}},{"displayName":"Person ID","name":"person_id","type":"number","default":0,"description":"ID of the person this deal will be associated with","displayOptions":{"show":{"operation":["create"],"resource":["deal"],"associateWith":["person"]}}},{"displayName":"Additional Fields","name":"additionalFields","type":"collection","placeholder":"Add Field","displayOptions":{"show":{"operation":["create"],"resource":["deal"]}},"default":{},"options":[{"displayName":"Currency","name":"currency","type":"string","default":"USD","description":"Currency of the deal. Accepts a 3-character currency code. Like EUR, USD, ..."},{"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 or ID","name":"name","type":"options","typeOptions":{"loadOptionsMethod":"getDealCustomFields"},"default":"","description":"Name of the property to set. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Property Value","name":"value","type":"string","default":"","description":"Value of the property to set"}]}]},{"displayName":"Label Name or ID","name":"label","type":"options","description":"Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>","typeOptions":{"loadOptionsMethod":"getDealLabels"},"default":""},{"displayName":"Lost Reason","name":"lost_reason","type":"string","default":"","description":"Reason why the deal was lost"},{"displayName":"Organization ID","name":"org_id","type":"number","default":0,"displayOptions":{"show":{"/associateWith":["person"]}},"description":"ID of the organization this deal will be associated with"},{"displayName":"Person ID","name":"person_id","type":"number","default":0,"displayOptions":{"show":{"/associateWith":["organization"]}},"description":"ID of the person this deal will be associated with"},{"displayName":"Probability","name":"probability","type":"number","typeOptions":{"minValue":0,"maxValue":100},"default":0,"description":"Deal success probability percentage"},{"displayName":"Stage Name or ID","name":"stage_id","type":"options","typeOptions":{"loadOptionsMethod":"getStageIds"},"default":"","description":"ID of the stage this deal will be placed in a pipeline. If omitted, the deal will be placed in the first stage of the default pipeline. (PIPELINE > STAGE). Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Status","name":"status","type":"options","options":[{"name":"Open","value":"open"},{"name":"Won","value":"won"},{"name":"Lost","value":"lost"},{"name":"Deleted","value":"deleted"}],"default":"open","description":"The status of the deal. If not provided it will automatically be set to \"open\"."},{"displayName":"User Name or ID","name":"user_id","type":"options","typeOptions":{"loadOptionsMethod":"getUserIds"},"default":"","description":"ID of the active user whom the activity will be assigned to. If omitted, the activity will be assigned to the authorized user. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Value","name":"value","type":"number","default":0,"description":"Value of the deal. If not set it will automatically be set to 0."},{"displayName":"Visible To","name":"visible_to","type":"options","options":[{"name":"Owner & Followers (Private)","value":"1"},{"name":"Entire Company (Shared)","value":"3"}],"default":"3","description":"Visibility of the deal. If omitted, visibility will be set to the default visibility setting of this item type for the authorized user."}]},{"displayName":"Deal ID","name":"dealId","type":"number","displayOptions":{"show":{"operation":["delete"],"resource":["deal"]}},"default":0,"required":true,"description":"ID of the deal to delete"},{"displayName":"Deal ID","name":"dealId","type":"number","displayOptions":{"show":{"operation":["duplicate"],"resource":["deal"]}},"default":0,"required":true,"description":"ID of the deal to duplicate"},{"displayName":"Deal ID","name":"dealId","type":"number","displayOptions":{"show":{"operation":["get"],"resource":["deal"]}},"default":0,"required":true,"description":"ID of the deal to get"},{"displayName":"Deal ID","name":"dealId","type":"number","displayOptions":{"show":{"operation":["update"],"resource":["deal"]}},"default":0,"required":true,"description":"ID of the deal to update"},{"displayName":"Update Fields","name":"updateFields","type":"collection","placeholder":"Add Field","displayOptions":{"show":{"operation":["update"],"resource":["deal"]}},"default":{},"options":[{"displayName":"Currency","name":"currency","type":"string","default":"USD","description":"Currency of the deal. Accepts a 3-character currency code. Like EUR, USD, ..."},{"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 or ID","name":"name","type":"options","typeOptions":{"loadOptionsMethod":"getDealCustomFields"},"default":"","description":"Name of the custom field to set. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Property Value","name":"value","type":"string","default":"","description":"Value of the property to set"}]}]},{"displayName":"User Name or ID","name":"user_id","type":"options","typeOptions":{"loadOptionsMethod":"getUserIds"},"default":"","description":"ID of the active user whom the activity will be assigned to. If omitted, the activity will be assigned to the authorized user. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Label Name or ID","name":"label","type":"options","description":"Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>","typeOptions":{"loadOptionsMethod":"getDealLabels"},"default":""},{"displayName":"Lost Reason","name":"lost_reason","type":"string","default":"","description":"Reason why the deal was lost"},{"displayName":"Organization Name or ID","name":"org_id","type":"options","typeOptions":{"loadOptionsMethod":"getOrganizationIds"},"default":"","description":"ID of the organization this deal will be associated with. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Person ID","name":"person_id","type":"number","default":0,"description":"ID of the person this deal will be associated with"},{"displayName":"Probability","name":"probability","type":"number","typeOptions":{"minValue":0,"maxValue":100},"default":0,"description":"Deal success probability percentage"},{"displayName":"Stage Name or ID","name":"stage_id","type":"options","typeOptions":{"loadOptionsMethod":"getStageIds"},"default":"","description":"ID of the stage this deal will be placed in a pipeline. If omitted, the deal will be placed in the first stage of the default pipeline. (PIPELINE > STAGE). Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Status","name":"status","type":"options","options":[{"name":"Open","value":"open"},{"name":"Won","value":"won"},{"name":"Lost","value":"lost"},{"name":"Deleted","value":"deleted"}],"default":"open","description":"The status of the deal. If not provided it will automatically be set to \"open\"."},{"displayName":"Title","name":"title","type":"string","default":"","description":"The title of the deal"},{"displayName":"Value","name":"value","type":"number","default":0,"description":"Value of the deal. If not set it will automatically be set to 0."},{"displayName":"Visible To","name":"visible_to","type":"options","options":[{"name":"Owner & Followers (Private)","value":"1"},{"name":"Entire Company (Shared)","value":"3"}],"default":"3","description":"Visibility of the deal. If omitted, visibility will be set to the default visibility setting of this item type for the authorized user."}]},{"displayName":"Deal Name or ID","name":"dealId","type":"options","default":"","typeOptions":{"loadOptionsMethod":"getDeals"},"required":true,"displayOptions":{"show":{"operation":["add"],"resource":["dealProduct"]}},"description":"The ID of the deal to add a product to. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Product Name or ID","name":"productId","type":"options","default":"","typeOptions":{"loadOptionsMethod":"getProducts"},"required":true,"displayOptions":{"show":{"operation":["add"],"resource":["dealProduct"]}},"description":"The ID of the product to add to a deal. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Item Price","name":"item_price","type":"number","typeOptions":{"numberPrecision":2},"default":0,"required":true,"description":"Price at which to add or update this product in a deal","displayOptions":{"show":{"operation":["add"],"resource":["dealProduct"]}}},{"displayName":"Quantity","name":"quantity","type":"number","default":1,"typeOptions":{"minValue":1},"required":true,"description":"How many items of this product to add/update in a deal","displayOptions":{"show":{"operation":["add"],"resource":["dealProduct"]}}},{"displayName":"Additional Fields","name":"additionalFields","type":"collection","placeholder":"Add Field","displayOptions":{"show":{"operation":["add"],"resource":["dealProduct"]}},"default":{},"options":[{"displayName":"Comments","name":"comments","type":"string","typeOptions":{"rows":4},"default":"","description":"Text to describe this product-deal attachment"},{"displayName":"Discount Percentage","name":"discount_percentage","type":"number","default":0,"typeOptions":{"minValue":0,"maxValue":100},"description":"Percentage of discount to apply"},{"displayName":"Product Variation ID","name":"product_variation_id","type":"string","default":"","description":"ID of the product variation to use"}]},{"displayName":"Deal Name or ID","name":"dealId","type":"options","default":"","typeOptions":{"loadOptionsMethod":"getDeals"},"required":true,"displayOptions":{"show":{"operation":["update"],"resource":["dealProduct"]}},"description":"The ID of the deal whose product to update. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Product Attachment Name or ID","name":"productAttachmentId","type":"options","default":"","typeOptions":{"loadOptionsMethod":"getProductsDeal","loadOptionsDependsOn":["dealId"]},"required":true,"displayOptions":{"show":{"operation":["update"],"resource":["dealProduct"]}},"description":"ID of the deal-product (the ID of the product attached to the deal). Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Update Fields","name":"updateFields","type":"collection","placeholder":"Add Field","displayOptions":{"show":{"operation":["update"],"resource":["dealProduct"]}},"default":{},"options":[{"displayName":"Comments","name":"comments","type":"string","typeOptions":{"rows":4},"default":"","description":"Text to describe this product-deal attachment"},{"displayName":"Discount Percentage","name":"discount_percentage","type":"number","default":0,"typeOptions":{"minValue":0,"maxValue":100},"description":"Percentage of discount to apply"},{"displayName":"Item Price","name":"item_price","type":"number","typeOptions":{"numberPrecision":2},"default":0,"description":"Price at which to add or update this product in a deal"},{"displayName":"Quantity","name":"quantity","type":"number","default":1,"typeOptions":{"minValue":1},"description":"How many items of this product to add/update in a deal"},{"displayName":"Product Variation ID","name":"product_variation_id","type":"string","default":"","description":"ID of the product variation to use"}]},{"displayName":"Deal Name or ID","name":"dealId","type":"options","default":"","typeOptions":{"loadOptionsMethod":"getDeals"},"required":true,"displayOptions":{"show":{"operation":["remove"],"resource":["dealProduct"]}},"description":"The ID of the deal whose product to remove. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Product Attachment Name or ID","name":"productAttachmentId","type":"options","default":"","typeOptions":{"loadOptionsMethod":"getProductsDeal","loadOptionsDependsOn":["dealId"]},"required":true,"displayOptions":{"show":{"operation":["remove"],"resource":["dealProduct"]}},"description":"ID of the deal-product (the ID of the product attached to the deal). Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Deal Name or ID","name":"dealId","type":"options","default":"","typeOptions":{"loadOptionsMethod":"getDeals"},"required":true,"displayOptions":{"show":{"operation":["getAll"],"resource":["dealProduct"]}},"description":"The ID of the deal whose products to retrieve. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Term","name":"term","type":"string","required":true,"displayOptions":{"show":{"operation":["search"],"resource":["deal"]}},"default":"","description":"The search term to look for. Minimum 2 characters (or 1 if using exact_match)."},{"displayName":"Exact Match","name":"exactMatch","type":"boolean","displayOptions":{"show":{"operation":["search"],"resource":["deal"]}},"default":false,"description":"Whether only full exact matches against the given term are returned. It is not case sensitive."},{"displayName":"Return All","name":"returnAll","type":"boolean","displayOptions":{"show":{"operation":["search"]}},"default":false,"description":"Whether to return all results or only up to a given limit"},{"displayName":"Limit","name":"limit","type":"number","displayOptions":{"show":{"operation":["search"],"returnAll":[false]}},"typeOptions":{"minValue":1,"maxValue":500},"default":100,"description":"Max number of results to return"},{"displayName":"Additional Fields","name":"additionalFields","type":"collection","placeholder":"Add Field","displayOptions":{"show":{"operation":["search"],"resource":["deal"]}},"default":{},"options":[{"displayName":"Include Fields","name":"includeFields","type":"string","default":"","description":"Supports including optional fields in the results which are not provided by default. Example: deal.cc_email."},{"displayName":"Organization ID","name":"organizationId","type":"string","default":"","description":"Will filter Deals by the provided Organization ID"},{"displayName":"Person ID","name":"personId","type":"string","default":"","description":"Will filter Deals by the provided Person ID"},{"displayName":"Search Fields","name":"fields","type":"multiOptions","options":[{"name":"Custom Fields","value":"custom_fields"},{"name":"Notes","value":"notes"},{"name":"Title","value":"title"}],"default":["custom_fields","notes","title"],"description":"A comma-separated string array. The fields to perform the search from. Defaults to all of them."},{"displayName":"Status","name":"status","type":"options","options":[{"name":"Open","value":"open"},{"name":"Won","value":"won"},{"name":"Lost","value":"lost"}],"default":"open","description":"The status of the deal. If not provided it will automatically be set to \"open\"."}]},{"displayName":"Binary Property","name":"binaryPropertyName","type":"string","default":"data","required":true,"displayOptions":{"show":{"operation":["create"],"resource":["file"]}},"placeholder":"","description":"Name of the binary property which contains the data for the file to be created"},{"displayName":"Additional Fields","name":"additionalFields","type":"collection","placeholder":"Add Field","displayOptions":{"show":{"operation":["create"],"resource":["file"]}},"default":{},"options":[{"displayName":"Activity ID","name":"activity_id","type":"number","default":0,"description":"ID of the activite this file will be associated with"},{"displayName":"Deal ID","name":"deal_id","type":"number","default":0,"description":"ID of the deal this file will be associated with"},{"displayName":"Organization Name or ID","name":"org_id","type":"options","typeOptions":{"loadOptionsMethod":"getOrganizationIds"},"default":"","description":"ID of the organization this deal will be associated with. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Person ID","name":"person_id","type":"number","default":0,"description":"ID of the person this file will be associated with"},{"displayName":"Product ID","name":"product_id","type":"number","default":0,"description":"ID of the person this file will be associated with"}]},{"displayName":"File ID","name":"fileId","type":"number","displayOptions":{"show":{"operation":["delete"],"resource":["file"]}},"default":0,"required":true,"description":"ID of the file to delete"},{"displayName":"File ID","name":"fileId","type":"number","displayOptions":{"show":{"operation":["download"],"resource":["file"]}},"default":0,"required":true,"description":"ID of the file to download"},{"displayName":"Binary Property","name":"binaryPropertyName","type":"string","required":true,"default":"data","displayOptions":{"show":{"operation":["download"],"resource":["file"]}},"description":"Name of the binary property to which to write the data of the downloaded file"},{"displayName":"File ID","name":"fileId","type":"number","displayOptions":{"show":{"operation":["get"],"resource":["file"]}},"default":0,"required":true,"description":"ID of the file to get"},{"displayName":"File ID","name":"fileId","type":"number","displayOptions":{"show":{"operation":["update"],"resource":["file"]}},"default":0,"required":true,"description":"ID of the file to update"},{"displayName":"Update Fields","name":"updateFields","type":"collection","placeholder":"Add Field","displayOptions":{"show":{"operation":["update"],"resource":["file"]}},"default":{},"options":[{"displayName":"Name","name":"name","type":"string","default":"","description":"The updated visible name of the file"},{"displayName":"Description","name":"description","type":"string","default":"","description":"The updated description of the file"}]},{"displayName":"Title","name":"title","description":"Name of the lead to create","type":"string","required":true,"default":"","displayOptions":{"show":{"resource":["lead"],"operation":["create"]}}},{"displayName":"Associate With","name":"associateWith","type":"options","options":[{"name":"Organization","value":"organization"},{"name":"Person","value":"person"}],"default":"organization","description":"Type of entity to link to this lead","required":true,"displayOptions":{"show":{"resource":["lead"],"operation":["create"]}}},{"displayName":"Organization ID","name":"organization_id","type":"number","default":0,"description":"ID of the organization to link to this lead","required":true,"displayOptions":{"show":{"resource":["lead"],"operation":["create"],"associateWith":["organization"]}}},{"displayName":"Person ID","name":"person_id","type":"number","default":0,"description":"ID of the person to link to this lead","required":true,"displayOptions":{"show":{"resource":["lead"],"operation":["create"],"associateWith":["person"]}}},{"displayName":"Additional Fields","name":"additionalFields","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"resource":["lead"],"operation":["create"]}},"options":[{"displayName":"Expected Close Date","name":"expected_close_date","type":"dateTime","default":"","description":"Date when the lead’s deal is expected to be closed, in ISO-8601 format"},{"displayName":"Label Names or IDs","name":"label_ids","type":"multiOptions","typeOptions":{"loadOptionsMethod":"getLeadLabels"},"default":[],"description":"ID of the labels to attach to the lead to create. Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Organization ID","name":"organization_id","type":"number","default":0,"description":"ID of the organization to link to this lead","displayOptions":{"show":{"/associateWith":["person"]}}},{"displayName":"Owner Name or ID","name":"owner_id","type":"options","typeOptions":{"loadOptionsMethod":"getUserIds"},"default":"","description":"ID of the user who will own the lead to create. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Person ID","name":"person_id","type":"number","default":0,"description":"ID of the person to link to this lead","displayOptions":{"show":{"/associateWith":["organization"]}}},{"displayName":"Value","name":"value","type":"fixedCollection","description":"Potential monetary value associated with the lead","default":{},"options":[{"displayName":"Value Properties","name":"valueProperties","values":[{"displayName":"Amount","name":"amount","type":"number","default":""},{"displayName":"Currency","name":"currency","type":"options","default":"USD","options":[{"name":"Afghani","value":"AFN"},{"name":"Algerian Dinar","value":"DZD"},{"name":"Argentine Peso","value":"ARS"},{"name":"Australian Dollar","value":"AUD"},{"name":"Azerbaijan Manat","value":"AZN"},{"name":"Bahamian Dollar","value":"BSD"},{"name":"Baht","value":"THB"},{"name":"Barbados Dollar","value":"BBD"},{"name":"Belize Dollar","value":"BZD"},{"name":"Bermudian Dollar","value":"BMD"},{"name":"Boliviano","value":"BOB"},{"name":"Brazilian Real","value":"BRL"},{"name":"Brunei Dollar","value":"BND"},{"name":"Bulgarian Lev","value":"BGN"},{"name":"Canadian Dollar","value":"CAD"},{"name":"Chilean Peso","value":"CLP"},{"name":"Colombian Peso","value":"COP"},{"name":"Cordoba Oro","value":"NIO"},{"name":"Costa Rican Colon","value":"CRC"},{"name":"Czech Koruna","value":"CZK"},{"name":"Danish Krone","value":"DKK"},{"name":"Dominican Peso","value":"DOP"},{"name":"Dong","value":"VND"},{"name":"East Caribbean Dollar","value":"XCD"},{"name":"Egyptian Pound","value":"EGP"},{"name":"Euro","value":"EUR"},{"name":"Fiji Dollar","value":"FJD"},{"name":"Forint","value":"HUF"},{"name":"Hong Kong Dollar","value":"HKD"},{"name":"Hryvnia","value":"UAH"},{"name":"Indian Rupee","value":"INR"},{"name":"Jamaican Dollar","value":"JMD"},{"name":"Kenyan Shilling","value":"KES"},{"name":"Kina","value":"PGK"},{"name":"Kuna","value":"HRK"},{"name":"Kyat","value":"MMK"},{"name":"Lao Kip","value":"LAK"},{"name":"Lebanese Pound","value":"LBP"},{"name":"Lek","value":"ALL"},{"name":"Lempira","value":"HNL"},{"name":"Liberian Dollar","value":"LRD"},{"name":"Malaysian Ringgit","value":"MYR"},{"name":"Mauritius Rupee","value":"MUR"},{"name":"Mexican Peso","value":"MXN"},{"name":"Moroccan Dirham","value":"MAD"},{"name":"Nepalese Rupee","value":"NPR"},{"name":"New Israeli Sheqel","value":"ILS"},{"name":"New Taiwan Dollar","value":"TWD"},{"name":"New Zealand Dollar","value":"NZD"},{"name":"Norwegian Krone","value":"NOK"},{"name":"Ouguiya","value":"MRO"},{"name":"Pa’anga","value":"TOP"},{"name":"Pakistan Rupee","value":"PKR"},{"name":"Pataca","value":"MOP"},{"name":"Philippine Peso","value":"PHP"},{"name":"Pound Sterling","value":"GBP"},{"name":"Pula","value":"BWP"},{"name":"Qatari Rial","value":"QAR"},{"name":"Quetzal","value":"GTQ"},{"name":"Rand","value":"ZAR"},{"name":"Romanian Leu","value":"RON"},{"name":"Rufiyaa","value":"MVR"},{"name":"Rupiah","value":"IDR"},{"name":"Russian Ruble","value":"RUB"},{"name":"Saudi Riyal","value":"SAR"},{"name":"Seychelles Rupee","value":"SCR"},{"name":"Singapore Dollar","value":"SGD"},{"name":"Sol","value":"PEN"},{"name":"Solomon Islands Dollar","value":"SBD"},{"name":"Sri Lanka Rupee","value":"LKR"},{"name":"Swedish Krona","value":"SEK"},{"name":"Swiss Franc","value":"CHF"},{"name":"Syrian Pound","value":"SYP"},{"name":"Taka","value":"BDT"},{"name":"Tala","value":"WST"},{"name":"Tenge","value":"KZT"},{"name":"Trinidad and Tobago Dollar","value":"TTD"},{"name":"Turkish Lira","value":"TRY"},{"name":"UAE Dirham","value":"AED"},{"name":"US Dollar","value":"USD"},{"name":"Vatu","value":"VUV"},{"name":"West African CFA Franc","value":"XOF"},{"name":"Won","value":"KRW"},{"name":"Yemeni Rial","value":"YER"},{"name":"Yen","value":"JPY"},{"name":"Yuan Renminbi","value":"CNY"},{"name":"Zloty","value":"PLN"}]}]}]}]},{"displayName":"Lead ID","name":"leadId","description":"ID of the lead to delete","type":"string","required":true,"default":"","displayOptions":{"show":{"resource":["lead"],"operation":["delete"]}}},{"displayName":"Lead ID","name":"leadId","description":"ID of the lead to retrieve","type":"string","required":true,"default":"","displayOptions":{"show":{"resource":["lead"],"operation":["get"]}}},{"displayName":"Lead ID","name":"leadId","description":"ID of the lead to update","type":"string","required":true,"default":"","displayOptions":{"show":{"resource":["lead"],"operation":["update"]}}},{"displayName":"Update Fields","name":"updateFields","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"resource":["lead"],"operation":["update"]}},"options":[{"displayName":"Title","name":"title","type":"string","default":"","description":"Name of the lead to update"},{"displayName":"Owner Name or ID","name":"owner_id","type":"options","typeOptions":{"loadOptionsMethod":"getUserIds"},"default":"","description":"ID of the user who will own the lead to update. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Label Names or IDs","name":"label_ids","type":"multiOptions","typeOptions":{"loadOptionsMethod":"getLeadLabels"},"default":[],"description":"ID of the labels to attach to the lead to update. Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Person Name or ID","name":"person_id","type":"options","typeOptions":{"loadOptionsMethod":"getPersons"},"default":"","description":"ID of the person to link to this lead. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Value","name":"value","type":"fixedCollection","description":"Potential monetary value associated with the lead","default":{},"options":[{"displayName":"Value Properties","name":"valueProperties","values":[{"displayName":"Amount","name":"amount","type":"number","default":""},{"displayName":"Currency","name":"currency","type":"options","default":"USD","options":[{"name":"Afghani","value":"AFN"},{"name":"Algerian Dinar","value":"DZD"},{"name":"Argentine Peso","value":"ARS"},{"name":"Australian Dollar","value":"AUD"},{"name":"Azerbaijan Manat","value":"AZN"},{"name":"Bahamian Dollar","value":"BSD"},{"name":"Baht","value":"THB"},{"name":"Barbados Dollar","value":"BBD"},{"name":"Belize Dollar","value":"BZD"},{"name":"Bermudian Dollar","value":"BMD"},{"name":"Boliviano","value":"BOB"},{"name":"Brazilian Real","value":"BRL"},{"name":"Brunei Dollar","value":"BND"},{"name":"Bulgarian Lev","value":"BGN"},{"name":"Canadian Dollar","value":"CAD"},{"name":"Chilean Peso","value":"CLP"},{"name":"Colombian Peso","value":"COP"},{"name":"Cordoba Oro","value":"NIO"},{"name":"Costa Rican Colon","value":"CRC"},{"name":"Czech Koruna","value":"CZK"},{"name":"Danish Krone","value":"DKK"},{"name":"Dominican Peso","value":"DOP"},{"name":"Dong","value":"VND"},{"name":"East Caribbean Dollar","value":"XCD"},{"name":"Egyptian Pound","value":"EGP"},{"name":"Euro","value":"EUR"},{"name":"Fiji Dollar","value":"FJD"},{"name":"Forint","value":"HUF"},{"name":"Hong Kong Dollar","value":"HKD"},{"name":"Hryvnia","value":"UAH"},{"name":"Indian Rupee","value":"INR"},{"name":"Jamaican Dollar","value":"JMD"},{"name":"Kenyan Shilling","value":"KES"},{"name":"Kina","value":"PGK"},{"name":"Kuna","value":"HRK"},{"name":"Kyat","value":"MMK"},{"name":"Lao Kip","value":"LAK"},{"name":"Lebanese Pound","value":"LBP"},{"name":"Lek","value":"ALL"},{"name":"Lempira","value":"HNL"},{"name":"Liberian Dollar","value":"LRD"},{"name":"Malaysian Ringgit","value":"MYR"},{"name":"Mauritius Rupee","value":"MUR"},{"name":"Mexican Peso","value":"MXN"},{"name":"Moroccan Dirham","value":"MAD"},{"name":"Nepalese Rupee","value":"NPR"},{"name":"New Israeli Sheqel","value":"ILS"},{"name":"New Taiwan Dollar","value":"TWD"},{"name":"New Zealand Dollar","value":"NZD"},{"name":"Norwegian Krone","value":"NOK"},{"name":"Ouguiya","value":"MRO"},{"name":"Pa’anga","value":"TOP"},{"name":"Pakistan Rupee","value":"PKR"},{"name":"Pataca","value":"MOP"},{"name":"Philippine Peso","value":"PHP"},{"name":"Pound Sterling","value":"GBP"},{"name":"Pula","value":"BWP"},{"name":"Qatari Rial","value":"QAR"},{"name":"Quetzal","value":"GTQ"},{"name":"Rand","value":"ZAR"},{"name":"Romanian Leu","value":"RON"},{"name":"Rufiyaa","value":"MVR"},{"name":"Rupiah","value":"IDR"},{"name":"Russian Ruble","value":"RUB"},{"name":"Saudi Riyal","value":"SAR"},{"name":"Seychelles Rupee","value":"SCR"},{"name":"Singapore Dollar","value":"SGD"},{"name":"Sol","value":"PEN"},{"name":"Solomon Islands Dollar","value":"SBD"},{"name":"Sri Lanka Rupee","value":"LKR"},{"name":"Swedish Krona","value":"SEK"},{"name":"Swiss Franc","value":"CHF"},{"name":"Syrian Pound","value":"SYP"},{"name":"Taka","value":"BDT"},{"name":"Tala","value":"WST"},{"name":"Tenge","value":"KZT"},{"name":"Trinidad and Tobago Dollar","value":"TTD"},{"name":"Turkish Lira","value":"TRY"},{"name":"UAE Dirham","value":"AED"},{"name":"US Dollar","value":"USD"},{"name":"Vatu","value":"VUV"},{"name":"West African CFA Franc","value":"XOF"},{"name":"Won","value":"KRW"},{"name":"Yemeni Rial","value":"YER"},{"name":"Yen","value":"JPY"},{"name":"Yuan Renminbi","value":"CNY"},{"name":"Zloty","value":"PLN"}]}]}]},{"displayName":"Expected Close Date","name":"expected_close_date","type":"dateTime","default":"","description":"Date when the lead’s deal is expected to be closed, in ISO-8601 format"}]},{"displayName":"Content","name":"content","typeOptions":{"rows":5},"type":"string","default":"","required":true,"displayOptions":{"show":{"operation":["create"],"resource":["note"]}},"description":"The content of the note to create"},{"displayName":"Note ID","name":"noteId","type":"number","displayOptions":{"show":{"operation":["delete"],"resource":["note"]}},"default":0,"required":true,"description":"ID of the note to delete"},{"displayName":"Note ID","name":"noteId","type":"number","displayOptions":{"show":{"operation":["get"],"resource":["note"]}},"default":0,"required":true,"description":"ID of the note to get"},{"displayName":"Note ID","name":"noteId","type":"number","displayOptions":{"show":{"operation":["update"],"resource":["note"]}},"default":0,"required":true,"description":"ID of the note to update"},{"displayName":"Update Fields","name":"updateFields","type":"collection","placeholder":"Add Field","displayOptions":{"show":{"operation":["update"],"resource":["note"]}},"default":{},"options":[{"displayName":"Content","name":"content","typeOptions":{"rows":5},"type":"string","default":"","description":"The content of the note"},{"displayName":"Deal ID","name":"deal_id","type":"number","default":0,"description":"ID of the deal this note will be associated with"},{"displayName":"Lead ID","name":"lead_id","type":"number","default":0,"description":"ID of the lead this note will be associated with"},{"displayName":"Organization Name or ID","name":"org_id","type":"options","typeOptions":{"loadOptionsMethod":"getOrganizationIds"},"default":"","description":"ID of the organization this deal will be associated with. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Person ID","name":"person_id","type":"number","default":0,"description":"ID of the person this note will be associated with"}]},{"displayName":"Name","name":"name","type":"string","default":"","required":true,"displayOptions":{"show":{"operation":["create"],"resource":["organization"]}},"description":"The name of the organization to create"},{"displayName":"Additional Fields","name":"additionalFields","type":"collection","placeholder":"Add Field","displayOptions":{"show":{"operation":["create"],"resource":["organization"]}},"default":{},"options":[{"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"}]}]},{"displayName":"Label Name or ID","name":"label","type":"options","description":"Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>","typeOptions":{"loadOptionsMethod":"getOrganizationLabels"},"default":""},{"displayName":"Visible To","name":"visible_to","type":"options","options":[{"name":"Owner & Followers (Private)","value":"1"},{"name":"Entire Company (Shared)","value":"3"}],"default":"3","description":"Visibility of the person. If omitted, visibility will be set to the default visibility setting of this item type for the authorized user."}]},{"displayName":"Organization ID","name":"organizationId","type":"number","displayOptions":{"show":{"operation":["delete"],"resource":["organization"]}},"default":0,"required":true,"description":"ID of the organization to delete"},{"displayName":"Organization ID","name":"organizationId","type":"number","displayOptions":{"show":{"operation":["get"],"resource":["organization"]}},"default":0,"required":true,"description":"ID of the organization to get"},{"displayName":"Term","name":"term","type":"string","required":true,"displayOptions":{"show":{"operation":["search"],"resource":["organization"]}},"default":"","description":"The search term to look for. Minimum 2 characters (or 1 if using exact_match)."},{"displayName":"Additional Fields","name":"additionalFields","type":"collection","placeholder":"Add Field","displayOptions":{"show":{"operation":["search"],"resource":["organization"]}},"default":{},"options":[{"displayName":"Exact Match","name":"exactMatch","type":"boolean","default":false,"description":"Whether only full exact matches against the given term are returned. It is not case sensitive."},{"displayName":"Fields","name":"fields","type":"multiOptions","default":[],"description":"Fields to the search in. Defaults to all of them.","options":[{"name":"Address","value":"address"},{"name":"Custom Fields","value":"custom_fields"},{"name":"Name","value":"name"},{"name":"Notes","value":"notes"}]},{"displayName":"RAW Data","name":"rawData","type":"boolean","default":false,"description":"Whether to return the data exactly in the way it got received from the API"}]},{"displayName":"Organization ID","name":"organizationId","type":"number","default":"","required":true,"displayOptions":{"show":{"operation":["update"],"resource":["organization"]}},"description":"The ID of the organization to create"},{"displayName":"Update Fields","name":"updateFields","type":"collection","placeholder":"Add Field","displayOptions":{"show":{"operation":["update"],"resource":["organization"]}},"default":{},"options":[{"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"}]}]},{"displayName":"Label Name or ID","name":"label","type":"options","description":"Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>","typeOptions":{"loadOptionsMethod":"getOrganizationLabels"},"default":""},{"displayName":"Name","name":"name","type":"string","default":"","description":"Organization name"},{"displayName":"Owner ID","name":"owner_id","type":"number","default":0,"description":"The ID of the user who will be marked as the owner of this Organization. When omitted, the authorized User ID will be used."},{"displayName":"Visible To","name":"visible_to","type":"options","options":[{"name":"Owner & Followers (Private)","value":"1"},{"name":"Entire Company (Shared)","value":"3"}],"default":"3","description":"Visibility of the person. If omitted, visibility will be set to the default visibility setting of this item type for the authorized user."}]},{"displayName":"Name","name":"name","type":"string","default":"","required":true,"displayOptions":{"show":{"operation":["create"],"resource":["person"]}},"description":"The name of the person to create"},{"displayName":"Additional Fields","name":"additionalFields","type":"collection","placeholder":"Add Field","displayOptions":{"show":{"operation":["create"],"resource":["person"]}},"default":{},"options":[{"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 or ID","name":"name","type":"options","typeOptions":{"loadOptionsMethod":"getPersonCustomFields"},"default":"","description":"Name of the custom field to set. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Property Value","name":"value","type":"string","default":"","description":"Value of the property to set"}]}]},{"displayName":"Email","name":"email","type":"string","placeholder":"name@email.com","typeOptions":{"multipleValues":true},"default":"","description":"Email of the person"},{"displayName":"Label Name or ID","name":"label","type":"options","description":"Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>","typeOptions":{"loadOptionsMethod":"getPersonLabels"},"default":""},{"displayName":"Marketing Status","name":"marketing_status","type":"options","options":[{"name":"No Consent","value":"no_consent"},{"name":"Unsubscribed","value":"unsubscribed"},{"name":"Subscribed","value":"subscribed"},{"name":"Archived","value":"archived"}],"default":"subscribed","description":"Please be aware that it is only allowed once to change the marketing status from an old status to a new one"},{"displayName":"Organization Name or ID","name":"org_id","type":"options","typeOptions":{"loadOptionsMethod":"getOrganizationIds"},"default":"","description":"ID of the organization this deal will be associated with. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Phone","name":"phone","type":"string","typeOptions":{"multipleValues":true},"default":"","description":"Phone number of the person"},{"displayName":"Visible To","name":"visible_to","type":"options","options":[{"name":"Owner & Followers (Private)","value":"1"},{"name":"Entire Company (Shared)","value":"3"}],"default":"3","description":"Visibility of the person. If omitted, visibility will be set to the default visibility setting of this item type for the authorized user."},{"displayName":"User Name or ID","name":"owner_id","type":"options","typeOptions":{"loadOptionsMethod":"getUserIds"},"default":"","description":"ID of the User this deal will be associated with. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."}]},{"displayName":"Person ID","name":"personId","type":"number","displayOptions":{"show":{"operation":["delete"],"resource":["person"]}},"default":0,"required":true,"description":"ID of the person to delete"},{"displayName":"Person ID","name":"personId","type":"number","displayOptions":{"show":{"operation":["get"],"resource":["person"]}},"default":0,"required":true,"description":"ID of the person to get"},{"displayName":"Person ID","name":"personId","type":"number","displayOptions":{"show":{"operation":["update"],"resource":["person"]}},"default":0,"required":true,"description":"ID of the person to update"},{"displayName":"Update Fields","name":"updateFields","type":"collection","description":"The fields to update","placeholder":"Add Field","displayOptions":{"show":{"operation":["update"],"resource":["person"]}},"default":{},"options":[{"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 or ID","name":"name","type":"options","typeOptions":{"loadOptionsMethod":"getPersonCustomFields"},"default":"","description":"Name of the custom field to set. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Property Value","name":"value","type":"string","default":"","description":"Value of the property to set"}]}]},{"displayName":"Email","name":"email","type":"string","placeholder":"name@email.com","typeOptions":{"multipleValues":true},"default":"","description":"Email of the person"},{"displayName":"Label Name or ID","name":"label","type":"options","description":"Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>","typeOptions":{"loadOptionsMethod":"getPersonLabels"},"default":""},{"displayName":"Marketing Status","name":"marketing_status","type":"options","options":[{"name":"No Consent","value":"no_consent"},{"name":"Unsubscribed","value":"unsubscribed"},{"name":"Subscribed","value":"subscribed"},{"name":"Archived","value":"archived"}],"default":"subscribed","description":"Please be aware that it is only allowed once to change the marketing status from an old status to a new one"},{"displayName":"Name","name":"name","type":"string","default":"","description":"The name of the person"},{"displayName":"Organization Name or ID","name":"org_id","type":"options","typeOptions":{"loadOptionsMethod":"getOrganizationIds"},"default":"","description":"ID of the organization this deal will be associated with. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Phone","name":"phone","type":"string","typeOptions":{"multipleValues":true},"default":"","description":"Phone number of the person"},{"displayName":"User Name or ID","name":"owner_id","type":"options","typeOptions":{"loadOptionsMethod":"getUserIds"},"default":"","description":"ID of the User this person will be associated with. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Visible To","name":"visible_to","type":"options","options":[{"name":"Owner & Followers (Private)","value":"1"},{"name":"Entire Company (Shared)","value":"3"}],"default":"3","description":"Visibility of the deal. If omitted, visibility will be set to the default visibility setting of this item type for the authorized user."}]},{"displayName":"Resolve Properties","name":"resolveProperties","type":"boolean","displayOptions":{"show":{"resource":["activity","deal","organization","person","product"],"operation":["get","getAll"]}},"default":false,"description":"By default do custom properties get returned only as ID instead of their actual name. Also option fields contain only the ID instead of their actual value. If this option gets set they get automatically resolved."},{"displayName":"Encode Properties","name":"encodeProperties","type":"boolean","displayOptions":{"show":{"resource":["activity","deal","organization","person","product"],"operation":["update"]}},"default":false,"description":"By default do custom properties have to be set as ID instead of their actual name. Also option fields have to be set as ID instead of their actual value. If this option gets set they get automatically encoded."},{"displayName":"Return All","name":"returnAll","type":"boolean","displayOptions":{"show":{"operation":["getAll"]}},"default":false,"description":"Whether to return all results or only up to a given limit"},{"displayName":"Limit","name":"limit","type":"number","displayOptions":{"show":{"operation":["getAll"],"returnAll":[false]}},"typeOptions":{"minValue":1,"maxValue":500},"default":100,"description":"Max number of results to return"},{"displayName":"Deal Name or ID","name":"dealId","type":"options","default":"","typeOptions":{"loadOptionsMethod":"getDeals"},"required":true,"displayOptions":{"show":{"operation":["getAll"],"resource":["dealActivity"]}},"description":"The ID of the deal whose activity to retrieve. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Additional Fields","name":"additionalFields","type":"collection","placeholder":"Add Field","displayOptions":{"show":{"operation":["getAll"],"resource":["dealActivity"]}},"default":{},"options":[{"displayName":"Done","name":"done","type":"boolean","default":false,"description":"Whether the activity is done or not"},{"displayName":"Exclude Activity IDs","name":"exclude","type":"string","default":"","description":"A comma-separated Activity IDs, to exclude from result. Ex. 4, 9, 11, ..."}]},{"displayName":"Filters","name":"filters","type":"collection","placeholder":"Add Filter","default":{},"displayOptions":{"show":{"resource":["lead"],"operation":["getAll"]}},"options":[{"displayName":"Archived Status","name":"archived_status","type":"options","default":"all","options":[{"name":"Archived","value":"archived"},{"name":"All","value":"all"},{"name":"Not Archived","value":"not_archived"}]}]},{"displayName":"Filters","name":"filters","type":"collection","placeholder":"Add Field","displayOptions":{"show":{"operation":["getAll"],"resource":["organization"]}},"default":{},"options":[{"displayName":"First Char","name":"firstChar","type":"string","default":"","description":"If supplied, only organizations whose name starts with the specified letter will be returned"},{"displayName":"Predefined Filter Name or ID","name":"filterId","type":"options","typeOptions":{"loadOptionsMethod":"getFilters"},"default":"","description":"ID of the filter to use. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."}]},{"displayName":"Additional Fields","name":"additionalFields","type":"collection","placeholder":"Add Field","displayOptions":{"show":{"operation":["getAll"],"resource":["person"]}},"default":{},"options":[{"displayName":"Predefined Filter Name or ID","name":"filterId","type":"options","typeOptions":{"loadOptionsMethod":"getFilters"},"default":"","description":"ID of the filter to use. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"First Char","name":"firstChar","type":"string","default":"","description":"If supplied, only persons whose name starts with the specified letter will be returned"}]},{"displayName":"Term","name":"term","type":"string","required":true,"displayOptions":{"show":{"operation":["search"],"resource":["person"]}},"default":"","description":"The search term to look for. Minimum 2 characters (or 1 if using exact_match)."},{"displayName":"Additional Fields","name":"additionalFields","type":"collection","placeholder":"Add Field","displayOptions":{"show":{"operation":["search"],"resource":["person"]}},"default":{},"options":[{"displayName":"Exact Match","name":"exactMatch","type":"boolean","default":false,"description":"Whether only full exact matches against the given term are returned. It is not case sensitive."},{"displayName":"Fields","name":"fields","type":"string","default":"","description":"A comma-separated string array. The fields to perform the search from. Defaults to all of them."},{"displayName":"Include Fields","name":"includeFields","type":"string","default":"","description":"Supports including optional fields in the results which are not provided by default"},{"displayName":"Organization ID","name":"organizationId","type":"string","default":"","description":"Will filter Deals by the provided Organization ID"},{"displayName":"RAW Data","name":"rawData","type":"boolean","default":false,"description":"Whether to return the data exactly in the way it got received from the API"}]},{"displayName":"Additional Fields","name":"additionalFields","type":"collection","placeholder":"Add Field","displayOptions":{"show":{"operation":["create","getAll"],"resource":["note"]}},"default":{},"options":[{"displayName":"Deal ID","name":"deal_id","type":"number","default":0,"description":"ID of the deal this note will be associated with"},{"displayName":"Lead ID","name":"lead_id","type":"number","default":0,"description":"ID of the lead this note will be associated with"},{"displayName":"Organization Name or ID","name":"org_id","type":"options","typeOptions":{"loadOptionsMethod":"getOrganizationIds"},"default":"","description":"ID of the organization this deal will be associated with. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Person ID","name":"person_id","type":"number","default":0,"description":"ID of the person this note will be associated with"}]},{"displayName":"Additional Fields","name":"additionalFields","type":"collection","placeholder":"Add Field","displayOptions":{"show":{"operation":["getAll"],"resource":["activity"]}},"default":{},"options":[{"displayName":"Done","name":"done","type":"boolean","default":false,"description":"Whether the Activity is done or not. 0 = Not done, 1 = Done. If omitted returns both Done and Not done activities."},{"displayName":"End Date","name":"end_date","type":"dateTime","default":"","description":"Use the Activity due date where you wish to stop fetching Activities from. Insert due date in YYYY-MM-DD format."},{"displayName":"Predefined Filter Name or ID","name":"filterId","type":"options","typeOptions":{"loadOptionsMethod":"getFilters"},"default":"","description":"The ID of the Filter to use (will narrow down results if used together with user_id parameter). Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Star Date","name":"start_date","type":"dateTime","default":"","description":"Use the Activity due date where you wish to begin fetching Activities from. Insert due date in YYYY-MM-DD format."},{"displayName":"Type Names or IDs","name":"type","type":"multiOptions","typeOptions":{"loadOptionsMethod":"getActivityTypes"},"default":[],"description":"Type of the Activity. Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"User Name or ID","name":"user_id","type":"options","typeOptions":{"loadOptionsMethod":"getUserIds"},"default":"","description":"The ID of the User whose Activities will be fetched. If omitted, the User associated with the API token will be used. If 0, Activities for all company Users will be fetched based on the permission sets. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."}]},{"displayName":"Filters","name":"filters","type":"collection","placeholder":"Add Filter","displayOptions":{"show":{"operation":["getAll"],"resource":["deal"]}},"default":{},"options":[{"displayName":"Predefined Filter Name or ID","name":"filter_id","type":"options","typeOptions":{"loadOptionsMethod":"getFilters"},"default":"","description":"Predefined filter to apply to the deals to retrieve. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Stage Name or ID","name":"stage_id","type":"options","typeOptions":{"loadOptionsMethod":"getStageIds"},"default":"","description":"ID of the stage to filter deals by. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Status","name":"status","type":"options","options":[{"name":"All Not Deleted","value":"all_not_deleted"},{"name":"Deleted","value":"deleted"},{"name":"Lost","value":"lost"},{"name":"Open","value":"open"},{"name":"Won","value":"won"}],"default":"all_not_deleted","description":"Status to filter deals by. Defaults to <code>all_not_deleted</code>"},{"displayName":"User Name or ID","name":"user_id","type":"options","typeOptions":{"loadOptionsMethod":"getUserIds"},"default":"","description":"ID of the user to filter deals by. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."}]}]

operations:
  [{"type":"resource","resource":"activity","name":"Activity"},{"type":"resource","resource":"deal","name":"Deal"},{"type":"resource","resource":"dealActivity","name":"Deal Activity"},{"type":"resource","resource":"dealProduct","name":"Deal Product"},{"type":"resource","resource":"file","name":"File"},{"type":"resource","resource":"lead","name":"Lead"},{"type":"resource","resource":"note","name":"Note"},{"type":"resource","resource":"organization","name":"Organization"},{"type":"resource","resource":"person","name":"Person"},{"type":"resource","resource":"product","name":"Product"},{"type":"operation","operation":"create","name":"Create","action":"Create an activity","resources":["activity"]},{"type":"operation","operation":"delete","name":"Delete","action":"Delete an activity","resources":["activity"]},{"type":"operation","operation":"get","name":"Get","action":"Get an activity","resources":["activity"]},{"type":"operation","operation":"getAll","name":"Get Many","action":"Get many activities","resources":["activity"]},{"type":"operation","operation":"update","name":"Update","action":"Update an activity","resources":["activity"]},{"type":"operation","operation":"create","name":"Create","action":"Create a deal","resources":["deal"]},{"type":"operation","operation":"delete","name":"Delete","action":"Delete a deal","resources":["deal"]},{"type":"operation","operation":"duplicate","name":"Duplicate","action":"Duplicate a deal","resources":["deal"]},{"type":"operation","operation":"get","name":"Get","action":"Get a deal","resources":["deal"]},{"type":"operation","operation":"getAll","name":"Get Many","action":"Get many deals","resources":["deal"]},{"type":"operation","operation":"search","name":"Search","action":"Search a deal","resources":["deal"]},{"type":"operation","operation":"update","name":"Update","action":"Update a deal","resources":["deal"]},{"type":"operation","operation":"getAll","name":"Get Many","action":"Get many deal activities","resources":["dealActivity"]},{"type":"operation","operation":"add","name":"Add","action":"Add a deal product","resources":["dealProduct"]},{"type":"operation","operation":"getAll","name":"Get Many","action":"Get many deal products","resources":["dealProduct"]},{"type":"operation","operation":"remove","name":"Remove","action":"Remove a deal product","resources":["dealProduct"]},{"type":"operation","operation":"update","name":"Update","action":"Update a deal product","resources":["dealProduct"]},{"type":"operation","operation":"create","name":"Create","action":"Create a file","resources":["file"]},{"type":"operation","operation":"delete","name":"Delete","action":"Delete a file","resources":["file"]},{"type":"operation","operation":"download","name":"Download","action":"Download a file","resources":["file"]},{"type":"operation","operation":"get","name":"Get","action":"Get a file","resources":["file"]},{"type":"operation","operation":"update","name":"Update","action":"update details of a file","resources":["file"]},{"type":"operation","operation":"create","name":"Create","action":"Create a lead","resources":["lead"]},{"type":"operation","operation":"delete","name":"Delete","action":"Delete a lead","resources":["lead"]},{"type":"operation","operation":"get","name":"Get","action":"Get a lead","resources":["lead"]},{"type":"operation","operation":"getAll","name":"Get Many","action":"Get many leads","resources":["lead"]},{"type":"operation","operation":"update","name":"Update","action":"Update a lead","resources":["lead"]},{"type":"operation","operation":"create","name":"Create","action":"Create a note","resources":["note"]},{"type":"operation","operation":"delete","name":"Delete","action":"Delete a note","resources":["note"]},{"type":"operation","operation":"get","name":"Get","action":"Get a note","resources":["note"]},{"type":"operation","operation":"getAll","name":"Get Many","action":"Get many notes","resources":["note"]},{"type":"operation","operation":"update","name":"Update","action":"Update a note","resources":["note"]},{"type":"operation","operation":"create","name":"Create","action":"Create an organization","resources":["organization"]},{"type":"operation","operation":"delete","name":"Delete","action":"Delete an organization","resources":["organization"]},{"type":"operation","operation":"get","name":"Get","action":"Get an organization","resources":["organization"]},{"type":"operation","operation":"getAll","name":"Get Many","action":"Get many organizations","resources":["organization"]},{"type":"operation","operation":"search","name":"Search","action":"Search an organization","resources":["organization"]},{"type":"operation","operation":"update","name":"Update","action":"Update an organization","resources":["organization"]},{"type":"operation","operation":"create","name":"Create","action":"Create a person","resources":["person"]},{"type":"operation","operation":"delete","name":"Delete","action":"Delete a person","resources":["person"]},{"type":"operation","operation":"get","name":"Get","action":"Get a person","resources":["person"]},{"type":"operation","operation":"getAll","name":"Get Many","action":"Get many people","resources":["person"]},{"type":"operation","operation":"search","name":"Search","action":"Search a person","resources":["person"]},{"type":"operation","operation":"update","name":"Update","action":"Update a person","resources":["person"]},{"type":"operation","operation":"getAll","name":"Get Many","action":"Get many products","resources":["product"]}]

credentials_required:
  [{"name":"pipedriveApi","required":true,"displayOptions":{"show":{"authentication":["apiToken"]}},"testedBy":{"request":{"method":"GET","url":"/users/me"}}},{"name":"pipedriveOAuth2Api","required":true,"displayOptions":{"show":{"authentication":["oAuth2"]}}}]


node_type: pipedriveTrigger
package_name: n8n-nodes-base
display_name: Pipedrive Trigger
description: Starts the workflow when Pipedrive events occur
category: trigger
development_style: programmatic
version: 1
operations: []
updated_at: 2025-06-12 12:00:45
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: Pipedrive Trigger node documentation
  description: Learn how to use the Pipedrive Trigger node in n8n. Follow technical documentation to integrate Pipedrive Trigger node into your workflows.
  contentType: [integration, reference]
  ---

  # Pipedrive Trigger node

  [Pipedrive](https://www.pipedrive.com/){:target=_blank .external-link} is a cloud-based sales software company that aims to improve the productivity of businesses through the use of their software.

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

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

properties_schema:
  [{"displayName":"Authentication","name":"authentication","type":"options","options":[{"name":"API Token","value":"apiToken"},{"name":"OAuth2","value":"oAuth2"}],"default":"apiToken"},{"displayName":"Incoming Authentication","name":"incomingAuthentication","type":"options","options":[{"name":"Basic Auth","value":"basicAuth"},{"name":"None","value":"none"}],"default":"none","description":"If authentication should be activated for the webhook (makes it more secure)"},{"displayName":"Action","name":"action","type":"options","options":[{"name":"Added","value":"added","description":"Data got added","action":"Data was added"},{"name":"All","value":"*","description":"Any change","action":"Any change"},{"name":"Deleted","value":"deleted","description":"Data got deleted","action":"Data was deleted"},{"name":"Merged","value":"merged","description":"Data got merged","action":"Data was merged"},{"name":"Updated","value":"updated","description":"Data got updated","action":"Data was updated"}],"default":"*","description":"Type of action to receive notifications about"},{"displayName":"Object","name":"object","type":"options","options":[{"name":"Activity","value":"activity"},{"name":"Activity Type","value":"activityType"},{"name":"All","value":"*"},{"name":"Deal","value":"deal"},{"name":"Note","value":"note"},{"name":"Organization","value":"organization"},{"name":"Person","value":"person"},{"name":"Pipeline","value":"pipeline"},{"name":"Product","value":"product"},{"name":"Stage","value":"stage"},{"name":"User","value":"user"}],"default":"*","description":"Type of object to receive notifications about"}]

credentials_required:
  [{"name":"pipedriveApi","required":true,"displayOptions":{"show":{"authentication":["apiToken"]}}},{"name":"pipedriveOAuth2Api","required":true,"displayOptions":{"show":{"authentication":["oAuth2"]}}},{"name":"httpBasicAuth","required":true,"displayOptions":{"show":{"incomingAuthentication":["basicAuth"]}}}]


node_type: plivo
package_name: n8n-nodes-base
display_name: Plivo
description: Send SMS/MMS messages or make phone calls
category: transform
development_style: programmatic
version: 1
credentials_required: [{"name":"plivoApi","required":true}]
updated_at: 2025-06-12 12:00:45
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: Plivo node documentation
  description: Learn how to use the Plivo node in n8n. Follow technical documentation to integrate Plivo node into your workflows.
  contentType: [integration, reference]
  ---

  # Plivo node

  Use the Plivo node to automate work in Plivo, and integrate Plivo with other applications. n8n has built-in support for a wide range of Plivo features, including making calls, and sending SMS/MMS. 

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

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

  ## Operations

  * Call
      * Make a voice call
  * MMS
      * Send an MMS message (US/Canada only)
  * SMS
      * Send an SMS message.

  ## Templates and examples

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

properties_schema:
  [{"displayName":"Resource","name":"resource","type":"options","noDataExpression":true,"options":[{"name":"Call","value":"call"},{"name":"MMS","value":"mms"},{"name":"SMS","value":"sms"}],"default":"sms","required":true},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["sms"]}},"options":[{"name":"Send","value":"send","description":"Send an SMS message","action":"Send an SMS"}],"default":"send"},{"displayName":"From","name":"from","type":"string","default":"","description":"Plivo Number to send the SMS from","placeholder":"+14156667777","required":true,"displayOptions":{"show":{"resource":["sms"],"operation":["send"]}}},{"displayName":"To","name":"to","type":"string","default":"","description":"Phone number to send the message to","placeholder":"+14156667778","required":true,"displayOptions":{"show":{"resource":["sms"],"operation":["send"]}}},{"displayName":"Message","name":"message","type":"string","default":"","description":"Message to send","required":true,"displayOptions":{"show":{"operation":["send"],"resource":["sms"]}}},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["mms"]}},"options":[{"name":"Send","value":"send","description":"Send an MMS message (US/Canada only)","action":"Send an MMS"}],"default":"send"},{"displayName":"From","name":"from","type":"string","default":"","description":"Plivo Number to send the MMS from","placeholder":"+14156667777","required":true,"displayOptions":{"show":{"resource":["mms"],"operation":["send"]}}},{"displayName":"To","name":"to","type":"string","default":"","description":"Phone number to send the MMS to","placeholder":"+14156667778","required":true,"displayOptions":{"show":{"operation":["send"],"resource":["mms"]}}},{"displayName":"Message","name":"message","type":"string","default":"","description":"Message to send","displayOptions":{"show":{"resource":["mms"],"operation":["send"]}}},{"displayName":"Media URLs","name":"media_urls","type":"string","default":"","displayOptions":{"show":{"resource":["mms"],"operation":["send"]}},"description":"Comma-separated list of media URLs of the files from your file server"},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["call"]}},"options":[{"name":"Make","value":"make","description":"Make a voice call","action":"Make a call"}],"default":"make"},{"displayName":"From","name":"from","type":"string","default":"","placeholder":"+14156667777","description":"Caller ID for the call to make","required":true,"displayOptions":{"show":{"resource":["call"],"operation":["make"]}}},{"displayName":"To","name":"to","type":"string","default":"","placeholder":"+14156667778","required":true,"description":"Phone number to make the call to","displayOptions":{"show":{"resource":["call"],"operation":["make"]}}},{"displayName":"Answer Method","name":"answer_method","type":"options","required":true,"description":"HTTP verb to be used when invoking the Answer URL","default":"POST","options":[{"name":"GET","value":"GET"},{"name":"POST","value":"POST"}],"displayOptions":{"show":{"resource":["call"],"operation":["make"]}}},{"displayName":"Answer URL","name":"answer_url","type":"string","default":"","description":"URL to be invoked by Plivo once the call is answered. It should return the XML to handle the call once answered.","required":true,"displayOptions":{"show":{"resource":["call"],"operation":["make"]}}}]

operations:
  [{"type":"resource","resource":"call","name":"Call"},{"type":"resource","resource":"mms","name":"MMS"},{"type":"resource","resource":"sms","name":"SMS"},{"type":"operation","operation":"send","name":"Send","action":"Send an SMS","resources":["sms"]},{"type":"operation","operation":"send","name":"Send","action":"Send an MMS","resources":["mms"]},{"type":"operation","operation":"make","name":"Make","action":"Make a call","resources":["call"]}]


node_type: postBin
package_name: n8n-nodes-base
display_name: PostBin
description: Consume PostBin API
category: transform
development_style: programmatic
version: 1
credentials_required: []
updated_at: 2025-06-12 12:00:45
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: PostBin node documentation
  description: Learn how to use the PostBin node in n8n. Follow technical documentation to integrate PostBin node into your workflows.
  contentType: [integration, reference]
  priority: high
  ---

  # PostBin node

  PostBin is a service that helps you test API clients and webhooks. Use the PostBin node to automate work in PostBin, and integrate PostBin with other applications. n8n has built-in support for a wide range of PostBin features, including creating and deleting bins, and getting and sending requests. 

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

  ## Operations

  * Bin
  	* Create
  	* Get
  	* Delete
  * Request
  	* Get
  	* Remove First
  	* Send

  ## Templates and examples

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

  ## Send requests

  To send requests to a PostBin bin:

  1. Go to [PostBin](https://www.toptal.com/developers/postbin/){:target=_blank .external-link} and follow the steps to generate a new bin. PostBin gives you a unique URL, including a bin ID.
  2. In the PostBin node, select the **Request** resource.
  3. Choose the type of **Operation** you want to perform.
  4. Enter your bin ID in **Bin ID**.

  ## Create and manage bins

  You can create and manage PostBin bins using the PostBin node. 

  1. In **Resource**, select **Bin**.
  2. Choose an **Operation**. You can create, delete, or get a bin.

properties_schema:
  [{"displayName":"Resource","name":"resource","type":"options","noDataExpression":true,"options":[{"name":"Bin","value":"bin"},{"name":"Request","value":"request"}],"default":"bin","required":true},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["bin"]}},"options":[{"name":"Create","value":"create","description":"Create bin","routing":{"request":{"method":"POST","url":"/developers/postbin/api/bin"},"output":{"postReceive":[null]}},"action":"Create a bin"},{"name":"Get","value":"get","description":"Get a bin","routing":{"request":{"method":"GET"},"output":{"postReceive":[null]},"send":{"preSend":[null]}},"action":"Get a bin"},{"name":"Delete","value":"delete","description":"Delete a bin","routing":{"request":{"method":"DELETE"},"send":{"preSend":[null]}},"action":"Delete a bin"}],"default":"create"},{"displayName":"Bin ID","name":"binId","type":"string","default":"","required":true,"displayOptions":{"show":{"resource":["bin"],"operation":["get","delete"]}},"description":"Unique identifier for each bin"},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["request"]}},"options":[{"name":"Get","value":"get","description":"Get a request","routing":{"request":{"method":"GET","url":"=/developers/postbin/api/bin/{{$parameter[\"binId\"]}}/req/{{$parameter[\"requestId\"]}}"},"send":{"preSend":[null]}},"action":"Get a request"},{"name":"Remove First","value":"removeFirst","description":"Remove the first request from bin","routing":{"request":{"method":"GET","url":"=/developers/postbin/api/bin/{{$parameter[\"binId\"]}}/req/shift"},"send":{"preSend":[null]}},"action":"Remove First a request"},{"name":"Send","value":"send","description":"Send a test request to the bin","routing":{"request":{"method":"POST"},"send":{"preSend":[null]},"output":{"postReceive":[{"type":"set","properties":{"value":"={{ { \"requestId\": $response.body } }}"}}]}},"action":"Send a request"}],"default":"get"},{"displayName":"Bin ID","name":"binId","type":"string","default":"","required":true,"displayOptions":{"show":{"resource":["request"],"operation":["get","removeFirst","send"]}},"description":"Unique identifier for each bin"},{"displayName":"Bin Content","name":"binContent","type":"string","default":"","typeOptions":{"rows":5},"displayOptions":{"show":{"resource":["request"],"operation":["send"]}},"routing":{"send":{"property":"content","type":"body"}}},{"displayName":"Request ID","name":"requestId","type":"string","default":"","required":true,"displayOptions":{"show":{"resource":["request"],"operation":["get"]}},"description":"Unique identifier for each request"}]

operations:
  [{"type":"resource","resource":"bin","name":"Bin"},{"type":"resource","resource":"request","name":"Request"},{"type":"operation","operation":"create","name":"Create","action":"Create a bin","resources":["bin"]},{"type":"operation","operation":"get","name":"Get","action":"Get a bin","resources":["bin"]},{"type":"operation","operation":"delete","name":"Delete","action":"Delete a bin","resources":["bin"]},{"type":"operation","operation":"get","name":"Get","action":"Get a request","resources":["request"]},{"type":"operation","operation":"removeFirst","name":"Remove First","action":"Remove First a request","resources":["request"]},{"type":"operation","operation":"send","name":"Send","action":"Send a request","resources":["request"]}]


node_type: postgres
package_name: n8n-nodes-base
display_name: Postgres
description: Get, add and update data in Postgres
category: input
development_style: programmatic
version: 1
properties_schema: []
operations: []
credentials_required: []
updated_at: 2025-06-12 12:00:45
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: Postgres node documentation
  description: Learn how to use the Postgres node in n8n. Follow technical documentation to integrate Postgres node into your workflows.
  contentType: [integration, reference]
  priority: critical
  ---

  # Postgres node

  Use the Postgres node to automate work in Postgres, and integrate Postgres with other applications. n8n has built-in support for a wide range of Postgres features, including executing queries, as well as inserting and updating rows in a database. 

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

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

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

  ## Operations

  * [**Delete**](#delete): Delete an entire table or rows in a table
  * [**Execute Query**](#execute-query): Execute an SQL query
  * [**Insert**](#insert): Insert rows in a table
  * [**Insert or Update**](#insert-or-update): Insert or update rows in a table
  * [**Select**](#select): Select rows from a table
  * [**Update**](#update): Update rows in a table

  ### Delete

  Use this operation to delete an entire table or rows in a table.

  Enter these parameters:

  - **Credential to connect with**: Create or select an existing [Postgres credential](/integrations/builtin/credentials/postgres.md).
  - **Operation**: Select **Delete**.
  - **Schema**: Choose the schema that contains the table you want to work on. Select **From list** to choose the schema from the dropdown list or **By Name** to enter the schema name.
  - **Table**: Choose the table that you want to work on. Select **From list** to choose the table from the dropdown list or **By Name** to enter the table name.
  - **Command**: The deletion action to take:
  	- **Truncate**: Removes the table's data but preserves the table's structure.
  		- **Restart Sequences**: Whether to reset auto increment columns to their initial values as part of the Truncate process.
  	- **Delete**: Delete the rows that match the "Select Rows" condition. If you don't select anything, Postgres deletes all rows.
  		- **Select Rows**: Define a **Column**, **Operator**, and **Value** to match rows on.
  		- **Combine Conditions**: How to combine the conditions in "Select Rows". **AND** requires all conditions to be true, while **OR** requires at least one condition to be true.
  	- **Drop**: Deletes the table's data and structure permanently.

  #### Delete options

  - **Cascade**: Whether to also drop all objects that depend on the table, like views and sequences. Available if using **Truncate** or **Drop** commands.
  - **Connection Timeout**: The number of seconds to try to connect to the database.
  - **Delay Closing Idle Connection**: The number of seconds to wait before considering idle connections eligible for closing.
  - **Query Batching**: The way to send queries to the database:
  	- **Single Query**: A single query for all incoming items.
  	- **Independently**: Execute one query per incoming item of the execution.
  	- **Transaction**: Execute all queries in a transaction. If a failure occurs, Postgres rolls back all changes.
  - **Output Large-Format Numbers As**: The format to output `NUMERIC` and `BIGINT` columns as:
  	- **Numbers**: Use this for standard numbers.
  	- **Text**: Use this if you expect numbers longer than 16 digits. Without this, numbers may be incorrect.

  ### Execute Query

  Use this operation to execute an SQL query.

  Enter these parameters:

  - **Credential to connect with**: Create or select an existing [Postgres credential](/integrations/builtin/credentials/postgres.md).
  - **Operation**: Select **Execute Query**.
  - **Query**: The SQL query to execute. You can use n8n [expressions](/code/expressions.md) and tokens like `$1`, `$2`, and `$3` to build [prepared statements](https://www.postgresql.org/docs/current/sql-prepare.html) to use with [query parameters](#use-query-parameters).

  #### Execute Query options

  - **Connection Timeout**: The number of seconds to try to connect to the database.
  - **Delay Closing Idle Connection**: The number of seconds to wait before considering idle connections eligible for closing.
  - **Query Batching**: The way to send queries to the database:
  	- **Single Query**: A single query for all incoming items.
  	- **Independently**: Execute one query per incoming item of the execution.
  	- **Transaction**: Execute all queries in a transaction. If a failure occurs, Postgres rolls back all changes.
  - **Query Parameters**: A comma-separated list of values that you want to use as [query parameters](#use-query-parameters).
  - **Output Large-Format Numbers As**: The format to output `NUMERIC` and `BIGINT` columns as:
  	- **Numbers**: Use this for standard numbers.
  	- **Text**: Use this if you expect numbers longer than 16 digits. Without this, numbers may be incorrect.
  - **Replace Empty Strings with NULL**: Whether to replace empty strings with NULL in input. This may be useful when working with data exported from spreadsheet software.

  ### Insert

  Use this operation to insert rows in a table.

  Enter these parameters:

  - **Credential to connect with**: Create or select an existing [Postgres credential](/integrations/builtin/credentials/postgres.md).
  - **Operation**: Select **Insert**.
  - **Schema**: Choose the schema that contains the table you want to work on. Select **From list** to choose the schema from the dropdown list or **By Name** to enter the schema name.
  - **Table**: Choose the table that you want to work on. Select **From list** to choose the table from the dropdown list or **By Name** to enter the table name.
  - **Mapping Column Mode**: How to map column names to incoming data:
  	- **Map Each Column Manually**: Select the values to use for each column.
  	- **Map Automatically**: Automatically map incoming data to matching column names in Postgres. The incoming data field names must match the column names in Postgres for this to work. If necessary, consider using the [edit fields (set) node](https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.set/) before this node to adjust the format as needed.

  #### Insert options

  - **Connection Timeout**: The number of seconds to try to connect to the database.
  - **Delay Closing Idle Connection**: The number of seconds to wait before considering idle connections eligible for closing.
  - **Query Batching**: The way to send queries to the database:
  	- **Single Query**: A single query for all incoming items.
  	- **Independently**: Execute one query per incoming item of the execution.
  	- **Transaction**: Execute all queries in a transaction. If a failure occurs, Postgres rolls back all changes.
  - **Output Columns**: Choose which columns to output. You can select from a list of available columns or specify IDs using [expressions](/code/expressions.md).
  - **Output Large-Format Numbers As**: The format to output `NUMERIC` and `BIGINT` columns as:
  	- **Numbers**: Use this for standard numbers.
  	- **Text**: Use this if you expect numbers longer than 16 digits. Without this, numbers may be incorrect.
  - **Skip on Conflict**: Whether to skip the row if the insert violates a unique or exclusion constraint instead of throwing an error.
  - **Replace Empty Strings with NULL**: Whether to replace empty strings with NULL in input. This may be useful when working with data exported from spreadsheet software.

  ### Insert or Update

  Use this operation to insert or update rows in a table.

  Enter these parameters:

  - **Credential to connect with**: Create or select an existing [Postgres credential](/integrations/builtin/credentials/postgres.md).
  - **Operation**: Select **Insert or Update**.
  - **Schema**: Choose the schema that contains the table you want to work on. Select **From list** to choose the schema from the dropdown list or **By Name** to enter the schema name.
  - **Table**: Choose the table that you want to work on. Select **From list** to choose the table from the dropdown list or **By Name** to enter the table name.
  - **Mapping Column Mode**: How to map column names to incoming data:
  	- **Map Each Column Manually**: Select the values to use for each column.
  	- **Map Automatically**: Automatically map incoming data to matching column names in Postgres. The incoming data field names must match the column names in Postgres for this to work. If necessary, consider using the [edit fields (set) node](https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.set/) before this node to adjust the format as needed.

  #### Insert or Update options

  - **Connection Timeout**: The number of seconds to try to connect to the database.
  - **Delay Closing Idle Connection**: The number of seconds to wait before considering idle connections eligible for closing.
  - **Query Batching**: The way to send queries to the database:
  	- **Single Query**: A single query for all incoming items.
  	- **Independently**: Execute one query per incoming item of the execution.
  	- **Transaction**: Execute all queries in a transaction. If a failure occurs, Postgres rolls back all changes.
  - **Output Columns**: Choose which columns to output. You can select from a list of available columns or specify IDs using [expressions](/code/expressions.md).
  - **Output Large-Format Numbers As**: The format to output `NUMERIC` and `BIGINT` columns as:
  	- **Numbers**: Use this for standard numbers.
  	- **Text**: Use this if you expect numbers longer than 16 digits. Without this, numbers may be incorrect.
  - **Replace Empty Strings with NULL**: Whether to replace empty strings with NULL in input. This may be useful when working with data exported from spreadsheet software.

  ### Select

  Use this operation to select rows in a table.

  Enter these parameters:

  - **Credential to connect with**: Create or select an existing [Postgres credential](/integrations/builtin/credentials/postgres.md).
  - **Operation**: Select **Select**.
  - **Schema**: Choose the schema that contains the table you want to work on. Select **From list** to choose the schema from the dropdown list or **By Name** to enter the schema name.
  - **Table**: Choose the table that you want to work on. Select **From list** to choose the table from the dropdown list or **By Name** to enter the table name.
  - **Return All**: Whether to return all results or only up to a given limit.
  - **Limit**: The maximum number of items to return when **Return All** is disabled.
  - **Select Rows**: Set the conditions to select rows. Define a **Column**, **Operator**, and **Value** to match rows on. If you don't select anything, Postgres selects all rows.
  - **Combine Conditions**: How to combine the conditions in **Select Rows**. **AND** requires all conditions to be true, while **OR** requires at least one condition to be true.
  - **Sort**: Choose how to sort the selected rows. Choose a **Column** from a list or by ID and a sort **Direction**.

  #### Select options

  - **Connection Timeout**: The number of seconds to try to connect to the database.
  - **Delay Closing Idle Connection**: The number of seconds to wait before considering idle connections eligible for closing.
  - **Query Batching**: The way to send queries to the database:
  	- **Single Query**: A single query for all incoming items.
  	- **Independently**: Execute one query per incoming item of the execution.
  	- **Transaction**: Execute all queries in a transaction. If a failure occurs, Postgres rolls back all changes.
  - **Output Columns**: Choose which columns to output. You can select from a list of available columns or specify IDs using [expressions](/code/expressions.md).
  - **Output Large-Format Numbers As**: The format to output `NUMERIC` and `BIGINT` columns as:
  	- **Numbers**: Use this for standard numbers.
  	- **Text**: Use this if you expect numbers longer than 16 digits. Without this, numbers may be incorrect.

  ### Update

  Use this operation to update rows in a table.

  Enter these parameters:

  - **Credential to connect with**: Create or select an existing [Postgres credential](/integrations/builtin/credentials/postgres.md).
  - **Operation**: Select **Update**.
  - **Schema**: Choose the schema that contains the table you want to work on. Select **From list** to choose the schema from the dropdown list or **By Name** to enter the schema name.
  - **Table**: Choose the table that you want to work on. Select **From list** to choose the table from the dropdown list or **By Name** to enter the table name.
  - **Mapping Column Mode**: How to map column names to incoming data:
  	- **Map Each Column Manually**: Select the values to use for each column.
  	- **Map Automatically**: Automatically map incoming data to matching column names in Postgres. The incoming data field names must match the column names in Postgres for this to work. If necessary, consider using the [edit fields (set) node](https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.set/) before this node to adjust the format as needed.

  #### Update options

  - **Connection Timeout**: The number of seconds to try to connect to the database.
  - **Delay Closing Idle Connection**: The number of seconds to wait before considering idle connections eligible for closing.
  - **Query Batching**: The way to send queries to the database:
  	- **Single Query**: A single query for all incoming items.
  	- **Independently**: Execute one query per incoming item of the execution.
  	- **Transaction**: Execute all queries in a transaction. If a failure occurs, Postgres rolls back all changes.
  - **Output Columns**: Choose which columns to output. You can select from a list of available columns or specify IDs using [expressions](/code/expressions.md).
  - **Output Large-Format Numbers As**: The format to output `NUMERIC` and `BIGINT` columns as:
  	- **Numbers**: Use this for standard numbers.
  	- **Text**: Use this if you expect numbers longer than 16 digits. Without this, numbers may be incorrect.
  - **Replace Empty Strings with NULL**: Whether to replace empty strings with NULL in input. This may be useful when working with data exported from spreadsheet software.

  ## Templates and examples

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

  ## Related resources

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

  ## Use query parameters

  When creating a query to run on a Postgres database, you can use the **Query Parameters** field in the **Options** section to load data into the query. n8n sanitizes data in query parameters, which prevents SQL injection.

  For example, you want to find a person by their email address. Given the following input data:

  ```js
  [
      {
          "email": "alex@example.com",
          "name": "Alex",
          "age": 21 
      },
      {
          "email": "jamie@example.com",
          "name": "Jamie",
          "age": 33 
      }
  ]
  ```

  You can write a query like:

  ```sql
  SELECT * FROM $1:name WHERE email = $2;
  ```

  Then in **Query Parameters**, provide the field values to use. You can provide fixed values or expressions. For this example, use expressions so the node can pull the email address from each input item in turn:

  ```js
  // users is an example table name
  {{ [ 'users', $json.email ] }} 
  ```

  ## Common issues

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


node_type: postgresTrigger
package_name: n8n-nodes-base
display_name: Postgres Trigger
description: Listens to Postgres messages
category: trigger
development_style: programmatic
version: 1
operations: []
credentials_required: [{"name":"postgres","required":true}]
updated_at: 2025-06-12 12:00:45
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: Postgres Trigger node documentation
  description: Learn how to use the Postgres Trigger node in n8n. Follow technical documentation to integrate Postgres Trigger node into your workflows.
  contentType: [integration, reference]
  priority: medium
  ---

  # Postgres Trigger node

  Use the Postgres Trigger node to respond to events in [Postgres](https://www.postgresql.org/){:target=_blank .external-link} and integrate Postgres with other applications. n8n has built-in support responding to insert, update, and delete events.

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

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

  ## Events

  You can configure how the node listens for events.

  * Select **Listen and Create Trigger Rule**, then choose the events to listen for:
  	* Insert
  	* Update
  	* Delete
  * Select **Listen to Channel**, then enter a channel name that the node should monitor.

  ## Related resources

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

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

properties_schema:
  [{"displayName":"Listen For","name":"triggerMode","type":"options","options":[{"name":"Table Row Change Events","value":"createTrigger","description":"Insert, update or delete"},{"name":"Advanced","value":"listenTrigger","description":"Listen to existing Postgres channel"}],"default":"createTrigger"},{"displayName":"Schema Name","name":"schema","type":"resourceLocator","default":{"mode":"list","value":"public"},"required":true,"displayOptions":{"show":{"triggerMode":["createTrigger"]}},"modes":[{"displayName":"From List","name":"list","type":"list","placeholder":"Select a schema","typeOptions":{"searchListMethod":"searchSchema","searchFilterRequired":false}},{"displayName":"Name","name":"name","type":"string","placeholder":"e.g. public"}]},{"displayName":"Table Name","name":"tableName","type":"resourceLocator","default":{"mode":"list","value":""},"required":true,"displayOptions":{"show":{"triggerMode":["createTrigger"]}},"modes":[{"displayName":"From List","name":"list","type":"list","placeholder":"Select a table","typeOptions":{"searchListMethod":"searchTables","searchFilterRequired":false}},{"displayName":"Name","name":"name","type":"string","placeholder":"e.g. table_name"}]},{"displayName":"Channel Name","name":"channelName","type":"string","default":"","required":true,"placeholder":"e.g. n8n_channel","description":"Name of the channel to listen to","displayOptions":{"show":{"triggerMode":["listenTrigger"]}}},{"displayName":"Event to listen for","name":"firesOn","type":"options","displayOptions":{"show":{"triggerMode":["createTrigger"]}},"options":[{"name":"Insert","value":"INSERT"},{"name":"Update","value":"UPDATE"},{"name":"Delete","value":"DELETE"}],"default":"INSERT"},{"displayName":"Additional Fields","name":"additionalFields","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"triggerMode":["createTrigger"]}},"options":[{"displayName":"Channel Name","name":"channelName","type":"string","placeholder":"e.g. n8n_channel","description":"Name of the channel to listen to","default":""},{"displayName":"Function Name","name":"functionName","type":"string","description":"Name of the function to create","placeholder":"e.g. n8n_trigger_function()","default":""},{"displayName":"Replace if Exists","name":"replaceIfExists","type":"boolean","description":"Whether to replace an existing function and trigger with the same name","default":false},{"displayName":"Trigger Name","name":"triggerName","type":"string","description":"Name of the trigger to create","placeholder":"e.g. n8n_trigger","default":""}]}]


node_type: postHog
package_name: n8n-nodes-base
display_name: PostHog
description: Consume PostHog API
category: input
development_style: programmatic
version: 1
credentials_required: [{"name":"postHogApi","required":true}]
updated_at: 2025-06-12 12:00:45
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: PostHog node documentation
  description: Learn how to use the PostHog node in n8n. Follow technical documentation to integrate PostHog node into your workflows.
  contentType: [integration, reference]
  ---

  # PostHog node

  Use the PostHog node to automate work in PostHog, and integrate PostHog with other applications. n8n has built-in support for a wide range of PostHog features, including creating aliases, events, and identity, as well as tracking pages.

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

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

  ## Operations

  * Alias
      * Create an alias
  * Event
      * Create an event
  * Identity
      * Create
  * Track
      * Track a page
      * Track a screen

  ## Templates and examples

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

properties_schema:
  [{"displayName":"Resource","name":"resource","type":"options","noDataExpression":true,"options":[{"name":"Alias","value":"alias"},{"name":"Event","value":"event"},{"name":"Identity","value":"identity"},{"name":"Track","value":"track"}],"default":"event"},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["alias"]}},"options":[{"name":"Create","value":"create","description":"Create an alias","action":"Create an alias"}],"default":"create"},{"displayName":"Alias","name":"alias","type":"string","required":true,"displayOptions":{"show":{"resource":["alias"],"operation":["create"]}},"default":"","description":"The name of the alias"},{"displayName":"Distinct ID","name":"distinctId","type":"string","required":true,"displayOptions":{"show":{"resource":["alias"],"operation":["create"]}},"default":"","description":"The user's distinct ID"},{"displayName":"Additional Fields","name":"additionalFields","type":"collection","placeholder":"Add Field","displayOptions":{"show":{"resource":["alias"],"operation":["create"]}},"default":{},"options":[{"displayName":"Context","name":"contextUi","type":"fixedCollection","placeholder":"Add Property","default":{},"typeOptions":{"multipleValues":true},"options":[{"displayName":"Context","name":"contextValues","values":[{"displayName":"Key","name":"key","type":"string","default":""},{"displayName":"Value","name":"value","type":"string","default":""}]}]},{"displayName":"Timestamp","name":"timestamp","type":"dateTime","default":"","description":"If not set, it'll automatically be set to the current time"}]},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["event"]}},"options":[{"name":"Create","value":"create","description":"Create an event","action":"Create an event"}],"default":"create"},{"displayName":"Event","name":"eventName","type":"string","required":true,"displayOptions":{"show":{"resource":["event"],"operation":["create"]}},"default":"","description":"The name of the event"},{"displayName":"Distinct ID","name":"distinctId","type":"string","required":true,"displayOptions":{"show":{"resource":["event"],"operation":["create"]}},"default":"","description":"The user's distinct ID"},{"displayName":"Additional Fields","name":"additionalFields","type":"collection","placeholder":"Add Field","displayOptions":{"show":{"resource":["event"],"operation":["create"]}},"default":{},"options":[{"displayName":"Properties","name":"propertiesUi","type":"fixedCollection","placeholder":"Add Property","default":{},"typeOptions":{"multipleValues":true},"options":[{"displayName":"Property","name":"propertyValues","values":[{"displayName":"Key","name":"key","type":"string","default":""},{"displayName":"Value","name":"value","type":"string","default":""}]}]},{"displayName":"Timestamp","name":"timestamp","type":"dateTime","default":"","description":"If not set, it'll automatically be set to the current time"}]},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["identity"]}},"options":[{"name":"Create","value":"create","action":"Create an identity"}],"default":"create"},{"displayName":"Distinct ID","name":"distinctId","type":"string","required":true,"displayOptions":{"show":{"resource":["identity"],"operation":["create"]}},"default":"","description":"The identity's distinct ID"},{"displayName":"Additional Fields","name":"additionalFields","type":"collection","placeholder":"Add Field","displayOptions":{"show":{"resource":["identity"],"operation":["create"]}},"default":{},"options":[{"displayName":"Properties","name":"propertiesUi","type":"fixedCollection","placeholder":"Add Property","default":{},"typeOptions":{"multipleValues":true},"options":[{"displayName":"Property","name":"propertyValues","values":[{"displayName":"Key","name":"key","type":"string","default":""},{"displayName":"Value","name":"value","type":"string","default":""}]}]},{"displayName":"Message ID","name":"messageId","type":"string","default":""},{"displayName":"Timestamp","name":"timestamp","type":"dateTime","default":"","description":"If not set, it'll automatically be set to the current time"}]},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["track"]}},"options":[{"name":"Page","value":"page","description":"Track a page","action":"Track a page"},{"name":"Screen","value":"screen","description":"Track a screen","action":"Track a screen"}],"default":"page"},{"displayName":"Name","name":"name","type":"string","required":true,"displayOptions":{"show":{"resource":["track"],"operation":["page","screen"]}},"default":""},{"displayName":"Distinct ID","name":"distinctId","type":"string","required":true,"displayOptions":{"show":{"resource":["track"],"operation":["page","screen"]}},"default":"","description":"The user's distinct ID"},{"displayName":"Additional Fields","name":"additionalFields","type":"collection","placeholder":"Add Field","displayOptions":{"show":{"resource":["track"],"operation":["page","screen"]}},"default":{},"options":[{"displayName":"Category","name":"category","type":"string","default":""},{"displayName":"Context","name":"contextUi","type":"fixedCollection","placeholder":"Add Property","default":{},"typeOptions":{"multipleValues":true},"options":[{"displayName":"Context","name":"contextValues","values":[{"displayName":"Key","name":"key","type":"string","default":""},{"displayName":"Value","name":"value","type":"string","default":""}]}]},{"displayName":"Message ID","name":"messageId","type":"string","default":""},{"displayName":"Properties","name":"propertiesUi","type":"fixedCollection","placeholder":"Add Property","default":{},"typeOptions":{"multipleValues":true},"options":[{"displayName":"Property","name":"propertyValues","values":[{"displayName":"Key","name":"key","type":"string","default":""},{"displayName":"Value","name":"value","type":"string","default":""}]}]},{"displayName":"Timestamp","name":"timestamp","type":"dateTime","default":"","description":"If not set, it'll automatically be set to the current time"}]}]

operations:
  [{"type":"resource","resource":"alias","name":"Alias"},{"type":"resource","resource":"event","name":"Event"},{"type":"resource","resource":"identity","name":"Identity"},{"type":"resource","resource":"track","name":"Track"},{"type":"operation","operation":"create","name":"Create","action":"Create an alias","resources":["alias"]},{"type":"operation","operation":"create","name":"Create","action":"Create an event","resources":["event"]},{"type":"operation","operation":"create","name":"Create","action":"Create an identity","resources":["identity"]},{"type":"operation","operation":"page","name":"Page","action":"Track a page","resources":["track"]},{"type":"operation","operation":"screen","name":"Screen","action":"Track a screen","resources":["track"]}]


node_type: postmarkTrigger
package_name: n8n-nodes-base
display_name: Postmark Trigger
description: Starts the workflow when Postmark events occur
category: trigger
development_style: programmatic
version: 1
operations: []
credentials_required: [{"name":"postmarkApi","required":true}]
updated_at: 2025-06-12 12:00:45
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: Postmark Trigger node documentation
  description: Learn how to use the Postmark Trigger node in n8n. Follow technical documentation to integrate Postmark Trigger node into your workflows.
  contentType: [integration, reference]
  ---

  # Postmark Trigger node

  [Postmark](https://postmarkapp.com){:target=_blank .external-link} helps deliver and track application email. You can track statistics such as the number of emails sent or processed, opens, bounces and, spam complaints.

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

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

properties_schema:
  [{"displayName":"Events","name":"events","type":"multiOptions","options":[{"name":"Bounce","value":"bounce","description":"Trigger on bounce"},{"name":"Click","value":"click","description":"Trigger on click"},{"name":"Delivery","value":"delivery","description":"Trigger on delivery"},{"name":"Open","value":"open","description":"Trigger webhook on open"},{"name":"Spam Complaint","value":"spamComplaint","description":"Trigger on spam complaint"},{"name":"Subscription Change","value":"subscriptionChange","description":"Trigger on subscription change"}],"default":[],"required":true,"description":"Webhook events that will be enabled for that endpoint"},{"displayName":"First Open","name":"firstOpen","description":"Only fires on first open for event \"Open\"","type":"boolean","default":false,"displayOptions":{"show":{"events":["open"]}}},{"displayName":"Include Content","name":"includeContent","description":"Whether to include message content for events \"Bounce\" and \"Spam Complaint\"","type":"boolean","default":false,"displayOptions":{"show":{"events":["bounce","spamComplaint"]}}}]


node_type: profitWell
package_name: n8n-nodes-base
display_name: ProfitWell
description: Consume ProfitWell API
category: output
development_style: programmatic
version: 1
credentials_required: [{"name":"profitWellApi","required":true}]
updated_at: 2025-06-12 12:00:45
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: ProfitWell node documentation
  description: Learn how to use the ProfitWell node in n8n. Follow technical documentation to integrate ProfitWell node into your workflows.
  contentType: [integration, reference]
  ---

  # ProfitWell node

  Use the ProfitWell node to automate work in ProfitWell, and integrate ProfitWell with other applications. n8n supports getting your company's account settings and retrieving financial metrics from ProfitWell.

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

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

  ## Operations

  * Company
      * Get your company's ProfitWell account settings
  * Metric
      * Retrieve financial metric broken down by day for either the current month or the last

  ## Templates and examples

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

properties_schema:
  [{"displayName":"Resource","name":"resource","type":"options","noDataExpression":true,"options":[{"name":"Company","value":"company"},{"name":"Metric","value":"metric"}],"default":"metric"},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["company"]}},"options":[{"name":"Get Settings","value":"getSetting","description":"Get your company's ProfitWell account settings","action":"Get settings for your company"}],"default":"getSetting"},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["metric"]}},"options":[{"name":"Get","value":"get","description":"Retrieve financial metric broken down by day for either the current month or the last","action":"Get a metric"}],"default":"get"},{"displayName":"Type","name":"type","type":"options","options":[{"name":"Daily","value":"daily","description":"Retrieve financial metric broken down by day for either the current month or the last"},{"name":"Monthly","value":"monthly","description":"Retrieve all monthly financial metric for your company"}],"default":"","required":true,"displayOptions":{"show":{"resource":["metric"],"operation":["get"]}}},{"displayName":"Month","name":"month","type":"string","default":"","placeholder":"YYYY-MM","required":true,"displayOptions":{"show":{"resource":["metric"],"operation":["get"],"type":["daily"]}},"description":"Can only be the current or previous month. Format should be YYYY-MM."},{"displayName":"Simplify","name":"simple","type":"boolean","default":true,"displayOptions":{"show":{"resource":["metric"],"operation":["get"]}},"description":"Whether to return a simplified version of the response instead of the raw data"},{"displayName":"Options","name":"options","type":"collection","placeholder":"Add Option","displayOptions":{"show":{"resource":["metric"],"operation":["get"]}},"default":{},"options":[{"displayName":"Plan Name or ID","name":"plan_id","type":"options","typeOptions":{"loadOptionsMethod":"getPlanIds"},"default":"","description":"Only return the metric for this Plan ID. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Metrics","name":"dailyMetrics","type":"multiOptions","displayOptions":{"show":{"/type":["daily"]}},"options":[{"name":"Active Customers","value":"active_customers","description":"Number of paying customers"},{"name":"Churned Customers","value":"churned_customers","description":"Number of paying customers who churned"},{"name":"Churned Recurring Revenue","value":"churned_recurring_revenue","description":"MRR lost to churn (voluntary and delinquent)"},{"name":"Cumulative Net New MRR","value":"cumulative_net_new_mrr","description":"New + Upgrades - Downgrades - Churn MRR, cumulative for the month up through the given day"},{"name":"Cumulative New Trialing Customers","value":"cumulative_new_trialing_customers","description":"Number of new trialing customers, cumulative for the month up through the given day"},{"name":"Downgraded Customers","value":"downgraded_customers","description":"Number of existing customers who net downgraded"},{"name":"Downgraded Recurring Revenue","value":"downgraded_recurring_revenue","description":"How much downgrades and plan length decreases affect your MRR"},{"name":"Future Churn MRR","value":"future_churn_mrr","description":"MRR that will be lost when users who are currently cancelled actually churn"},{"name":"New Customers","value":"new_customers","description":"Number of new, paying customers you have"},{"name":"New Recurring Revenue","value":"new_recurring_revenue","description":"MRR from new users"},{"name":"Reactivated Customers","value":"reactivated_customers","description":"Number of customers who have reactivated"},{"name":"Reactivated Recurring Revenue","value":"reactivated_recurring_revenue","description":"How much MRR comes from reactivated customers"},{"name":"Recurring Revenue","value":"recurring_revenue","description":"Your company's MRR"},{"name":"Upgraded Customers","value":"upgraded_customers","description":"Number of existing customers who net upgraded"},{"name":"Upgraded Recurring Revenue","value":"upgraded_recurring_revenue","description":"How much upgrades and plan length increases affect your MRR"}],"default":[],"description":"Comma-separated list of metric trends to return (the default is to return all metric)"},{"displayName":"Metrics","name":"monthlyMetrics","type":"multiOptions","displayOptions":{"show":{"/type":["monthly"]}},"options":[{"name":"Active Customers","value":"active_customers","description":"Number of paying customers"},{"name":"Active Trialing Customers","value":"active_trialing_customers","description":"Number of trialing customers"},{"name":"Average Revenue Per User","value":"average_revenue_per_user","description":"ARPU"},{"name":"Churned Customers","value":"churned_customers","description":"Number of paying customers who churned"},{"name":"Churned Customers Cancellations","value":"churned_customers_cancellations","description":"Number of customers who churned by cancelling their subscription(s)"},{"name":"Churned Customers Delinquent","value":"churned_customers_delinquent","description":"Number of customers who churned because they failed to pay you"},{"name":"Churned Recurring Revenue","value":"churned_recurring_revenue","description":"Revenue lost to churn (voluntary and delinquent)"},{"name":"Churned Recurring Revenue Cancellations","value":"churned_recurring_revenue_cancellations","description":"Revenue lost to customers who churned by cancelling their subscription(s)"},{"name":"Churned Recurring Revenue Delinquent","value":"churned_recurring_revenue_delinquent","description":"Revenue lost to customers who churned delinquent"},{"name":"Churned Trialing Customers","value":"churned_trialing_customers","description":"Number of trialling customers who churned"},{"name":"Converted Customers","value":"converted_customers","description":"Number of customers who converted from trialing to active"},{"name":"Converted Recurring Revenue","value":"converted_recurring_revenue","description":"How much MRR comes from users who converted from trialing to active"},{"name":"Customer Churn Cancellations Rate","value":"customers_churn_cancellations_rate","description":"Percentage of paying customers who churned by cancelling their subscription(s)"},{"name":"Customer Churn Delinquent Rate","value":"customers_churn_delinquent_rate","description":"Percentage of paying customers who churned because they failed to pay you"},{"name":"Customer Churn Rate","value":"customers_churn_rate","description":"Percentage of paying customers who churned"},{"name":"Customer Conversion Rate","value":"customer_conversion_rate","description":"Percent of trialing customers who converted"},{"name":"Customer Retention Rate","value":"customers_retention_rate","description":"Percent of customers active last month who are still active this month"},{"name":"Downgrade Customers","value":"downgraded_customers","description":"Number of existing customers who net downgraded"},{"name":"Downgrade Rate","value":"downgrade_rate","description":"Downgrade revenue as a percent of existing revenue"},{"name":"Downgrade Recurring Revenue","value":"downgraded_recurring_revenue","description":"How much downgrades and plan length decreases affect your MRR"},{"name":"Existing Customers","value":"existing_customers","description":"Number of paying customers you had at the start of the given month"},{"name":"Existing Recurring Revenue","value":"existing_recurring_revenue","description":"Your company's MRR at the start of the given month"},{"name":"Existing Trialing Customers","value":"existing_trialing_customers","description":"Number of trialing customers who existed at the start of the month"},{"name":"Growth_Rate","value":"growth_rate","description":"Rate at which your company's MRR has grown over the previous month"},{"name":"Lifetime Value","value":"lifetime_value","description":"Average LTV, as calculated at the end of the given period"},{"name":"New Customers","value":"new_customers","description":"Number of new, paying customers you have"},{"name":"New Recurring Revenue","value":"new_recurring_revenue","description":"MRR from new users"},{"name":"New Trailing Customers","value":"new_trialing_customers","description":"Number of new trialing customers"},{"name":"Plan Changed Rate","value":"plan_change_rate","description":"Net change in revenue as a percentage of existing revenue"},{"name":"Plan Changed Recurring Revenue","value":"plan_changed_recurring_revenue","description":"Net change in revenue for this plan"},{"name":"Reactivated Customers","value":"reactivated_customers","description":"Number of customers who have reactivated"},{"name":"Reactivated Recurring Revenue","value":"reactivated_recurring_revenue","description":"How much MRR comes from reactivated customers"},{"name":"Recurring Revenue","value":"recurring_revenue","description":"Your company's MRR"},{"name":"Revenue Churn Cancellations Rate","value":"revenue_churn_cancellations_rate","description":"Voluntary churn revenue as a percent of the month's starting revenue"},{"name":"Revenue Churn Delinquent_ Rate","value":"revenue_churn_delinquent_rate","description":"Delinquent churn revenue as a percent of the month's starting revenue"},{"name":"Revenue Churn Rate","value":"revenue_churn_rate","description":"Revenue lost to churn as a percentage of existing revenue"},{"name":"Revenue Retention Rate","value":"revenue_retention_rate","description":"Percent of revenue coming from existing customers that was retained by the end of the month"},{"name":"Upgrade Rate","value":"upgrade_rate","description":"Upgrade revenue as a percent of existing revenue"},{"name":"Upgraded Customers","value":"upgraded_customers","description":"Number of existing customers who net upgraded"},{"name":"Upgraded Recurring Revenue","value":"upgraded_recurring_revenue","description":"How much upgrades and plan length increases affect your MRR"}],"default":[],"description":"Comma-separated list of metric trends to return (the default is to return all metric)"}]}]

operations:
  [{"type":"resource","resource":"company","name":"Company"},{"type":"resource","resource":"metric","name":"Metric"},{"type":"operation","operation":"getSetting","name":"Get Settings","action":"Get settings for your company","resources":["company"]},{"type":"operation","operation":"get","name":"Get","action":"Get a metric","resources":["metric"]}]


node_type: pushbullet
package_name: n8n-nodes-base
display_name: Pushbullet
description: Consume Pushbullet API
category: input
development_style: programmatic
version: 1
credentials_required: [{"name":"pushbulletOAuth2Api","required":true}]
updated_at: 2025-06-12 12:00:45
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: Pushbullet node documentation
  description: Learn how to use the Pushbullet node in n8n. Follow technical documentation to integrate Pushbullet node into your workflows.
  contentType: [integration, reference]
  ---

  # Pushbullet node

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

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

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

  ## Operations

  * Push
      * Create a push
      * Delete a push
      * Get all pushes
      * Update a push

  ## Templates and examples

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

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

properties_schema:
  [{"displayName":"Resource","name":"resource","type":"options","noDataExpression":true,"options":[{"name":"Push","value":"push"}],"default":"push"},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["push"]}},"options":[{"name":"Create","value":"create","description":"Create a push","action":"Create a push"},{"name":"Delete","value":"delete","description":"Delete a push","action":"Delete a push"},{"name":"Get Many","value":"getAll","description":"Get many pushes","action":"Get many pushes"},{"name":"Update","value":"update","description":"Update a push","action":"Update a push"}],"default":"create"},{"displayName":"Type","name":"type","type":"options","options":[{"name":"File","value":"file"},{"name":"Link","value":"link"},{"name":"Note","value":"note"}],"required":true,"displayOptions":{"show":{"resource":["push"],"operation":["create"]}},"default":"note"},{"displayName":"Title","name":"title","type":"string","required":true,"displayOptions":{"show":{"resource":["push"],"operation":["create"],"type":["note","link"]}},"default":"","description":"Title of the push"},{"displayName":"Body","name":"body","type":"string","required":true,"displayOptions":{"show":{"resource":["push"],"operation":["create"],"type":["note","link","file"]}},"default":"","description":"Body of the push"},{"displayName":"URL","name":"url","type":"string","required":true,"displayOptions":{"show":{"resource":["push"],"operation":["create"],"type":["link"]}},"default":"","description":"URL of the push"},{"displayName":"Binary Property","name":"binaryPropertyName","type":"string","default":"data","required":true,"displayOptions":{"show":{"resource":["push"],"operation":["create"],"type":["file"]}},"placeholder":"","description":"Name of the binary property which contains the data for the file to be created"},{"displayName":"Target","name":"target","type":"options","options":[{"name":"Channel Tag","value":"channel_tag","description":"Send the push to all subscribers to your channel that has this tag"},{"name":"Default","value":"default","description":"Broadcast it to all of the user's devices"},{"name":"Device ID","value":"device_iden","description":"Send the push to a specific device"},{"name":"Email","value":"email","description":"Send the push to this email address"}],"required":true,"displayOptions":{"show":{"resource":["push"],"operation":["create"]}},"default":"default","description":"Define the medium that will be used to send the push"},{"displayName":"Value","name":"value","type":"string","required":true,"displayOptions":{"show":{"resource":["push"],"operation":["create"]},"hide":{"target":["default","device_iden"]}},"default":"","description":"The value to be set depending on the target selected. For example, if the target selected is email then this field would take the email address of the person you are trying to send the push to."},{"displayName":"Value Name or ID","name":"value","type":"options","typeOptions":{"loadOptionsMethod":"getDevices"},"required":true,"displayOptions":{"show":{"resource":["push"],"operation":["create"],"target":["device_iden"]}},"default":"","description":"Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>"},{"displayName":"Push ID","name":"pushId","type":"string","required":true,"displayOptions":{"show":{"resource":["push"],"operation":["delete"]}},"default":""},{"displayName":"Return All","name":"returnAll","type":"boolean","displayOptions":{"show":{"operation":["getAll"],"resource":["push"]}},"default":false,"description":"Whether to return all results or only up to a given limit"},{"displayName":"Limit","name":"limit","type":"number","displayOptions":{"show":{"operation":["getAll"],"resource":["push"],"returnAll":[false]}},"typeOptions":{"minValue":1,"maxValue":500},"default":100,"description":"Max number of results to return"},{"displayName":"Filters","name":"filters","type":"collection","placeholder":"Add Filter","default":{},"displayOptions":{"show":{"resource":["push"],"operation":["getAll"]}},"options":[{"displayName":"Active","name":"active","type":"boolean","default":false,"description":"Don't return deleted pushes"},{"displayName":"Modified After","name":"modified_after","type":"dateTime","default":"","description":"Request pushes modified after this timestamp"}]},{"displayName":"Push ID","name":"pushId","type":"string","required":true,"displayOptions":{"show":{"resource":["push"],"operation":["update"]}},"default":""},{"displayName":"Dismissed","name":"dismissed","type":"boolean","required":true,"displayOptions":{"show":{"resource":["push"],"operation":["update"]}},"default":false,"description":"Whether to mark a push as having been dismissed by the user, will cause any notifications for the push to be hidden if possible"}]

operations:
  [{"type":"resource","resource":"push","name":"Push"},{"type":"operation","operation":"create","name":"Create","action":"Create a push","resources":["push"]},{"type":"operation","operation":"delete","name":"Delete","action":"Delete a push","resources":["push"]},{"type":"operation","operation":"getAll","name":"Get Many","action":"Get many pushes","resources":["push"]},{"type":"operation","operation":"update","name":"Update","action":"Update a push","resources":["push"]}]


node_type: pushcut
package_name: n8n-nodes-base
display_name: Pushcut
description: Consume Pushcut API
category: input
development_style: programmatic
version: 1
credentials_required: [{"name":"pushcutApi","required":true}]
updated_at: 2025-06-12 12:00:45
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: Pushcut node documentation
  description: Learn how to use the Pushcut node in n8n. Follow technical documentation to integrate Pushcut node into your workflows.
  contentType: [integration, reference]
  ---

  # Pushcut node

  Use the Pushcut node to automate work in Pushcut, and integrate Pushcut with other applications. n8n supports sending notifications with Pushcut.

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

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

  ## Operations

  * Notification
      * Send a notification

  ## Templates and examples

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

properties_schema:
  [{"displayName":"Resource","name":"resource","type":"options","noDataExpression":true,"options":[{"name":"Notification","value":"notification"}],"default":"notification"},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["notification"]}},"options":[{"name":"Send","value":"send","description":"Send a notification","action":"Send a notification"}],"default":"send"},{"displayName":"Notification Name or ID","name":"notificationName","type":"options","description":"Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>","typeOptions":{"loadOptionsMethod":"getNotifications"},"displayOptions":{"show":{"resource":["notification"],"operation":["send"]}},"default":""},{"displayName":"Additional Fields","name":"additionalFields","type":"collection","placeholder":"Add Field","displayOptions":{"show":{"operation":["send"],"resource":["notification"]}},"default":{},"options":[{"displayName":"Device Names or IDs","name":"devices","type":"multiOptions","typeOptions":{"loadOptionsMethod":"getDevices"},"default":[],"description":"List of devices this notification is sent to. (default is all devices). Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Input","name":"input","type":"string","default":"","description":"Value that is passed as input to the notification action"},{"displayName":"Text","name":"text","type":"string","default":"","description":"Text that is used instead of the one defined in the app"},{"displayName":"Title","name":"title","type":"string","default":"","description":"Title that is used instead of the one defined in the app"}]}]

operations:
  [{"type":"resource","resource":"notification","name":"Notification"},{"type":"operation","operation":"send","name":"Send","action":"Send a notification","resources":["notification"]}]


node_type: pushcutTrigger
package_name: n8n-nodes-base
display_name: Pushcut Trigger
description: Starts the workflow when Pushcut events occur
category: trigger
development_style: programmatic
version: 1
operations: []
credentials_required: [{"name":"pushcutApi","required":true}]
updated_at: 2025-06-12 12:00:45
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: Pushcut Trigger node documentation
  description: Learn how to use the Pushcut Trigger node in n8n. Follow technical documentation to integrate Pushcut Trigger node into your workflows.
  contentType: [integration, reference]
  ---

  # Pushcut Trigger node

  [Pushcut](https://pushcut.io){:target=_blank .external-link} is an app for iOS that lets you create smart notifications to kick off shortcuts, URLs, and online automation.

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

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

  ## Configure a Pushcut action

  Follow these steps to configure your Pushcut Trigger node with your Pushcut app.

  1. In your Pushcut app, select a notification from the **Notifications** screen.
  2. Select the **Add Action** button.
  3. Enter an action name in the **Label** field.
  4. Select the **Server** tab.
  5. Select the **Integration** tab.
  6. Select **Integration Trigger**.
  7. In n8n, enter a name for the action and select **Execute step**.
  8. Select this action under the **Select Integration Trigger** screen in your Pushcut app.
  9. Select **Done** in the top right to save the action.

properties_schema:
  [{"displayName":"Action Name","name":"actionName","type":"string","description":"Choose any name you would like. It will show up as a server action in the app.","default":""}]


node_type: pushover
package_name: n8n-nodes-base
display_name: Pushover
description: Consume Pushover API
category: input
development_style: programmatic
version: 1
credentials_required: [{"name":"pushoverApi","required":true}]
updated_at: 2025-06-12 12:00:45
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: Pushover node documentation
  description: Learn how to use the Pushover node in n8n. Follow technical documentation to integrate Pushover node into your workflows.
  contentType: [integration, reference]
  ---

  # Pushover node

  Use the Pushover node to automate work in Pushover, and integrate Pushover with other applications. n8n supports sending push notifications with Pushover.

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

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

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

  ## Operations

  * Message
      * Push

  ## Templates and examples

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

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

properties_schema:
  [{"displayName":"Resource","name":"resource","type":"options","noDataExpression":true,"options":[{"name":"Message","value":"message"}],"default":"message"},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["message"]}},"options":[{"name":"Push","value":"push","action":"Push a message"}],"default":"push"},{"displayName":"User Key","name":"userKey","type":"string","required":true,"displayOptions":{"show":{"resource":["message"],"operation":["push"]}},"default":"","description":"The user/group key (not e-mail address) of your user (or you), viewable when logged into the <a href=\"https://pushover.net/\">dashboard</a> (often referred to as <code>USER_KEY</code> in the <a href=\"https://support.pushover.net/i44-example-code-and-pushover-libraries\">libraries</a> and code examples)"},{"displayName":"Message","name":"message","type":"string","required":true,"displayOptions":{"show":{"resource":["message"],"operation":["push"]}},"default":"","description":"Your message"},{"displayName":"Priority","name":"priority","type":"options","displayOptions":{"show":{"resource":["message"],"operation":["push"]}},"options":[{"name":"Lowest Priority","value":-2},{"name":"Low Priority","value":-1},{"name":"Normal Priority","value":0},{"name":"High Priority","value":1},{"name":"Emergency Priority","value":2}],"default":-2,"description":"Send as -2 to generate no notification/alert, -1 to always send as a quiet notification, 1 to display as high-priority and bypass the user's quiet hours, or 2 to also require confirmation from the user"},{"displayName":"Retry (Seconds)","name":"retry","type":"number","typeOptions":{"minValue":0},"required":true,"displayOptions":{"show":{"resource":["message"],"operation":["push"],"priority":[2]}},"default":30,"description":"Specifies how often (in seconds) the Pushover servers will send the same notification to the user. This parameter must have a value of at least 30 seconds between retries."},{"displayName":"Expire (Seconds)","name":"expire","type":"number","typeOptions":{"minValue":0,"maxValue":10800},"required":true,"displayOptions":{"show":{"resource":["message"],"operation":["push"],"priority":[2]}},"default":30,"description":"Specifies how many seconds your notification will continue to be retried for (every retry seconds)"},{"displayName":"Additional Fields","name":"additionalFields","type":"collection","placeholder":"Add Field","displayOptions":{"show":{"resource":["message"],"operation":["push"]}},"default":{},"options":[{"displayName":"Attachment","name":"attachmentsUi","placeholder":"Add Attachments","type":"fixedCollection","typeOptions":{"multipleValues":false},"options":[{"name":"attachmentsValues","displayName":"Attachment Property","values":[{"displayName":"Binary Property","name":"binaryPropertyName","type":"string","default":"","placeholder":"data","description":"Name of the binary properties which contain data which should be added to email as attachment"}]}],"default":{}},{"displayName":"Device","name":"device","type":"string","default":"","description":"Your user's device name to send the message directly to that device, rather than all of the user's devices (multiple devices may be separated by a comma)"},{"displayName":"HTML Formatting","name":"html","type":"boolean","default":false,"description":"Whether to enable messages formatting with HTML tags"},{"displayName":"Sound Name or ID","name":"sound","type":"options","typeOptions":{"loadOptionsMethod":"getSounds"},"default":"","description":"The name of one of the sounds supported by device clients to override the user's default sound choice. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Timestamp","name":"timestamp","type":"dateTime","default":"","description":"A Unix timestamp of your message's date and time to display to the user, rather than the time your message is received by our API"},{"displayName":"Title","name":"title","type":"string","default":"","description":"Your message's title, otherwise your app's name is used"},{"displayName":"Timestamp","name":"timestamp","type":"dateTime","default":"","description":"A Unix timestamp of your message's date and time to display to the user, rather than the time your message is received by our API"},{"displayName":"URL","name":"url","type":"string","default":"","description":"A supplementary URL to show with your message"},{"displayName":"URL Title","name":"url_title","type":"string","default":"","description":"A title for your supplementary URL, otherwise just the URL is shown"}]}]

operations:
  [{"type":"resource","resource":"message","name":"Message"},{"type":"operation","operation":"push","name":"Push","action":"Push a message","resources":["message"]}]


node_type: questDb
package_name: n8n-nodes-base
display_name: QuestDB
description: Get, add and update data in QuestDB
category: input
development_style: programmatic
version: 1
operations: []
credentials_required: [{"name":"questDb","required":true}]
updated_at: 2025-06-12 12:00:45
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: QuestDB node documentation
  description: Learn how to use the QuestDB node in n8n. Follow technical documentation to integrate QuestDB node into your workflows.
  contentType: [integration, reference]
  ---

  # QuestDB node

  Use the QuestDB node to automate work in QuestDB, and integrate QuestDB with other applications. n8n supports executing an SQL query and inserting rows in a database with QuestDB.

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

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

  ## Operations

  * Executes a SQL query.
  * Insert rows in database.

  ## Templates and examples

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

  ## Node reference

  ### Specify a column's data type

  To specify a column's data type, append the column name with `:type`, where `type` is the data type you want for column. For example, if you want to specify the type `int` for the column **id** and type `text` for the column **name**, you can use the following snippet in the **Columns** field: `id:int,name:text`.

properties_schema:
  [{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"options":[{"name":"Execute Query","value":"executeQuery","description":"Executes a SQL query","action":"Execute a SQL query"},{"name":"Insert","value":"insert","description":"Insert rows in database","action":"Insert rows in database"}],"default":"insert"},{"displayName":"Query","name":"query","type":"string","noDataExpression":true,"typeOptions":{"editor":"sqlEditor","rows":5,"sqlDialect":"PostgreSQL"},"displayOptions":{"show":{"operation":["executeQuery"]}},"default":"","placeholder":"SELECT id, name FROM product WHERE quantity > $1 AND price <= $2","required":true,"description":"The SQL query to execute. You can use n8n expressions or $1 and $2 in conjunction with query parameters."},{"displayName":"Schema","name":"schema","type":"hidden","displayOptions":{"show":{"operation":["insert"]}},"default":"","description":"Name of the schema the table belongs to"},{"displayName":"Table","name":"table","type":"string","displayOptions":{"show":{"operation":["insert"]}},"default":"","required":true,"description":"Name of the table in which to insert data to"},{"displayName":"Columns","name":"columns","type":"string","displayOptions":{"show":{"operation":["insert"]}},"default":"","placeholder":"id,name,description","description":"Comma-separated list of the properties which should used as columns for the new rows"},{"displayName":"Return Fields","name":"returnFields","type":"string","displayOptions":{"show":{"operation":["insert"]}},"default":"*","description":"Comma-separated list of the fields that the operation will return"},{"displayName":"Additional Fields","name":"additionalFields","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"operation":["executeQuery"]}},"options":[{"displayName":"Mode","name":"mode","type":"options","options":[{"name":"Independently","value":"independently","description":"Execute each query independently"},{"name":"Transaction","value":"transaction","description":"Executes all queries in a single transaction"}],"default":"independently","description":"The way queries should be sent to database. Can be used in conjunction with <b>Continue on Fail</b>. See <a href=\"https://docs.n8n.io/integrations/builtin/app-nodes/n8n-nodes-base.questdb/\">the docs</a> for more examples."},{"displayName":"Query Parameters","name":"queryParams","type":"string","displayOptions":{"show":{"/operation":["executeQuery"]}},"default":"","placeholder":"quantity,price","description":"Comma-separated list of properties which should be used as query parameters"}]},{"displayName":"Additional Fields","name":"additionalFields","type":"hidden","default":{},"displayOptions":{"show":{"operation":["insert"]}}}]


node_type: quickbase
package_name: n8n-nodes-base
display_name: Quick Base
description: Integrate with the Quick Base RESTful API
category: input
development_style: programmatic
version: 1
credentials_required: [{"name":"quickbaseApi","required":true}]
updated_at: 2025-06-12 12:00:45
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: Quick Base node documentation
  description: Learn how to use the Quick Base node in n8n. Follow technical documentation to integrate Quick Base node into your workflows.
  contentType: [integration, reference]
  ---

  # Quick Base node

  Use the Quick Base node to automate work in Quick Base, and integrate Quick Base with other applications. n8n has built-in support for a wide range of Quick Base features, including creating, updating, deleting, and getting records, as well as getting fields, and downloading files. 

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

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

  ## Operations

  * Field
      * Get all fields
  * File
      * Delete a file
      * Download a file
  * Record
      * Create a record
      * Delete a record
      * Get all records
      * Update a record
      * Upsert a record
  * Report
      * Get a report
      * Run a report

  ## Templates and examples

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

properties_schema:
  [{"displayName":"Resource","name":"resource","type":"options","noDataExpression":true,"options":[{"name":"Field","value":"field"},{"name":"File","value":"file"},{"name":"Record","value":"record"},{"name":"Report","value":"report"}],"default":"record"},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["field"]}},"options":[{"name":"Get Many","value":"getAll","description":"Get many fields","action":"Get many fields"}],"default":"getAll"},{"displayName":"Table ID","name":"tableId","type":"string","default":"","required":true,"displayOptions":{"show":{"resource":["field"],"operation":["getAll"]}},"description":"The table identifier"},{"displayName":"Return All","name":"returnAll","type":"boolean","displayOptions":{"show":{"resource":["field"],"operation":["getAll"]}},"default":false,"description":"Whether to return all results or only up to a given limit"},{"displayName":"Limit","name":"limit","type":"number","displayOptions":{"show":{"resource":["field"],"operation":["getAll"],"returnAll":[false]}},"typeOptions":{"minValue":1,"maxValue":100},"default":50,"description":"Max number of results to return"},{"displayName":"Options","name":"options","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"resource":["field"],"operation":["getAll"]}},"options":[{"displayName":"Include Field Perms","name":"includeFieldPerms","type":"boolean","default":false,"description":"Whether to get back the custom permissions for the field(s)"}]},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["file"]}},"options":[{"name":"Delete","value":"delete","description":"Delete a file","action":"Delete a file"},{"name":"Download","value":"download","description":"Download a file","action":"Download a file"}],"default":"download"},{"displayName":"Table ID","name":"tableId","type":"string","default":"","required":true,"displayOptions":{"show":{"resource":["file"],"operation":["download","delete"]}},"description":"The table identifier"},{"displayName":"Record ID","name":"recordId","type":"string","default":"","required":true,"displayOptions":{"show":{"resource":["file"],"operation":["download","delete"]}},"description":"The unique identifier of the record"},{"displayName":"Field ID","name":"fieldId","type":"string","default":"","required":true,"displayOptions":{"show":{"resource":["file"],"operation":["download","delete"]}},"description":"The unique identifier of the field"},{"displayName":"Version Number","name":"versionNumber","type":"number","default":1,"required":true,"displayOptions":{"show":{"resource":["file"],"operation":["download","delete"]}},"description":"The file attachment version number"},{"displayName":"Binary Property","displayOptions":{"show":{"resource":["file"],"operation":["download"]}},"name":"binaryPropertyName","type":"string","default":"data","description":"Object property name which holds binary data","required":true},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["record"]}},"options":[{"name":"Create","value":"create","description":"Create a record","action":"Create a record"},{"name":"Create or Update","value":"upsert","description":"Create a new record, or update the current one if it already exists (upsert)","action":"Create or update a record"},{"name":"Delete","value":"delete","description":"Delete a record","action":"Delete a record"},{"name":"Get Many","value":"getAll","description":"Get many records","action":"Get many records"},{"name":"Update","value":"update","description":"Update a record","action":"Update a record"}],"default":"create"},{"displayName":"Table ID","name":"tableId","type":"string","default":"","required":true,"displayOptions":{"show":{"resource":["record"],"operation":["create"]}},"description":"The table identifier"},{"displayName":"Columns","name":"columns","type":"string","displayOptions":{"show":{"resource":["record"],"operation":["create"]}},"default":"","required":true,"placeholder":"Select Fields...","description":"Comma-separated list of the properties which should used as columns for the new rows"},{"displayName":"Simplify","name":"simple","type":"boolean","displayOptions":{"show":{"resource":["record"],"operation":["create"]}},"default":true,"description":"Whether to return a simplified version of the response instead of the raw data"},{"displayName":"Options","name":"options","type":"collection","placeholder":"Add Option","default":{},"displayOptions":{"show":{"resource":["record"],"operation":["create"]}},"options":[{"displayName":"Return Field Names or IDs","name":"fields","type":"multiOptions","typeOptions":{"loadOptionsMethod":"getTableFields","loadOptionsDependsOn":["tableId"]},"default":[],"description":"Specify an array of field IDs that will return data for any updates or added record. Record ID (FID 3) is always returned if any field ID is requested. Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Use Field IDs","name":"useFieldIDs","type":"boolean","default":false,"description":"Whether to use Field IDs instead of Field Names in Columns"}]},{"displayName":"Table ID","name":"tableId","type":"string","default":"","required":true,"displayOptions":{"show":{"resource":["record"],"operation":["delete"]}},"description":"The table identifier"},{"displayName":"Where","name":"where","type":"string","default":"","required":true,"displayOptions":{"show":{"resource":["record"],"operation":["delete"]}},"description":"The filter to delete records. To delete all records specify a filter that will include all records, for example {3.GT.0} where 3 is the ID of the Record ID field."},{"displayName":"Table ID","name":"tableId","type":"string","default":"","required":true,"displayOptions":{"show":{"resource":["record"],"operation":["getAll"]}},"description":"The table identifier"},{"displayName":"Return All","name":"returnAll","type":"boolean","displayOptions":{"show":{"resource":["record"],"operation":["getAll"]}},"default":false,"description":"Whether to return all results or only up to a given limit"},{"displayName":"Limit","name":"limit","type":"number","displayOptions":{"show":{"resource":["record"],"operation":["getAll"],"returnAll":[false]}},"typeOptions":{"minValue":1,"maxValue":100},"default":50,"description":"Max number of results to return"},{"displayName":"Options","name":"options","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"resource":["record"],"operation":["getAll"]}},"options":[{"displayName":"Select","name":"select","type":"multiOptions","typeOptions":{"loadOptionsMethod":"getTableFields"},"default":[],"description":"An array of field IDs for the fields that should be returned in the response. If empty, the default columns on the table will be returned. Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Sort By","name":"sortByUi","placeholder":"Add Sort By","type":"fixedCollection","typeOptions":{"multipleValues":true},"default":{},"options":[{"name":"sortByValues","displayName":"Sort By","values":[{"displayName":"Field Name or ID","name":"fieldId","type":"options","typeOptions":{"loadOptionsMethod":"getTableFields"},"default":"","description":"The unique identifier of a field in a table. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Order","name":"order","type":"options","options":[{"name":"ASC","value":"ASC"},{"name":"DESC","value":"DESC"}],"default":"ASC"}]}],"description":"By default, queries will be sorted by the given sort fields or the default sort if the query does not provide any. Set to false to avoid sorting when the order of the data returned is not important. Returning data without sorting can improve performance."},{"displayName":"Where","name":"where","type":"string","default":"","description":"The filter, using the <a href=\"https://help.quickbase.com/api-guide/componentsquery.html\">Quick Base query language</a>, which determines the records to return"}]},{"displayName":"Table ID","name":"tableId","type":"string","default":"","required":true,"displayOptions":{"show":{"resource":["record"],"operation":["update"]}},"description":"The table identifier"},{"displayName":"Columns","name":"columns","type":"string","displayOptions":{"show":{"resource":["record"],"operation":["update"]}},"default":"","required":true,"placeholder":"id,name,description","description":"Comma-separated list of the properties which should used as columns for the new rows"},{"displayName":"Update Key","name":"updateKey","type":"string","displayOptions":{"show":{"resource":["record"],"operation":["update"]}},"default":"","description":"Update can use the key field on the table, or any other supported unique field"},{"displayName":"Simplify","name":"simple","type":"boolean","displayOptions":{"show":{"resource":["record"],"operation":["update"]}},"default":true,"description":"Whether to return a simplified version of the response instead of the raw data"},{"displayName":"Options","name":"options","type":"collection","placeholder":"Add Option","default":{},"displayOptions":{"show":{"resource":["record"],"operation":["update"]}},"options":[{"displayName":"Field Names or IDs","name":"fields","type":"multiOptions","typeOptions":{"loadOptionsMethod":"getTableFields","loadOptionsDependsOn":["tableId"]},"default":[],"description":"Specify an array of field IDs that will return data for any updates or added record. Record ID (FID 3) is always returned if any field ID is requested. Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Use Field IDs","name":"useFieldIDs","type":"boolean","default":false,"description":"Whether to use Field IDs instead of Field Names in Columns"}]},{"displayName":"Table ID","name":"tableId","type":"string","default":"","required":true,"displayOptions":{"show":{"resource":["record"],"operation":["upsert"]}},"description":"The table identifier"},{"displayName":"Columns","name":"columns","type":"string","displayOptions":{"show":{"resource":["record"],"operation":["upsert"]}},"default":"","required":true,"placeholder":"id,name,description","description":"Comma-separated list of the properties which should used as columns for the new rows"},{"displayName":"Update Key","name":"updateKey","type":"string","displayOptions":{"show":{"resource":["record"],"operation":["upsert"]}},"default":"","description":"Update can use the key field on the table, or any other supported unique field"},{"displayName":"Merge Field Name or ID","name":"mergeFieldId","type":"options","typeOptions":{"loadOptionsMethod":"getUniqueTableFields"},"displayOptions":{"show":{"resource":["record"],"operation":["upsert"]}},"default":"","description":"<p>You're updating records in a Quick Base table with data from an external file. In order for a merge like this to work, Quick Base needs a way to match records in the source data with corresponding records in the destination table.</p><p>You make this possible by choosing the field in the app table that holds unique matching values. This is called a merge field.</p>. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Simplify","name":"simple","type":"boolean","displayOptions":{"show":{"resource":["record"],"operation":["upsert"]}},"default":true,"description":"Whether to return a simplified version of the response instead of the raw data"},{"displayName":"Options","name":"options","type":"collection","placeholder":"Add Option","default":{},"displayOptions":{"show":{"resource":["record"],"operation":["upsert"]}},"options":[{"displayName":"Field Names or IDs","name":"fields","type":"multiOptions","typeOptions":{"loadOptionsMethod":"getTableFields","loadOptionsDependsOn":["tableId"]},"default":[],"description":"Specify an array of field IDs that will return data for any updates or added record. Record ID (FID 3) is always returned if any field ID is requested. Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Use Field IDs","name":"useFieldIDs","type":"boolean","default":false,"description":"Whether to use Field IDs instead of Field Names in Columns"}]},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["report"]}},"options":[{"name":"Get","value":"get","description":"Get a report","action":"Get a report"},{"name":"Run","value":"run","description":"Run a report","action":"Run a report"}],"default":"get"},{"displayName":"Table ID","name":"tableId","type":"string","default":"","required":true,"displayOptions":{"show":{"resource":["report"],"operation":["get"]}},"description":"The table identifier"},{"displayName":"Report ID","name":"reportId","type":"string","default":"","required":true,"displayOptions":{"show":{"resource":["report"],"operation":["get"]}},"description":"The identifier of the report, unique to the table"},{"displayName":"Table ID","name":"tableId","type":"string","default":"","required":true,"displayOptions":{"show":{"resource":["report"],"operation":["run"]}},"description":"The table identifier"},{"displayName":"Report ID","name":"reportId","type":"string","default":"","required":true,"displayOptions":{"show":{"resource":["report"],"operation":["run"]}},"description":"The identifier of the report, unique to the table"},{"displayName":"Return All","name":"returnAll","type":"boolean","displayOptions":{"show":{"resource":["report"],"operation":["run"]}},"default":true,"description":"Whether to return all results or only up to a given limit"},{"displayName":"Limit","name":"limit","type":"number","displayOptions":{"show":{"resource":["report"],"operation":["run"]},"hide":{"returnAll":[true]}},"typeOptions":{"minValue":1,"maxValue":100},"default":100,"description":"Max number of results to return"}]

operations:
  [{"type":"resource","resource":"field","name":"Field"},{"type":"resource","resource":"file","name":"File"},{"type":"resource","resource":"record","name":"Record"},{"type":"resource","resource":"report","name":"Report"},{"type":"operation","operation":"getAll","name":"Get Many","action":"Get many fields","resources":["field"]},{"type":"operation","operation":"delete","name":"Delete","action":"Delete a file","resources":["file"]},{"type":"operation","operation":"download","name":"Download","action":"Download a file","resources":["file"]},{"type":"operation","operation":"create","name":"Create","action":"Create a record","resources":["record"]},{"type":"operation","operation":"upsert","name":"Create or Update","action":"Create or update a record","resources":["record"]},{"type":"operation","operation":"delete","name":"Delete","action":"Delete a record","resources":["record"]},{"type":"operation","operation":"getAll","name":"Get Many","action":"Get many records","resources":["record"]},{"type":"operation","operation":"update","name":"Update","action":"Update a record","resources":["record"]},{"type":"operation","operation":"get","name":"Get","action":"Get a report","resources":["report"]},{"type":"operation","operation":"run","name":"Run","action":"Run a report","resources":["report"]}]


node_type: quickbooks
package_name: n8n-nodes-base
display_name: QuickBooks Online
description: Consume the QuickBooks Online API
category: transform
development_style: programmatic
version: 1
credentials_required: [{"name":"quickBooksOAuth2Api","required":true}]
updated_at: 2025-06-12 12:00:45
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: QuickBooks Online node documentation
  description: Learn how to use the QuickBooks Online node in n8n. Follow technical documentation to integrate QuickBooks Online node into your workflows.
  contentType: [integration, reference]
  ---

  # QuickBooks Online node

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

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

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

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

  ## Operations

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

  ## Templates and examples

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

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

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

operations:
  [{"type":"resource","resource":"bill","name":"Bill"},{"type":"resource","resource":"customer","name":"Customer"},{"type":"resource","resource":"employee","name":"Employee"},{"type":"resource","resource":"estimate","name":"Estimate"},{"type":"resource","resource":"invoice","name":"Invoice"},{"type":"resource","resource":"item","name":"Item"},{"type":"resource","resource":"payment","name":"Payment"},{"type":"resource","resource":"purchase","name":"Purchase"},{"type":"resource","resource":"transaction","name":"Transaction"},{"type":"resource","resource":"vendor","name":"Vendor"},{"type":"operation","operation":"create","name":"Create","action":"Create a bill","resources":["bill"]},{"type":"operation","operation":"delete","name":"Delete","action":"Delete a bill","resources":["bill"]},{"type":"operation","operation":"get","name":"Get","action":"Get a bill","resources":["bill"]},{"type":"operation","operation":"getAll","name":"Get Many","action":"Get many bills","resources":["bill"]},{"type":"operation","operation":"update","name":"Update","action":"Update a bill","resources":["bill"]},{"type":"operation","operation":"create","name":"Create","action":"Create a customer","resources":["customer"]},{"type":"operation","operation":"get","name":"Get","action":"Get a customer","resources":["customer"]},{"type":"operation","operation":"getAll","name":"Get Many","action":"Get many customers","resources":["customer"]},{"type":"operation","operation":"update","name":"Update","action":"Update a customer","resources":["customer"]},{"type":"operation","operation":"create","name":"Create","action":"Create an employee","resources":["employee"]},{"type":"operation","operation":"get","name":"Get","action":"Get an employee","resources":["employee"]},{"type":"operation","operation":"getAll","name":"Get Many","action":"Get many employees","resources":["employee"]},{"type":"operation","operation":"update","name":"Update","action":"Update an employee","resources":["employee"]},{"type":"operation","operation":"create","name":"Create","action":"Create an estimate","resources":["estimate"]},{"type":"operation","operation":"delete","name":"Delete","action":"Delete an estimate","resources":["estimate"]},{"type":"operation","operation":"get","name":"Get","action":"Get an estimate","resources":["estimate"]},{"type":"operation","operation":"getAll","name":"Get Many","action":"Get many estimates","resources":["estimate"]},{"type":"operation","operation":"send","name":"Send","action":"Send an estimate","resources":["estimate"]},{"type":"operation","operation":"update","name":"Update","action":"Update an estimate","resources":["estimate"]},{"type":"operation","operation":"create","name":"Create","action":"Create an invoice","resources":["invoice"]},{"type":"operation","operation":"delete","name":"Delete","action":"Delete an invoice","resources":["invoice"]},{"type":"operation","operation":"get","name":"Get","action":"Get an invoice","resources":["invoice"]},{"type":"operation","operation":"getAll","name":"Get Many","action":"Get many invoices","resources":["invoice"]},{"type":"operation","operation":"send","name":"Send","action":"Send an invoice","resources":["invoice"]},{"type":"operation","operation":"update","name":"Update","action":"Update an invoice","resources":["invoice"]},{"type":"operation","operation":"void","name":"Void","action":"Void an invoice","resources":["invoice"]},{"type":"operation","operation":"get","name":"Get","action":"Get an item","resources":["item"]},{"type":"operation","operation":"getAll","name":"Get Many","action":"Get many items","resources":["item"]},{"type":"operation","operation":"create","name":"Create","action":"Create a payment","resources":["payment"]},{"type":"operation","operation":"delete","name":"Delete","action":"Delete a payment","resources":["payment"]},{"type":"operation","operation":"get","name":"Get","action":"Get a payment","resources":["payment"]},{"type":"operation","operation":"getAll","name":"Get Many","action":"Get many payments","resources":["payment"]},{"type":"operation","operation":"send","name":"Send","action":"Send a payment","resources":["payment"]},{"type":"operation","operation":"update","name":"Update","action":"Update a payment","resources":["payment"]},{"type":"operation","operation":"void","name":"Void","action":"Void a payment","resources":["payment"]},{"type":"operation","operation":"get","name":"Get","action":"Get a purchase","resources":["purchase"]},{"type":"operation","operation":"getAll","name":"Get Many","action":"Get many purchases","resources":["purchase"]},{"type":"operation","operation":"getReport","name":"Get Report","action":"Get a report","resources":["transaction"]},{"type":"operation","operation":"create","name":"Create","action":"Create a vendor","resources":["vendor"]},{"type":"operation","operation":"get","name":"Get","action":"Get a vendor","resources":["vendor"]},{"type":"operation","operation":"getAll","name":"Get Many","action":"Get many vendors","resources":["vendor"]},{"type":"operation","operation":"update","name":"Update","action":"Update a vendor","resources":["vendor"]}]


node_type: quickChart
package_name: n8n-nodes-base
display_name: QuickChart
description: Create a chart via QuickChart
category: output
development_style: programmatic
version: 1
operations: []
credentials_required: []
updated_at: 2025-06-12 12:00:45
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: QuickChart node documentation
  description: Learn how to use the QuickChart node in n8n. Follow technical documentation to integrate QuickChart node into your workflows.
  contentType: [integration, reference]
  priority: medium
  ---

  # QuickChart node

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

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

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

  ## Operations

  Create a chart by selecting the chart type:

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

  ## Templates and examples

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

  ## Related resources

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

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


node_type: rabbitmq
package_name: n8n-nodes-base
display_name: RabbitMQ
description: Sends messages to a RabbitMQ topic
category: transform
development_style: programmatic
version: 1
credentials_required: [{"name":"rabbitmq","required":true,"testedBy":"rabbitmqConnectionTest"}]
updated_at: 2025-06-12 12:00:45
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: RabbitMQ node documentation
  description: Learn how to use the RabbitMQ node in n8n. Follow technical documentation to integrate RabbitMQ node into your workflows.
  contentType: [integration, reference]
  priority: medium
  ---

  # RabbitMQ node

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

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

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

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

  ## Operations

  * Delete From Queue
  * Send a Message to RabbitMQ

  ## Templates and examples

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

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

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


node_type: rabbitmqTrigger
package_name: n8n-nodes-base
display_name: RabbitMQ Trigger
description: Listens to RabbitMQ messages
category: trigger
development_style: programmatic
version: 1
operations: []
credentials_required: [{"name":"rabbitmq","required":true}]
updated_at: 2025-06-12 12:00:45
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: RabbitMQ Trigger node documentation
  description: Learn how to use the RabbitMQ Trigger node in n8n. Follow technical documentation to integrate RabbitMQ Trigger node into your workflows.
  contentType: [integration, reference]
  priority: medium
  ---

  # RabbitMQ Trigger node

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

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

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

  ## Related resources

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

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

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


node_type: raindrop
package_name: n8n-nodes-base
display_name: Raindrop
description: Consume the Raindrop API
category: transform
development_style: programmatic
version: 1
credentials_required: [{"name":"raindropOAuth2Api","required":true}]
updated_at: 2025-06-12 12:00:45
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: Raindrop node documentation
  description: Learn how to use the Raindrop node in n8n. Follow technical documentation to integrate Raindrop node into your workflows.
  contentType: [integration, reference]
  ---

  # Raindrop node

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

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

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

  ## Operations

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

  ## Templates and examples

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

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

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

operations:
  [{"type":"resource","resource":"bookmark","name":"Bookmark"},{"type":"resource","resource":"collection","name":"Collection"},{"type":"resource","resource":"tag","name":"Tag"},{"type":"resource","resource":"user","name":"User"},{"type":"operation","operation":"create","name":"Create","action":"Create a bookmark","resources":["bookmark"]},{"type":"operation","operation":"delete","name":"Delete","action":"Delete a bookmark","resources":["bookmark"]},{"type":"operation","operation":"get","name":"Get","action":"Get a bookmark","resources":["bookmark"]},{"type":"operation","operation":"getAll","name":"Get Many","action":"Get many bookmarks","resources":["bookmark"]},{"type":"operation","operation":"update","name":"Update","action":"Update a bookmark","resources":["bookmark"]},{"type":"operation","operation":"create","name":"Create","action":"Create a collection","resources":["collection"]},{"type":"operation","operation":"delete","name":"Delete","action":"Delete a collection","resources":["collection"]},{"type":"operation","operation":"get","name":"Get","action":"Get a collection","resources":["collection"]},{"type":"operation","operation":"getAll","name":"Get Many","action":"Get many collections","resources":["collection"]},{"type":"operation","operation":"update","name":"Update","action":"Update a collection","resources":["collection"]},{"type":"operation","operation":"delete","name":"Delete","action":"Delete a tag","resources":["tag"]},{"type":"operation","operation":"getAll","name":"Get Many","action":"Get many tags","resources":["tag"]},{"type":"operation","operation":"get","name":"Get","action":"Get a user","resources":["user"]}]


node_type: readBinaryFile
package_name: n8n-nodes-base
display_name: Read Binary File
description: Reads a binary file from disk
category: input
development_style: programmatic
version: 1
operations: []
credentials_required: []
updated_at: 2025-06-12 12:00:45
properties_schema:
  [{"displayName":"File Path","name":"filePath","type":"string","default":"","required":true,"placeholder":"/data/example.jpg","description":"Path of the file to read"},{"displayName":"Property Name","name":"dataPropertyName","type":"string","default":"data","required":true,"description":"Name of the binary property to which to write the data of the read file"}]


node_type: readBinaryFiles
package_name: n8n-nodes-base
display_name: Read Binary Files
description: Reads binary files from disk
category: input
development_style: programmatic
version: 1
operations: []
credentials_required: []
updated_at: 2025-06-12 12:00:45
properties_schema:
  [{"displayName":"File Selector","name":"fileSelector","type":"string","default":"","required":true,"placeholder":"*.jpg","description":"Pattern for files to read"},{"displayName":"Property Name","name":"dataPropertyName","type":"string","default":"data","required":true,"description":"Name of the binary property to which to write the data of the read files"}]


node_type: readPDF
package_name: n8n-nodes-base
display_name: Read PDF
description: Reads a PDF and extracts its content
category: input
development_style: programmatic
version: 1
operations: []
credentials_required: []
updated_at: 2025-06-12 12:00:45
properties_schema:
  [{"displayName":"Binary Property","name":"binaryPropertyName","type":"string","default":"data","required":true,"description":"Name of the binary property from which to read the PDF file"},{"displayName":"Encrypted","name":"encrypted","type":"boolean","default":false,"required":true},{"displayName":"Password","name":"password","type":"string","typeOptions":{"password":true},"default":"","description":"Password to decrypt the PDF file with","displayOptions":{"show":{"encrypted":[true]}}}]


node_type: reddit
package_name: n8n-nodes-base
display_name: Reddit
description: Consume the Reddit API
category: transform
development_style: programmatic
version: 1
updated_at: 2025-06-12 12:00:45
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: Reddit node documentation
  description: Learn how to use the Reddit node in n8n. Follow technical documentation to integrate Reddit node into your workflows.
  contentType: [integration, reference]
  ---

  # Reddit node

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

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

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

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

  ## Operations

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

  ## Templates and examples

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

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

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

operations:
  [{"type":"resource","resource":"post","name":"Post"},{"type":"resource","resource":"postComment","name":"Post Comment"},{"type":"resource","resource":"profile","name":"Profile"},{"type":"resource","resource":"subreddit","name":"Subreddit"},{"type":"resource","resource":"user","name":"User"},{"type":"operation","operation":"create","name":"Create","action":"Create a comment in a post","resources":["postComment"]},{"type":"operation","operation":"getAll","name":"Get Many","action":"Get many comments in a post","resources":["postComment"]},{"type":"operation","operation":"delete","name":"Delete","action":"Delete a comment from a post","resources":["postComment"]},{"type":"operation","operation":"reply","name":"Reply","action":"Reply to a comment in a post","resources":["postComment"]},{"type":"operation","operation":"get","name":"Get","action":"Get a profile","resources":["profile"]},{"type":"operation","operation":"get","name":"Get","action":"Get a subreddit","resources":["subreddit"]},{"type":"operation","operation":"getAll","name":"Get Many","action":"Get many subreddits","resources":["subreddit"]},{"type":"operation","operation":"create","name":"Create","action":"Create a post","resources":["post"]},{"type":"operation","operation":"delete","name":"Delete","action":"Delete a post","resources":["post"]},{"type":"operation","operation":"get","name":"Get","action":"Get a post","resources":["post"]},{"type":"operation","operation":"getAll","name":"Get Many","action":"Get many posts","resources":["post"]},{"type":"operation","operation":"search","name":"Search","action":"Search for a post","resources":["post"]},{"type":"operation","operation":"get","name":"Get","action":"Get a user","resources":["user"]}]

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


node_type: redis
package_name: n8n-nodes-base
display_name: Redis
description: Get, send and update data in Redis
category: input
development_style: programmatic
version: 1
operations: []
credentials_required: [{"name":"redis","required":true,"testedBy":"redisConnectionTest"}]
updated_at: 2025-06-12 12:00:45
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: Redis node documentation
  description: Learn how to use the Redis node in n8n. Follow technical documentation to integrate Redis node into your workflows.
  contentType: [integration, reference]
  priority: medium
  ---

  # Redis node

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

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

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

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

  ## Operations

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

  ## Templates and examples

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

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


node_type: redisTrigger
package_name: n8n-nodes-base
display_name: Redis Trigger
description: Subscribe to redis channel
category: trigger
development_style: programmatic
version: 1
operations: []
credentials_required: [{"name":"redis","required":true}]
updated_at: 2025-06-12 12:00:45
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: Redis Trigger node documentation
  description: Learn how to use the Redis Trigger node in n8n. Follow technical documentation to integrate Redis Trigger node into your workflows.
  contentType: [integration, reference]
  ---

  # Redis Trigger node

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

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

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

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

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


node_type: renameKeys
package_name: n8n-nodes-base
display_name: Rename Keys
description: Renames keys
category: transform
development_style: programmatic
version: 1
operations: []
credentials_required: []
updated_at: 2025-06-12 12:00:45
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: Rename Keys
  description: Documentation for the Rename Keys node in n8n, a workflow automation platform. Includes guidance on usage, and links to examples.
  contentType: [integration, reference]
  priority: medium
  ---

  # Rename Keys

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

  ## Node parameters

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

  For each key, enter the:

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

  ## Node options

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

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

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

  ## Templates and examples

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

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


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

  # Respond to Webhook

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

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

  ## How to use Respond to Webhook

  To use the Respond to Webhook node:

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

  ## Node parameters

  Configure the node behavior using these parameters.

  ### Respond With

  Choose what data to send in the webhook response.

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

  ## Node options

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

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

  ## Templates and examples

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

  ## Workflow behavior

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

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

  ## Output the response sent to the webhook

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

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

  The node will now have two outputs:

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

  ## Return more than one data item (deprecated)

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

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

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

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

properties_schema:
  [{"displayName":"Respond With","name":"respondWith","type":"options","options":[{"name":"Binary","value":"binary"},{"name":"First Incoming Item","value":"firstIncomingItem"},{"name":"JSON","value":"json"},{"name":"No Data","value":"noData"},{"name":"Text","value":"text"}],"default":"firstIncomingItem","description":"The data that should be returned"},{"displayName":"When using expressions, note that this node will only run for the first item in the input data.","name":"webhookNotice","type":"notice","displayOptions":{"show":{"respondWith":["json","text"]}},"default":""},{"displayName":"Response Body","name":"responseBody","type":"json","displayOptions":{"show":{"respondWith":["json"]}},"default":"","placeholder":"{ \"key\": \"value\" }","description":"The HTTP Response JSON data"},{"displayName":"Response Body","name":"responseBody","type":"string","displayOptions":{"show":{"respondWith":["text"]}},"default":"","placeholder":"e.g. Workflow started","description":"The HTTP Response text data"},{"displayName":"Response Data Source","name":"responseDataSource","type":"options","displayOptions":{"show":{"respondWith":["binary"]}},"options":[{"name":"Choose Automatically From Input","value":"automatically","description":"Use if input data will contain a single piece of binary data"},{"name":"Specify Myself","value":"set","description":"Enter the name of the input field the binary data will be in"}],"default":"automatically"},{"displayName":"Input Field Name","name":"inputFieldName","type":"string","required":true,"default":"data","displayOptions":{"show":{"respondWith":["binary"],"responseDataSource":["set"]}},"description":"The name of the node input field with the binary data"},{"displayName":"Options","name":"options","type":"collection","placeholder":"Add Option","default":{},"options":[{"displayName":"Response Code","name":"responseCode","type":"number","typeOptions":{"minValue":100,"maxValue":599},"default":200,"description":"The HTTP Response code to return. Defaults to 200."},{"displayName":"Response Headers","name":"responseHeaders","placeholder":"Add Response Header","description":"Add headers to the webhook response","type":"fixedCollection","typeOptions":{"multipleValues":true},"default":{},"options":[{"name":"entries","displayName":"Entries","values":[{"displayName":"Name","name":"name","type":"string","default":"","description":"Name of the header"},{"displayName":"Value","name":"value","type":"string","default":"","description":"Value of the header"}]}]}]}]


node_type: rocketchat
package_name: n8n-nodes-base
display_name: RocketChat
description: Consume RocketChat API
category: output
development_style: programmatic
version: 1
credentials_required: [{"name":"rocketchatApi","required":true}]
updated_at: 2025-06-12 12:00:45
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: Rocket.Chat node documentation
  description: Learn how to use the Rocket.Chat node in n8n. Follow technical documentation to integrate Rocket.Chat node into your workflows.
  contentType: [integration, reference]
  ---

  # Rocket.Chat node

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

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

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

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

  ## Operations

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

  ## Templates and examples

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

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

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

operations:
  [{"type":"resource","resource":"chat","name":"Chat"},{"type":"operation","operation":"postMessage","name":"Post Message","action":"Post a message","resources":["chat"]}]


node_type: rssFeedRead
package_name: n8n-nodes-base
display_name: RSS Read
description: Reads data from an RSS Feed
category: input
development_style: programmatic
version: 1
operations: []
credentials_required: []
updated_at: 2025-06-12 12:00:45
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: RSS Read
  description: Documentation for the RSS Read node in n8n, a workflow automation platform. Includes guidance on usage, and links to examples.
  contentType: [integration, reference]
  priority: medium
  ---

  # RSS Read

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

  ## Node parameters

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

  ## Node options

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

  ## Templates and examples

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

  ## Related resources

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

properties_schema:
  [{"displayName":"URL","name":"url","type":"string","default":"","required":true,"description":"URL of the RSS feed"},{"displayName":"Options","name":"options","type":"collection","placeholder":"Add Option","default":{},"options":[{"displayName":"Ignore SSL Issues","name":"ignoreSSL","type":"boolean","default":false,"description":"Whether to ignore SSL/TLS certificate issues or not"}]}]


node_type: rssFeedReadTrigger
package_name: n8n-nodes-base
display_name: RSS Feed Trigger
description: Starts a workflow when an RSS feed is updated
category: trigger
development_style: programmatic
version: 1
operations: []
credentials_required: []
updated_at: 2025-06-12 12:00:45
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: RSS Feed Trigger node documentation
  description: Learn how to use the RSS Feed Trigger node in n8n. Follow technical documentation to integrate RSS Feed Trigger node into your workflows.
  contentType: [integration, reference]
  priority: medium
  ---

  # RSS Feed Trigger node

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

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

  ## Node parameters

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

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

  ## Templates and examples

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

  ## Related resources

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

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


node_type: rundeck
package_name: n8n-nodes-base
display_name: Rundeck
description: Manage Rundeck API
category: transform
development_style: programmatic
version: 1
operations: [{"type":"resource","resource":"job","name":"Job"}]
credentials_required: [{"name":"rundeckApi","required":true}]
updated_at: 2025-06-12 12:00:45
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: Rundeck node documentation
  description: Learn how to use the Rundeck node in n8n. Follow technical documentation to integrate Rundeck node into your workflows.
  contentType: [integration, reference]
  ---

  # Rundeck node

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

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

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

  ## Operations

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

  ## Templates and examples

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

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

  ## Find the job ID

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

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


node_type: s3
package_name: n8n-nodes-base
display_name: S3
description: Sends data to any S3-compatible service
category: output
development_style: programmatic
version: 1
credentials_required: [{"name":"s3","required":true}]
updated_at: 2025-06-12 12:00:45
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: S3 node documentation
  description: Learn how to use the S3 node in n8n. Follow technical documentation to integrate S3 node into your workflows.
  contentType: [integration, reference]
  priority: medium
  ---

  # S3 node

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

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

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

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

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

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

  ## Operations

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

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

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

  ## Templates and examples

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

  ## Node reference

  ### Setting file permissions in Wasabi

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

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

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

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


node_type: salesforce
package_name: n8n-nodes-base
display_name: Salesforce
description: Consume Salesforce API
category: output
development_style: programmatic
version: 1
updated_at: 2025-06-12 12:00:45
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: Salesforce node documentation
  description: Learn how to use the Salesforce node in n8n. Follow technical documentation to integrate Salesforce node into your workflows.
  contentType: [integration, reference]
  priority: medium
  ---

  # Salesforce node

  Use the Salesforce node to automate work in Salesforce, and integrate Salesforce with other applications. n8n has built-in support for a wide range of Salesforce features, including creating, updating, deleting, and getting accounts, attachments, cases, and leads, as well as uploading documents. 

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

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

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

  ## Operations

  * Account
      * Add note to an account
      * Create an account
      * Create a new account, or update the current one if it already exists (upsert)
      * Get an account
      * Get all accounts
      * Returns an overview of account's metadata.
      * Delete an account
      * Update an account
  * Attachment
      * Create a attachment
      * Delete a attachment
      * Get a attachment
      * Get all attachments
      * Returns an overview of attachment's metadata.
      * Update a attachment
  * Case
      * Add a comment to a case
      * Create a case
      * Get a case
      * Get all cases
      * Returns an overview of case's metadata
      * Delete a case
      * Update a case
  * Contact
      * Add lead to a campaign
      * Add note to a contact
      * Create a contact
      * Create a new contact, or update the current one if it already exists (upsert)
      * Delete a contact
      * Get a contact
      * Returns an overview of contact's metadata
      * Get all contacts
      * Update a contact
  * Custom Object
      * Create a custom object record
      * Create a new record, or update the current one if it already exists (upsert)
      * Get a custom object record
      * Get all custom object records
      * Delete a custom object record
      * Update a custom object record
  * Document
      * Upload a document
  * Flow
      * Get all flows
      * Invoke a flow
  * Lead
      * Add lead to a campaign
      * Add note to a lead
      * Create a lead
      * Create a new lead, or update the current one if it already exists (upsert)
      * Delete a lead
      * Get a lead
      * Get all leads
      * Returns an overview of Lead's metadata
      * Update a lead
  * Opportunity
      * Add note to an opportunity
      * Create an opportunity
      * Create a new opportunity, or update the current one if it already exists (upsert)
      * Delete an opportunity
      * Get an opportunity
      * Get all opportunities
      * Returns an overview of opportunity's metadata
      * Update an opportunity
  * Search
      * Execute a SOQL query that returns all the results in a single response
  * Task
      * Create a task
      * Delete a task
      * Get a task
      * Get all tasks
      * Returns an overview of task's metadata
      * Update a task
  * User
      * Get a user
      * Get all users

  ## Templates and examples

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

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

  ## Working with Salesforce custom fields

  To add custom fields to your request:

  1. Select **Additional Fields** > **Add Field**.
  2. In the dropdown, select **Custom Fields**.

  You can then find and add your custom fields.

properties_schema:
  [{"displayName":"Authentication","name":"authentication","type":"options","options":[{"name":"OAuth2","value":"oAuth2"},{"name":"OAuth2 JWT","value":"jwt"}],"default":"oAuth2","description":"OAuth Authorization Flow"},{"displayName":"Resource","name":"resource","type":"options","noDataExpression":true,"options":[{"name":"Account","value":"account","description":"Represents an individual account, which is an organization or person involved with your business (such as customers, competitors, and partners)"},{"name":"Attachment","value":"attachment","description":"Represents a file that a has uploaded and attached to a parent object"},{"name":"Case","value":"case","description":"Represents a case, which is a customer issue or problem"},{"name":"Contact","value":"contact","description":"Represents a contact, which is an individual associated with an account"},{"name":"Custom Object","value":"customObject","description":"Represents a custom object"},{"name":"Document","value":"document","description":"Represents a document"},{"name":"Flow","value":"flow","description":"Represents an autolaunched flow"},{"name":"Lead","value":"lead","description":"Represents a prospect or potential"},{"name":"Opportunity","value":"opportunity","description":"Represents an opportunity, which is a sale or pending deal"},{"name":"Search","value":"search","description":"Search records"},{"name":"Task","value":"task","description":"Represents a business activity such as making a phone call or other to-do items. In the user interface, and records are collectively referred to as activities."},{"name":"User","value":"user","description":"Represents a person, which is one user in system"}],"default":"lead"},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["lead"]}},"options":[{"name":"Add Lead To Campaign","value":"addToCampaign","description":"Add lead to a campaign","action":"Add a lead to a campaign"},{"name":"Add Note","value":"addNote","description":"Add note to a lead","action":"Add a note to a lead"},{"name":"Create","value":"create","description":"Create a lead","action":"Create a lead"},{"name":"Create or Update","value":"upsert","description":"Create a new lead, or update the current one if it already exists (upsert)","action":"Create or update a lead"},{"name":"Delete","value":"delete","description":"Delete a lead","action":"Delete a lead"},{"name":"Get","value":"get","description":"Get a lead","action":"Get a lead"},{"name":"Get Many","value":"getAll","description":"Get many leads","action":"Get many leads"},{"name":"Get Summary","value":"getSummary","description":"Returns an overview of Lead's metadata","action":"Get a lead summary"},{"name":"Update","value":"update","description":"Update a lead","action":"Update a lead"}],"default":"create"},{"displayName":"Match Against","name":"externalId","type":"options","typeOptions":{"loadOptionsMethod":"getExternalIdFields","loadOptionsDependsOn":["resource"]},"required":true,"default":"","displayOptions":{"show":{"resource":["lead"],"operation":["upsert"]}},"description":"The field to check to see if the lead already exists. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Value to Match","name":"externalIdValue","type":"string","required":true,"default":"","displayOptions":{"show":{"resource":["lead"],"operation":["upsert"]}},"description":"If this value exists in the 'match against' field, update the lead. Otherwise create a new one."},{"displayName":"Company","name":"company","type":"string","required":true,"default":"","displayOptions":{"show":{"resource":["lead"],"operation":["create","upsert"]}},"description":"Company of the lead. If person account record types have been enabled, and if the value of Company is null, the lead converts to a person account."},{"displayName":"Last Name","name":"lastname","type":"string","required":true,"default":"","displayOptions":{"show":{"resource":["lead"],"operation":["create","upsert"]}},"description":"Required. Last name of the lead. Limited to 80 characters."},{"displayName":"Additional Fields","name":"additionalFields","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"resource":["lead"],"operation":["create","upsert"]}},"options":[{"displayName":"Annual Revenue","name":"annualRevenue","type":"number","typeOptions":{"numberPrecision":2},"default":"","description":"Annual revenue for the company of the lead"},{"displayName":"City","name":"city","type":"string","default":"","description":"City for the address of the lead"},{"displayName":"Country","name":"country","type":"string","default":"","description":"Country of the lead"},{"displayName":"Custom Fields","name":"customFieldsUi","placeholder":"Add Custom Field","type":"fixedCollection","typeOptions":{"multipleValues":true},"description":"Filter by custom fields","default":{},"options":[{"name":"customFieldsValues","displayName":"Custom Field","values":[{"displayName":"Field Name or ID","name":"fieldId","type":"options","typeOptions":{"loadOptionsMethod":"getCustomFields"},"default":"","description":"The ID of the field to add custom field to. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Value","name":"value","type":"string","default":"","description":"The value to set on custom field"}]}]},{"displayName":"Description","name":"description","type":"string","default":"","description":"Description of the lead"},{"displayName":"Email","name":"email","type":"string","placeholder":"name@email.com","default":"","description":"Email address for the lead"},{"displayName":"Fax","name":"fax","type":"number","default":"","description":"Fax number of the lead"},{"displayName":"First Name","name":"firstname","type":"string","default":"","description":"First name of the lead. Limited to 40 characters."},{"displayName":"Has Opted Out of Email","name":"hasOptedOutOfEmail","type":"boolean","default":false,"description":"Whether the lead doesn’t want to receive email from Salesforce (true) or does (false). Label is Email Opt Out."},{"displayName":"Has Opted Out of Fax","name":"hasOptedOutOfFax","type":"boolean","default":false,"description":"Whether the lead doesn’t want to receive fax from Salesforce (true) or does (false). Label is Email Opt Out."},{"displayName":"Industry","name":"industry","type":"string","default":"","description":"Website for the lead"},{"displayName":"Is Unread By Owner","name":"IsUnreadByOwner","type":"boolean","default":false,"description":"Whether true, lead has been assigned, but not yet viewed. See Unread Leads for more information. Label is Unread By Owner."},{"displayName":"Jigsaw","name":"jigsaw","type":"string","default":"","description":"References the ID of a contact in Data.com. If a lead has a value in this field, it means that a contact was imported as a lead from Data.com."},{"displayName":"Lead Source Name or ID","name":"leadSource","type":"options","typeOptions":{"loadOptionsMethod":"getLeadSources"},"default":"","description":"Source from which the lead was obtained. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Mobile Phone","name":"mobilePhone","type":"string","default":"","description":"Contact’s mobile phone number"},{"displayName":"Number Of Employees","name":"numberOfEmployees","type":"number","default":"","description":"Number of employees at the lead’s company. Label is Employees."},{"displayName":"Owner Name or ID","name":"owner","type":"options","typeOptions":{"loadOptionsMethod":"getLeadOwners"},"default":"","description":"The owner of the lead. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Phone","name":"phone","type":"string","default":"","description":"Phone number for the lead"},{"displayName":"Postal Code","name":"postalCode","type":"string","default":"","description":"Postal code for the address of the lead. Label is Zip/Postal Code."},{"displayName":"Record Type Name or ID","name":"recordTypeId","type":"options","description":"Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>","typeOptions":{"loadOptionsMethod":"getRecordTypes"},"default":""},{"displayName":"Rating","name":"rating","type":"string","default":"","description":"Rating of the lead"},{"displayName":"Salutation","name":"salutation","type":"string","default":"","description":"Salutation for the lead"},{"displayName":"State","name":"state","type":"string","default":"","description":"State for the address of the lead"},{"displayName":"Status Name or ID","name":"status","type":"options","typeOptions":{"loadOptionsMethod":"getLeadStatuses"},"default":"","description":"Status code for this converted lead. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Street","name":"street","type":"string","default":"","description":"Street number and name for the address of the lead"},{"displayName":"Title","name":"title","type":"string","default":"","description":"Title for the lead, for example CFO or CEO"},{"displayName":"Website","name":"website","type":"string","default":"","description":"Website for the lead"}]},{"displayName":"Lead ID","name":"leadId","type":"string","required":true,"default":"","displayOptions":{"show":{"resource":["lead"],"operation":["update"]}},"description":"ID of Lead that needs to be fetched"},{"displayName":"Update Fields","name":"updateFields","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"resource":["lead"],"operation":["update"]}},"options":[{"displayName":"Annual Revenue","name":"annualRevenue","type":"number","typeOptions":{"numberPrecision":2},"default":"","description":"Annual revenue for the company of the lead"},{"displayName":"City","name":"city","type":"string","default":"","description":"City for the address of the lead"},{"displayName":"Company","name":"company","type":"string","default":"","description":"Company of the lead. If person account record types have been enabled, and if the value of Company is null, the lead converts to a person account."},{"displayName":"Country","name":"country","type":"string","default":"","description":"Country of the lead"},{"displayName":"Custom Fields","name":"customFieldsUi","placeholder":"Add Custom Field","type":"fixedCollection","typeOptions":{"multipleValues":true},"description":"Filter by custom fields","default":{},"options":[{"name":"customFieldsValues","displayName":"Custom Field","values":[{"displayName":"Field Name or ID","name":"fieldId","type":"options","typeOptions":{"loadOptionsMethod":"getCustomFields"},"default":"","description":"The ID of the field to add custom field to. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Value","name":"value","type":"string","default":"","description":"The value to set on custom field"}]}]},{"displayName":"Description","name":"description","type":"string","default":"","description":"Description of the lead"},{"displayName":"Email","name":"email","type":"string","placeholder":"name@email.com","default":"","description":"Email address for the lead"},{"displayName":"Fax","name":"fax","type":"number","default":"","description":"Fax Number of the lead"},{"displayName":"First Name","name":"firstname","type":"string","default":"","description":"First name of the lead. Limited to 40 characters."},{"displayName":"Has Opted Out of Email","name":"hasOptedOutOfEmail","type":"boolean","default":false,"description":"Whether the lead doesn’t want to receive email from Salesforce (true) or does (false). Label is Email Opt Out."},{"displayName":"Has Opted Out of Fax","name":"HasOptedOutOfFax","type":"boolean","default":false,"description":"Whether the lead doesn’t want to receive fax from Salesforce (true) or does (false). Label is Fax Opt Out."},{"displayName":"Industry","name":"industry","type":"string","default":"","description":"Website for the lead"},{"displayName":"Is Unread By Owner","name":"IsUnreadByOwner","type":"boolean","default":false,"description":"Whether true, lead has been assigned, but not yet viewed. See Unread Leads for more information. Label is Unread By Owner."},{"displayName":"Jigsaw","name":"jigsaw","type":"string","default":"","description":"References the ID of a contact in Data.com. If a lead has a value in this field, it means that a contact was imported as a lead from Data.com."},{"displayName":"Last Name","name":"lastname","type":"string","default":"","description":"Required. Last name of the lead. Limited to 80 characters."},{"displayName":"Lead Source Name or ID","name":"leadSource","type":"options","typeOptions":{"loadOptionsMethod":"getLeadSources"},"default":"","description":"Source from which the lead was obtained. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Mobile Phone","name":"mobilePhone","type":"string","default":"","description":"Contact’s mobile phone number"},{"displayName":"Number Of Employees","name":"numberOfEmployees","type":"number","default":"","description":"Number of employees at the lead’s company. Label is Employees."},{"displayName":"Owner Name or ID","name":"owner","type":"options","typeOptions":{"loadOptionsMethod":"getLeadOwners"},"default":"","description":"The owner of the lead. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Postal Code","name":"postalCode","type":"string","default":"","description":"Postal code for the address of the lead. Label is Zip/Postal Code."},{"displayName":"Phone","name":"phone","type":"string","default":"","description":"Phone number for the lead"},{"displayName":"Record Type Name or ID","name":"recordTypeId","type":"options","description":"Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>","typeOptions":{"loadOptionsMethod":"getRecordTypes"},"default":""},{"displayName":"Rating","name":"rating","type":"string","default":"","description":"Rating of the lead"},{"displayName":"Salutation","name":"salutation","type":"string","default":"","description":"Salutation for the lead"},{"displayName":"State","name":"state","type":"string","default":"","description":"State for the address of the lead"},{"displayName":"Status Name or ID","name":"status","type":"options","typeOptions":{"loadOptionsMethod":"getLeadStatuses"},"default":"","description":"Status code for this converted lead. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Street","name":"street","type":"string","default":"","description":"Street number and name for the address of the lead"},{"displayName":"Title","name":"title","type":"string","default":"","description":"Title for the lead, for example CFO or CEO"},{"displayName":"Website","name":"website","type":"string","default":"","description":"Website for the lead"}]},{"displayName":"Lead ID","name":"leadId","type":"string","required":true,"default":"","displayOptions":{"show":{"resource":["lead"],"operation":["get"]}},"description":"ID of Lead that needs to be fetched"},{"displayName":"Lead ID","name":"leadId","type":"string","required":true,"default":"","displayOptions":{"show":{"resource":["lead"],"operation":["delete"]}},"description":"ID of Lead that needs to be fetched"},{"displayName":"Return All","name":"returnAll","type":"boolean","displayOptions":{"show":{"resource":["lead"],"operation":["getAll"]}},"default":false,"description":"Whether to return all results or only up to a given limit"},{"displayName":"Limit","name":"limit","type":"number","displayOptions":{"show":{"resource":["lead"],"operation":["getAll"],"returnAll":[false]}},"typeOptions":{"minValue":1,"maxValue":100},"default":50,"description":"Max number of results to return"},{"displayName":"Options","name":"options","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"resource":["lead"],"operation":["getAll"]}},"options":[{"displayName":"Conditions","name":"conditionsUi","placeholder":"Add Condition","type":"fixedCollection","typeOptions":{"multipleValues":true},"description":"The condition to set","default":{},"options":[{"name":"conditionValues","displayName":"Condition","values":[{"displayName":"Field Name or ID","name":"field","type":"options","typeOptions":{"loadOptionsMethod":"getLeadFields"},"default":"","description":"For date, number, or boolean, please use expressions. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Operation","name":"operation","type":"options","options":[{"name":"<","value":"<"},{"name":"<=","value":"<="},{"name":"=","value":"equal"},{"name":">","value":">"},{"name":">=","value":">="}],"default":"equal"},{"displayName":"Value","name":"value","type":"string","default":""}]}]},{"displayName":"Fields","name":"fields","type":"string","default":"","description":"Fields to include separated by ,"}]},{"displayName":"Lead ID","name":"leadId","type":"string","required":true,"default":"","displayOptions":{"show":{"resource":["lead"],"operation":["addToCampaign"]}},"description":"ID of contact that needs to be fetched"},{"displayName":"Campaign Name or ID","name":"campaignId","type":"options","typeOptions":{"loadOptionsMethod":"getCampaigns"},"required":true,"default":"","displayOptions":{"show":{"resource":["lead"],"operation":["addToCampaign"]}},"description":"ID of the campaign that needs to be fetched. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Options","name":"options","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"resource":["lead"],"operation":["addToCampaign"]}},"options":[{"displayName":"Status","name":"status","type":"string","default":"","description":"Controls the HasResponded flag on this object"}]},{"displayName":"Lead ID","name":"leadId","type":"string","required":true,"default":"","displayOptions":{"show":{"resource":["lead"],"operation":["addNote"]}},"description":"ID of lead that needs to be fetched"},{"displayName":"Title","name":"title","type":"string","required":true,"default":"","displayOptions":{"show":{"resource":["lead"],"operation":["addNote"]}},"description":"Title of the note"},{"displayName":"Options","name":"options","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"resource":["lead"],"operation":["addNote"]}},"options":[{"displayName":"Body","name":"body","type":"string","default":"","description":"Body of the note. Limited to 32 KB."},{"displayName":"Is Private","name":"isPrivate","type":"boolean","default":false,"description":"Whether true, only the note owner or a user with the “Modify All Data” permission can view the note or query it via the API"},{"displayName":"Owner Name or ID","name":"owner","type":"options","typeOptions":{"loadOptionsMethod":"getUsers"},"default":"","description":"ID of the user who owns the note. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."}]},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["contact"]}},"options":[{"name":"Add Contact To Campaign","value":"addToCampaign","description":"Add contact to a campaign","action":"Add a contact to a campaign"},{"name":"Add Note","value":"addNote","description":"Add note to a contact","action":"Add a note to a contact"},{"name":"Create","value":"create","description":"Create a contact","action":"Create a contact"},{"name":"Create or Update","value":"upsert","description":"Create a new contact, or update the current one if it already exists (upsert)","action":"Create or update a contact"},{"name":"Delete","value":"delete","description":"Delete a contact","action":"Delete a contact"},{"name":"Get","value":"get","description":"Get a contact","action":"Get a contact"},{"name":"Get Many","value":"getAll","description":"Get many contacts","action":"Get many contacts"},{"name":"Get Summary","value":"getSummary","description":"Returns an overview of contact's metadata","action":"Get a contact summary"},{"name":"Update","value":"update","description":"Update a contact","action":"Update a contact"}],"default":"create"},{"displayName":"Match Against","name":"externalId","type":"options","typeOptions":{"loadOptionsMethod":"getExternalIdFields","loadOptionsDependsOn":["resource"]},"required":true,"default":"","displayOptions":{"show":{"resource":["contact"],"operation":["upsert"]}},"description":"The field to check to see if the contact already exists. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Value to Match","name":"externalIdValue","type":"string","required":true,"default":"","displayOptions":{"show":{"resource":["contact"],"operation":["upsert"]}},"description":"If this value exists in the 'match against' field, update the contact. Otherwise create a new one."},{"displayName":"Last Name","name":"lastname","type":"string","required":true,"default":"","displayOptions":{"show":{"resource":["contact"],"operation":["create","upsert"]}},"description":"Required. Last name of the contact. Limited to 80 characters."},{"displayName":"Additional Fields","name":"additionalFields","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"resource":["contact"],"operation":["create","upsert"]}},"options":[{"displayName":"Account Name or ID","name":"acconuntId","type":"options","typeOptions":{"loadOptionsMethod":"getAccounts"},"default":"","description":"ID of the account that is the parent of this contact. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Assistant Name","name":"assistantName","type":"string","default":"","description":"The name of the assistant"},{"displayName":"Assistant Phone","name":"Assistant Phone","type":"string","default":"","description":"The telephone number of the assistant"},{"displayName":"Birth Date","name":"birthdate","type":"dateTime","default":"","description":"The birth date of the contact"},{"displayName":"Custom Fields","name":"customFieldsUi","placeholder":"Add Custom Field","type":"fixedCollection","typeOptions":{"multipleValues":true},"description":"Filter by custom fields","default":{},"options":[{"name":"customFieldsValues","displayName":"Custom Field","values":[{"displayName":"Field Name or ID","name":"fieldId","type":"options","typeOptions":{"loadOptionsMethod":"getCustomFields"},"default":"","description":"The ID of the field to add custom field to. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Value","name":"value","type":"string","default":"","description":"The value to set on custom field"}]}]},{"displayName":"Department","name":"department","type":"string","default":"","description":"The department of the contact"},{"displayName":"Description","name":"description","type":"string","default":"","description":"A description of the contact. Label is Contact Description. Limit: 32 KB."},{"displayName":"Email","name":"email","type":"string","placeholder":"name@email.com","default":"","description":"Email address for the contact"},{"displayName":"Email Bounced Date","name":"otherPostalCode","type":"dateTime","default":"","description":"If bounce management is activated and an email sent to the contact bounces, the date and time the bounce occurred"},{"displayName":"Email Bounced Reason","name":"emailBouncedReason","type":"string","default":"","description":"If bounce management is activated and an email sent to the contact bounces, the reason the bounce occurred"},{"displayName":"Fax","name":"fax","type":"string","default":"","description":"Fax number for the contact. Label is Business Fax."},{"displayName":"First Name","name":"firstName","type":"string","default":"","description":"First name of the contact. Maximum size is 40 characters."},{"displayName":"Home Phone","name":"homePhone","type":"string","default":"","description":"Home telephone number for the contact"},{"displayName":"Jigsaw","name":"jigsaw","type":"string","default":"","description":"References the ID of a contact in Data.com. If a contact has a value in this field, it means that a contact was imported as a contact from Data.com."},{"displayName":"Lead Source Name or ID","name":"leadSource","type":"options","typeOptions":{"loadOptionsMethod":"getLeadSources"},"default":"","description":"Source from which the lead was obtained. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Mailing City","name":"mailingCity","type":"string","default":""},{"displayName":"Mailing Country","name":"mailingCountry","type":"string","default":""},{"displayName":"Mobile Phone","name":"mobilePhone","type":"string","default":"","description":"Contact’s mobile phone number"},{"displayName":"Mailing Postal Code","name":"mailingPostalCode","type":"string","default":""},{"displayName":"Mailing State","name":"mailingState","type":"string","default":""},{"displayName":"Mailing Street","name":"mailingStreet","type":"string","default":"","description":"Street address for mailing address"},{"displayName":"Other City","name":"otherCity","type":"string","default":""},{"displayName":"Other Country","name":"otherCountry","type":"string","default":""},{"displayName":"Other Phone","name":"otherPhone","type":"string","default":"","description":"Telephone for alternate address"},{"displayName":"Other Postal Code","name":"otherPostalCode","type":"string","default":""},{"displayName":"Other State","name":"otherState","type":"string","default":""},{"displayName":"Other Street","name":"otherStreet","type":"string","default":"","description":"Street for alternate address"},{"displayName":"Owner Name or ID","name":"owner","type":"options","typeOptions":{"loadOptionsMethod":"getUsers"},"default":"","description":"The owner of the contact. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Phone","name":"phone","type":"string","default":"","description":"Phone number for the contact"},{"displayName":"Record Type Name or ID","name":"recordTypeId","type":"options","description":"Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>","typeOptions":{"loadOptionsMethod":"getRecordTypes"},"default":""},{"displayName":"Salutation","name":"salutation","type":"string","default":"","description":"Honorific abbreviation, word, or phrase to be used in front of name in greetings, such as Dr. or Mrs."},{"displayName":"Title","name":"title","type":"string","default":"","description":"Title of the contact such as CEO or Vice President"}]},{"displayName":"Contact ID","name":"contactId","type":"string","required":true,"default":"","displayOptions":{"show":{"resource":["contact"],"operation":["update"]}},"description":"ID of contact that needs to be fetched"},{"displayName":"Update Fields","name":"updateFields","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"resource":["contact"],"operation":["update"]}},"options":[{"displayName":"Account Name or ID","name":"acconuntId","type":"options","typeOptions":{"loadOptionsMethod":"getAccounts"},"default":"","description":"ID of the account that is the parent of this contact. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Assistant Name","name":"assistantName","type":"string","default":"","description":"The name of the assistant"},{"displayName":"Assistant Phone","name":"Assistant Phone","type":"string","default":"","description":"The telephone number of the assistant"},{"displayName":"Birth Date","name":"birthdate","type":"dateTime","default":"","description":"The birth date of the contact"},{"displayName":"Custom Fields","name":"customFieldsUi","placeholder":"Add Custom Field","type":"fixedCollection","typeOptions":{"multipleValues":true},"description":"Filter by custom fields","default":{},"options":[{"name":"customFieldsValues","displayName":"Custom Field","values":[{"displayName":"Field Name or ID","name":"fieldId","type":"options","typeOptions":{"loadOptionsMethod":"getCustomFields"},"default":"","description":"The ID of the field to add custom field to. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Value","name":"value","type":"string","default":"","description":"The value to set on custom field"}]}]},{"displayName":"Department","name":"department","type":"string","default":"","description":"The department of the contact"},{"displayName":"Description","name":"description","type":"string","default":"","description":"A description of the contact. Label is Contact Description. Limit: 32 KB."},{"displayName":"Email","name":"email","type":"string","placeholder":"name@email.com","default":"","description":"Email address for the contact"},{"displayName":"Email Bounced Date","name":"emailBouncedDate","type":"dateTime","default":"","description":"If bounce management is activated and an email sent to the contact bounces, the date and time the bounce occurred"},{"displayName":"Email Bounced Reason","name":"emailBouncedReason","type":"string","default":"","description":"If bounce management is activated and an email sent to the contact bounces, the reason the bounce occurred"},{"displayName":"Fax","name":"fax","type":"string","default":"","description":"Fax number for the contact. Label is Business Fax."},{"displayName":"First Name","name":"firstName","type":"string","default":"","description":"First name of the contact. Maximum size is 40 characters."},{"displayName":"Home Phone","name":"homePhone","type":"string","default":"","description":"Home telephone number for the contact"},{"displayName":"Jigsaw","name":"jigsaw","type":"string","default":"","description":"References the ID of a contact in Data.com. If a contact has a value in this field, it means that a contact was imported as a contact from Data.com."},{"displayName":"Last Name","name":"lastName","type":"string","default":"","description":"Last name of the contact. Limited to 80 characters."},{"displayName":"Lead Source Name or ID","name":"leadSource","type":"options","typeOptions":{"loadOptionsMethod":"getLeadSources"},"default":"","description":"Source from which the lead was obtained. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Mailing City","name":"mailingCity","type":"string","default":""},{"displayName":"Mailing Country","name":"mailingCountry","type":"string","default":""},{"displayName":"Mailing State","name":"mailingState","type":"string","default":""},{"displayName":"Mailing Street","name":"mailingStreet","type":"string","default":"","description":"Street address for mailing address"},{"displayName":"Mailing Postal Code","name":"mailingPostalCode","type":"string","default":""},{"displayName":"Mobile Phone","name":"mobilePhone","type":"string","default":"","description":"Contact’s mobile phone number"},{"displayName":"Other City","name":"otherCity","type":"string","default":""},{"displayName":"Other Country","name":"otherCountry","type":"string","default":""},{"displayName":"Other Phone","name":"otherPhone","type":"string","default":"","description":"Telephone for alternate address"},{"displayName":"Other Postal Code","name":"otherPostalCode","type":"string","default":""},{"displayName":"Other State","name":"otherState","type":"string","default":""},{"displayName":"Other Street","name":"otherStreet","type":"string","default":"","description":"Street for alternate address"},{"displayName":"Owner Name or ID","name":"owner","type":"options","typeOptions":{"loadOptionsMethod":"getUsers"},"default":"","description":"The owner of the contact. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Phone","name":"phone","type":"string","default":"","description":"Phone number for the contact"},{"displayName":"Record Type Name or ID","name":"recordTypeId","type":"options","description":"Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>","typeOptions":{"loadOptionsMethod":"getRecordTypes"},"default":""},{"displayName":"Salutation","name":"salutation","type":"string","default":"","description":"Honorific abbreviation, word, or phrase to be used in front of name in greetings, such as Dr. or Mrs."},{"displayName":"Title","name":"title","type":"string","default":"","description":"Title of the contact such as CEO or Vice President"}]},{"displayName":"Contact ID","name":"contactId","type":"string","required":true,"default":"","displayOptions":{"show":{"resource":["contact"],"operation":["get"]}},"description":"ID of contact that needs to be fetched"},{"displayName":"Contact ID","name":"contactId","type":"string","required":true,"default":"","displayOptions":{"show":{"resource":["contact"],"operation":["delete"]}},"description":"ID of contact that needs to be fetched"},{"displayName":"Return All","name":"returnAll","type":"boolean","displayOptions":{"show":{"resource":["contact"],"operation":["getAll"]}},"default":false,"description":"Whether to return all results or only up to a given limit"},{"displayName":"Limit","name":"limit","type":"number","displayOptions":{"show":{"resource":["contact"],"operation":["getAll"],"returnAll":[false]}},"typeOptions":{"minValue":1,"maxValue":100},"default":50,"description":"Max number of results to return"},{"displayName":"Options","name":"options","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"resource":["contact"],"operation":["getAll"]}},"options":[{"displayName":"Conditions","name":"conditionsUi","placeholder":"Add Condition","type":"fixedCollection","typeOptions":{"multipleValues":true},"description":"The condition to set","default":{},"options":[{"name":"conditionValues","displayName":"Condition","values":[{"displayName":"Field Name or ID","name":"field","type":"options","typeOptions":{"loadOptionsMethod":"getContactFields"},"default":"","description":"For date, number, or boolean, please use expressions. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Operation","name":"operation","type":"options","options":[{"name":"<","value":"<"},{"name":"<=","value":"<="},{"name":"=","value":"equal"},{"name":">","value":">"},{"name":">=","value":">="}],"default":"equal"},{"displayName":"Value","name":"value","type":"string","default":""}]}]},{"displayName":"Fields","name":"fields","type":"string","default":"","description":"Fields to include separated by ,"}]},{"displayName":"Contact ID","name":"contactId","type":"string","required":true,"default":"","displayOptions":{"show":{"resource":["contact"],"operation":["addToCampaign"]}},"description":"ID of contact that needs to be fetched"},{"displayName":"Campaign Name or ID","name":"campaignId","type":"options","typeOptions":{"loadOptionsMethod":"getCampaigns"},"required":true,"default":"","displayOptions":{"show":{"resource":["contact"],"operation":["addToCampaign"]}},"description":"ID of the campaign that needs to be fetched. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Options","name":"options","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"resource":["contact"],"operation":["addToCampaign"]}},"options":[{"displayName":"Status","name":"status","type":"string","default":"","description":"Controls the HasResponded flag on this object"}]},{"displayName":"Contact ID","name":"contactId","type":"string","required":true,"default":"","displayOptions":{"show":{"resource":["contact"],"operation":["addNote"]}},"description":"ID of contact that needs to be fetched"},{"displayName":"Title","name":"title","type":"string","required":true,"default":"","displayOptions":{"show":{"resource":["contact"],"operation":["addNote"]}},"description":"Title of the note"},{"displayName":"Options","name":"options","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"resource":["contact"],"operation":["addNote"]}},"options":[{"displayName":"Body","name":"body","type":"string","default":"","description":"Body of the note. Limited to 32 KB."},{"displayName":"Is Private","name":"isPrivate","type":"boolean","default":false,"description":"Whether only the note owner or a user with the “Modify All Data” permission can view the note or query it via the API"},{"displayName":"Owner Name or ID","name":"owner","type":"options","typeOptions":{"loadOptionsMethod":"getUsers"},"default":"","description":"ID of the user who owns the note. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."}]},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["customObject"]}},"options":[{"name":"Create","value":"create","description":"Create a custom object record","action":"Create a custom object"},{"name":"Create or Update","value":"upsert","description":"Create a new record, or update the current one if it already exists (upsert)","action":"Create or update a custom object"},{"name":"Delete","value":"delete","description":"Delete a custom object record","action":"Delete a custom object"},{"name":"Get","value":"get","description":"Get a custom object record","action":"Get a custom object"},{"name":"Get Many","value":"getAll","description":"Get many custom object records","action":"Get many custom objects"},{"name":"Update","value":"update","description":"Update a custom object record","action":"Update a custom object"}],"default":"create"},{"displayName":"Custom Object Name or ID","name":"customObject","type":"options","typeOptions":{"loadOptionsMethod":"getCustomObjects"},"required":true,"default":"","displayOptions":{"show":{"resource":["customObject"],"operation":["create","upsert"]}},"description":"Name of the custom object. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Match Against","name":"externalId","type":"options","typeOptions":{"loadOptionsMethod":"getExternalIdFields","loadOptionsDependsOn":["customObject"]},"required":true,"default":"","displayOptions":{"show":{"resource":["customObject"],"operation":["upsert"]}},"description":"The field to check to see if the object already exists. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Value to Match","name":"externalIdValue","type":"string","required":true,"default":"","displayOptions":{"show":{"resource":["customObject"],"operation":["upsert"]}},"description":"If this value exists in the 'match against' field, update the object. Otherwise create a new one."},{"displayName":"Fields","name":"customFieldsUi","placeholder":"Add Field","type":"fixedCollection","typeOptions":{"multipleValues":true},"displayOptions":{"show":{"resource":["customObject"],"operation":["create","upsert"]}},"description":"Filter by custom fields","default":{},"options":[{"name":"customFieldsValues","displayName":"Custom Field","values":[{"displayName":"Field Name or ID","name":"fieldId","type":"options","typeOptions":{"loadOptionsMethod":"getCustomObjectFields","loadOptionsDependsOn":["customObject"]},"default":"","description":"The ID of the field. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Value","name":"value","type":"string","default":"","description":"The value to set on custom field"}]}]},{"displayName":"Custom Object Name or ID","name":"customObject","type":"options","typeOptions":{"loadOptionsMethod":"getCustomObjects"},"required":true,"default":"","displayOptions":{"show":{"resource":["customObject"],"operation":["update"]}},"description":"Name of the custom object. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Record ID","name":"recordId","type":"string","required":true,"default":"","displayOptions":{"show":{"resource":["customObject"],"operation":["update"]}},"description":"Record ID to be updated"},{"displayName":"Fields","name":"customFieldsUi","placeholder":"Add Field","type":"fixedCollection","typeOptions":{"multipleValues":true},"description":"Filter by custom fields","default":{},"displayOptions":{"show":{"resource":["customObject"],"operation":["update"]}},"options":[{"name":"customFieldsValues","displayName":"Custom Field","values":[{"displayName":"Field Name or ID","name":"fieldId","type":"options","typeOptions":{"loadOptionsMethod":"getCustomObjectFields","loadOptionsDependsOn":["customObject"]},"default":"","description":"The ID of the field. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Value","name":"value","type":"string","default":"","description":"The value to set on custom field"}]}]},{"displayName":"Custom Object Name or ID","name":"customObject","type":"options","typeOptions":{"loadOptionsMethod":"getCustomObjects"},"required":true,"default":"","displayOptions":{"show":{"resource":["customObject"],"operation":["get"]}},"description":"Name of the custom object. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Record ID","name":"recordId","type":"string","required":true,"default":"","displayOptions":{"show":{"resource":["customObject"],"operation":["get"]}},"description":"Record ID to be retrieved"},{"displayName":"Custom Object Name or ID","name":"customObject","type":"options","typeOptions":{"loadOptionsMethod":"getCustomObjects"},"required":true,"default":"","displayOptions":{"show":{"resource":["customObject"],"operation":["delete"]}},"description":"Name of the custom object. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Record ID","name":"recordId","type":"string","required":true,"default":"","displayOptions":{"show":{"resource":["customObject"],"operation":["delete"]}},"description":"Record ID to be deleted"},{"displayName":"Custom Object Name or ID","name":"customObject","type":"options","typeOptions":{"loadOptionsMethod":"getCustomObjects"},"required":true,"default":"","displayOptions":{"show":{"resource":["customObject"],"operation":["getAll"]}},"description":"Name of the custom object. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Return All","name":"returnAll","type":"boolean","displayOptions":{"show":{"resource":["customObject"],"operation":["getAll"]}},"default":false,"description":"Whether to return all results or only up to a given limit"},{"displayName":"Limit","name":"limit","type":"number","displayOptions":{"show":{"resource":["customObject"],"operation":["getAll"],"returnAll":[false]}},"typeOptions":{"minValue":1,"maxValue":100},"default":50,"description":"Max number of results to return"},{"displayName":"Options","name":"options","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"resource":["customObject"],"operation":["getAll"]}},"options":[{"displayName":"Conditions","name":"conditionsUi","placeholder":"Add Condition","type":"fixedCollection","typeOptions":{"multipleValues":true},"description":"The condition to set","default":{},"options":[{"name":"conditionValues","displayName":"Condition","values":[{"displayName":"Field Name or ID","name":"field","type":"options","typeOptions":{"loadOptionsMethod":"getCustomObjectFields","loadOptionsDependsOn":["customObject"]},"default":"","description":"For date, number, or boolean, please use expressions. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Operation","name":"operation","type":"options","options":[{"name":"<","value":"<"},{"name":"<=","value":"<="},{"name":"=","value":"equal"},{"name":">","value":">"},{"name":">=","value":">="}],"default":"equal"},{"displayName":"Value","name":"value","type":"string","default":""}]}]},{"displayName":"Field Names or IDs","name":"fields","type":"multiOptions","typeOptions":{"loadOptionsMethod":"getCustomObjectFields","loadOptionsDependsOn":["customObject"]},"default":[],"description":"Fields to include separated by commas. Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."}]},{"displayName":"Additional Fields","name":"additionalFields","type":"collection","displayOptions":{"show":{"operation":["create","upsert"],"resource":["customObject"]}},"default":{},"placeholder":"Add Field","options":[{"displayName":"Record Type Name or ID","name":"recordTypeId","type":"options","description":"Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>","typeOptions":{"loadOptionsMethod":"getRecordTypes","loadOptionsDependsOn":["customObject"]},"default":""}]},{"displayName":"Update Fields","name":"updateFields","type":"collection","displayOptions":{"show":{"operation":["update"],"resource":["customObject"]}},"default":{},"placeholder":"Add Field","options":[{"displayName":"Record Type Name or ID","name":"recordTypeId","type":"options","description":"Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>","typeOptions":{"loadOptionsMethod":"getRecordTypes","loadOptionsDependsOn":["customObject"]},"default":""}]},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["document"]}},"options":[{"name":"Upload","value":"upload","description":"Upload a document","action":"Upload a document"}],"default":"upload"},{"displayName":"Title","name":"title","type":"string","default":"","required":true,"displayOptions":{"show":{"resource":["document"],"operation":["upload"]}},"description":"Name of the file"},{"displayName":"Binary Property","name":"binaryPropertyName","type":"string","default":"data","required":true,"displayOptions":{"show":{"resource":["document"],"operation":["upload"]}},"placeholder":"","description":"Name of the binary property which contains the data for the file to be uploaded"},{"displayName":"Additional Fields","name":"additionalFields","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"resource":["document"],"operation":["upload"]}},"options":[{"displayName":"File Extension","name":"fileExtension","type":"string","default":"","placeholder":"pdf","description":"File extension to use. If none is set, the value from the binary data will be used."},{"displayName":"Link To Object ID","name":"linkToObjectId","type":"string","default":"","description":"ID of the object you want to link this document to"},{"displayName":"Owner Name or ID","name":"ownerId","type":"options","typeOptions":{"loadOptionsMethod":"getUsers"},"default":"","description":"ID of the owner of this document. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."}]},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["opportunity"]}},"options":[{"name":"Add Note","value":"addNote","description":"Add note to an opportunity","action":"Add a note to an opportunity"},{"name":"Create","value":"create","description":"Create an opportunity","action":"Create an opportunity"},{"name":"Create or Update","value":"upsert","description":"Create a new opportunity, or update the current one if it already exists (upsert)","action":"Create or update an opportunity"},{"name":"Delete","value":"delete","description":"Delete an opportunity","action":"Delete an opportunity"},{"name":"Get","value":"get","description":"Get an opportunity","action":"Get an opportunity"},{"name":"Get Many","value":"getAll","description":"Get many opportunities","action":"Get many opportunities"},{"name":"Get Summary","value":"getSummary","description":"Returns an overview of opportunity's metadata","action":"Get an opportunity summary"},{"name":"Update","value":"update","description":"Update an opportunity","action":"Update an opportunity"}],"default":"create"},{"displayName":"Match Against","name":"externalId","type":"options","typeOptions":{"loadOptionsMethod":"getExternalIdFields","loadOptionsDependsOn":["resource"]},"required":true,"default":"","displayOptions":{"show":{"resource":["opportunity"],"operation":["upsert"]}},"description":"The field to check to see if the opportunity already exists. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Value to Match","name":"externalIdValue","type":"string","required":true,"default":"","displayOptions":{"show":{"resource":["opportunity"],"operation":["upsert"]}},"description":"If this value exists in the 'match against' field, update the opportunity. Otherwise create a new one."},{"displayName":"Name","name":"name","type":"string","required":true,"default":"","displayOptions":{"show":{"resource":["opportunity"],"operation":["create","upsert"]}},"description":"Required. Last name of the opportunity. Limited to 80 characters."},{"displayName":"Close Date","name":"closeDate","type":"dateTime","required":true,"default":"","displayOptions":{"show":{"resource":["opportunity"],"operation":["create","upsert"]}},"description":"Required. Date when the opportunity is expected to close."},{"displayName":"Stage Name or ID","name":"stageName","type":"options","typeOptions":{"loadOptionsMethod":"getStages"},"required":true,"default":"","displayOptions":{"show":{"resource":["opportunity"],"operation":["create","upsert"]}},"description":"Required. Date when the opportunity is expected to close. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Additional Fields","name":"additionalFields","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"resource":["opportunity"],"operation":["create","upsert"]}},"options":[{"displayName":"Account Name or ID","name":"accountId","type":"options","default":"","typeOptions":{"loadOptionsMethod":"getAccounts"},"description":"ID of the account associated with this opportunity. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Amount","name":"amount","type":"number","typeOptions":{"numberPrecision":2},"default":"","description":"Estimated total sale amount"},{"displayName":"Campaign Name or ID","name":"campaignId","type":"options","typeOptions":{"loadOptionsMethod":"getCampaigns"},"default":"","description":"ID of the campaign that needs to be fetched. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Custom Fields","name":"customFieldsUi","placeholder":"Add Custom Field","type":"fixedCollection","typeOptions":{"multipleValues":true},"description":"Filter by custom fields","default":{},"options":[{"name":"customFieldsValues","displayName":"Custom Field","values":[{"displayName":"Field Name or ID","name":"fieldId","type":"options","typeOptions":{"loadOptionsMethod":"getCustomFields"},"default":"","description":"The ID of the field to add custom field to. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Value","name":"value","type":"string","default":"","description":"The value to set on custom field"}]}]},{"displayName":"Description","name":"description","type":"string","default":"","description":"A description of the opportunity. Label is Contact Description. Limit: 32 KB."},{"displayName":"Forecast Category Name","name":"forecastCategoryName","type":"string","default":"","description":"It is implied, but not directly controlled, by the StageName field"},{"displayName":"Lead Source Name or ID","name":"leadSource","type":"options","typeOptions":{"loadOptionsMethod":"getLeadSources"},"default":"","description":"Source from which the lead was obtained. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Next Step","name":"nextStep","type":"string","default":"","description":"Description of next task in closing opportunity. Limit: 255 characters."},{"displayName":"Owner Name or ID","name":"owner","type":"options","typeOptions":{"loadOptionsMethod":"getUsers"},"default":"","description":"The owner of the opportunity. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Phone","name":"phone","type":"string","default":"","description":"Phone number for the opportunity"},{"displayName":"Pricebook2 ID","name":"pricebook2Id","type":"string","default":"","description":"ID of a related Pricebook2 object"},{"displayName":"Probability","name":"probability","type":"number","typeOptions":{"numberPrecision":1},"default":"","description":"Percentage of estimated confidence in closing the opportunity"},{"displayName":"Type","name":"type","type":"options","default":"","options":[{"name":"Business","value":"Business"},{"name":"New Business","value":"New Business"}],"description":"Type of opportunity. For example, Existing Business or New Business. Label is Opportunity Type."}]},{"displayName":"Opportunity ID","name":"opportunityId","type":"string","required":true,"default":"","displayOptions":{"show":{"resource":["opportunity"],"operation":["update"]}},"description":"ID of opportunity that needs to be fetched"},{"displayName":"Update Fields","name":"updateFields","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"resource":["opportunity"],"operation":["update"]}},"options":[{"displayName":"Account Name or ID","name":"accountId","type":"options","default":"","typeOptions":{"loadOptionsMethod":"getAccounts"},"description":"ID of the account associated with this opportunity. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Amount","name":"amount","type":"number","typeOptions":{"numberPrecision":2},"default":"","description":"Estimated total sale amount"},{"displayName":"Campaign Name or ID","name":"campaignId","type":"options","typeOptions":{"loadOptionsMethod":"getCampaigns"},"default":"","description":"ID of the campaign that needs to be fetched. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Close Date","name":"closeDate","type":"dateTime","default":"","description":"Required. Date when the opportunity is expected to close."},{"displayName":"Custom Fields","name":"customFieldsUi","placeholder":"Add Custom Field","type":"fixedCollection","typeOptions":{"multipleValues":true},"description":"Filter by custom fields","default":{},"options":[{"name":"customFieldsValues","displayName":"Custom Field","values":[{"displayName":"Field Name or ID","name":"fieldId","type":"options","typeOptions":{"loadOptionsMethod":"getCustomFields"},"default":"","description":"The ID of the field to add custom field to. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Value","name":"value","type":"string","default":"","description":"The value to set on custom field"}]}]},{"displayName":"Description","name":"description","type":"string","default":"","description":"A description of the opportunity. Label is Contact Description. Limit: 32 KB."},{"displayName":"Forecast Category Name","name":"forecastCategoryName","type":"string","default":"","description":"It is implied, but not directly controlled, by the StageName field"},{"displayName":"Lead Source Name or ID","name":"leadSource","type":"options","typeOptions":{"loadOptionsMethod":"getLeadSources"},"default":"","description":"Source from which the lead was obtained. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Name","name":"name","type":"string","default":"","description":"Required. Last name of the opportunity. Limited to 80 characters."},{"displayName":"Next Step","name":"nextStep","type":"string","default":"","description":"Description of next task in closing opportunity. Limit: 255 characters."},{"displayName":"Owner Name or ID","name":"owner","type":"options","typeOptions":{"loadOptionsMethod":"getUsers"},"default":"","description":"The owner of the opportunity. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Phone","name":"phone","type":"string","default":"","description":"Phone number for the opportunity"},{"displayName":"Pricebook2 ID","name":"pricebook2Id","type":"string","default":"","description":"ID of a related Pricebook2 object"},{"displayName":"Probability","name":"probability","type":"number","typeOptions":{"numberPrecision":1},"default":"","description":"Percentage of estimated confidence in closing the opportunity"},{"displayName":"Stage Name or ID","name":"stageName","type":"options","typeOptions":{"loadOptionsMethod":"getStages"},"default":"","description":"Required. Date when the opportunity is expected to close. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Type","name":"type","type":"options","default":"","options":[{"name":"Business","value":"Business"},{"name":"New Business","value":"New Business"}],"description":"Type of opportunity. For example, Existing Business or New Business. Label is Opportunity Type."}]},{"displayName":"Opportunity ID","name":"opportunityId","type":"string","required":true,"default":"","displayOptions":{"show":{"resource":["opportunity"],"operation":["get"]}},"description":"ID of opportunity that needs to be fetched"},{"displayName":"Opportunity ID","name":"opportunityId","type":"string","required":true,"default":"","displayOptions":{"show":{"resource":["opportunity"],"operation":["delete"]}},"description":"ID of opportunity that needs to be fetched"},{"displayName":"Return All","name":"returnAll","type":"boolean","displayOptions":{"show":{"resource":["opportunity"],"operation":["getAll"]}},"default":false,"description":"Whether to return all results or only up to a given limit"},{"displayName":"Limit","name":"limit","type":"number","displayOptions":{"show":{"resource":["opportunity"],"operation":["getAll"],"returnAll":[false]}},"typeOptions":{"minValue":1,"maxValue":100},"default":50,"description":"Max number of results to return"},{"displayName":"Options","name":"options","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"resource":["opportunity"],"operation":["getAll"]}},"options":[{"displayName":"Conditions","name":"conditionsUi","placeholder":"Add Condition","type":"fixedCollection","typeOptions":{"multipleValues":true},"description":"The condition to set","default":{},"options":[{"name":"conditionValues","displayName":"Condition","values":[{"displayName":"Field Name or ID","name":"field","type":"options","typeOptions":{"loadOptionsMethod":"getOpportunityFields"},"default":"","description":"For date, number, or boolean, please use expressions. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Operation","name":"operation","type":"options","options":[{"name":"<","value":"<"},{"name":"<=","value":"<="},{"name":"=","value":"equal"},{"name":">","value":">"},{"name":">=","value":">="}],"default":"equal"},{"displayName":"Value","name":"value","type":"string","default":""}]}]},{"displayName":"Fields","name":"fields","type":"string","default":"","description":"Fields to include separated by ,"}]},{"displayName":"Opportunity ID","name":"opportunityId","type":"string","required":true,"default":"","displayOptions":{"show":{"resource":["opportunity"],"operation":["addNote"]}},"description":"ID of opportunity that needs to be fetched"},{"displayName":"Title","name":"title","type":"string","required":true,"default":"","displayOptions":{"show":{"resource":["opportunity"],"operation":["addNote"]}},"description":"Title of the note"},{"displayName":"Options","name":"options","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"resource":["opportunity"],"operation":["addNote"]}},"options":[{"displayName":"Body","name":"body","type":"string","default":"","description":"Body of the note. Limited to 32 KB."},{"displayName":"Is Private","name":"isPrivate","type":"boolean","default":false,"description":"Whether true, only the note owner or a user with the “Modify All Data” permission can view the note or query it via the API"},{"displayName":"Owner Name or ID","name":"owner","type":"options","typeOptions":{"loadOptionsMethod":"getUsers"},"default":"","description":"ID of the user who owns the note. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."}]},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["account"]}},"options":[{"name":"Add Note","value":"addNote","description":"Add note to an account","action":"Add a note to an account"},{"name":"Create","value":"create","description":"Create an account","action":"Create an account"},{"name":"Create or Update","value":"upsert","description":"Create a new account, or update the current one if it already exists (upsert)","action":"Create or update an account"},{"name":"Delete","value":"delete","description":"Delete an account","action":"Delete an account"},{"name":"Get","value":"get","description":"Get an account","action":"Get an account"},{"name":"Get Many","value":"getAll","description":"Get many accounts","action":"Get many accounts"},{"name":"Get Summary","value":"getSummary","description":"Returns an overview of account's metadata","action":"Get an account summary"},{"name":"Update","value":"update","description":"Update an account","action":"Update an account"}],"default":"create"},{"displayName":"Match Against","name":"externalId","type":"options","typeOptions":{"loadOptionsMethod":"getExternalIdFields","loadOptionsDependsOn":["resource"]},"required":true,"default":"","displayOptions":{"show":{"resource":["account"],"operation":["upsert"]}},"description":"The field to check to see if the account already exists. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Value to Match","name":"externalIdValue","type":"string","required":true,"default":"","displayOptions":{"show":{"resource":["account"],"operation":["upsert"]}},"description":"If this value exists in the 'match against' field, update the account. Otherwise create a new one."},{"displayName":"Name","name":"name","type":"string","required":true,"default":"","displayOptions":{"show":{"resource":["account"],"operation":["create","upsert"]}},"description":"Name of the account. Maximum size is 255 characters."},{"displayName":"Additional Fields","name":"additionalFields","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"resource":["account"],"operation":["create","upsert"]}},"options":[{"displayName":"Account Number","name":"accountNumber","type":"string","default":"","description":"Account number assigned to this account (not the unique ID). Maximum size is 40 characters."},{"displayName":"Annual Revenue","name":"annualRevenue","type":"number","typeOptions":{"numberPrecision":2},"default":"","description":"Estimated annual revenue of the account"},{"displayName":"Account Source Name or ID","name":"accountSource","type":"options","typeOptions":{"loadOptionsMethod":"getAccountSources"},"default":"","description":"The source of the account record. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Billing City","name":"billingCity","type":"string","default":"","description":"Details for the billing address of this account. Maximum size is 40 characters."},{"displayName":"Billing Country","name":"billingCountry","type":"string","default":"","description":"Details for the billing address of this account. Maximum size is 80 characters."},{"displayName":"Billing Postal Code","name":"billingPostalCode","type":"string","default":"","description":"Details for the billing address of this account. Maximum size is 20 characters."},{"displayName":"Billing State","name":"billingState","type":"string","default":"","description":"Details for the billing address of this account. Maximum size is 80 characters."},{"displayName":"Billing Street","name":"billingStreet","type":"string","default":"","description":"Street address for the billing address of this account"},{"displayName":"Custom Fields","name":"customFieldsUi","placeholder":"Add Custom Field","type":"fixedCollection","typeOptions":{"multipleValues":true},"description":"Filter by custom fields","default":{},"options":[{"name":"customFieldsValues","displayName":"Custom Field","values":[{"displayName":"Field Name or ID","name":"fieldId","type":"options","typeOptions":{"loadOptionsMethod":"getCustomFields"},"default":"","description":"The ID of the field to add custom field to. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Value","name":"value","type":"string","default":"","description":"The value to set on custom field"}]}]},{"displayName":"Description","name":"description","type":"string","default":"","description":"Text description of the account. Limited to 32,000 KB."},{"displayName":"Fax","name":"fax","type":"string","default":"","description":"Fax number for the account"},{"displayName":"Jigsaw","name":"jigsaw","type":"string","default":"","description":"References the ID of a company in Data.com"},{"displayName":"Industry","name":"industry","type":"string","default":"","description":"The website of this account. Maximum of 255 characters."},{"displayName":"Number Of Employees","name":"numberOfEmployees","type":"number","default":""},{"displayName":"Owner Name or ID","name":"owner","type":"options","typeOptions":{"loadOptionsMethod":"getUsers"},"default":"","description":"The owner of the account. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Parent ID","name":"parentId","type":"string","default":"","description":"ID of the parent object, if any"},{"displayName":"Phone","name":"phone","type":"string","default":"","description":"Phone number for the account"},{"displayName":"Record Type Name or ID","name":"recordTypeId","type":"options","description":"Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>","typeOptions":{"loadOptionsMethod":"getRecordTypes"},"default":""},{"displayName":"SicDesc","name":"sicDesc","type":"string","default":"","description":"A brief description of an organization’s line of business, based on its SIC code"},{"displayName":"Type Name or ID","name":"type","type":"options","default":"","typeOptions":{"loadOptionsMethod":"getAccountTypes"},"description":"Type of account. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Shipping City","name":"shippingCity","type":"string","default":"","description":"Details of the shipping address for this account. City maximum size is 40 characters."},{"displayName":"Shipping Country","name":"shippingCountry","type":"string","default":"","description":"Details of the shipping address for this account. Country maximum size is 80 characters."},{"displayName":"Shipping Postal Code","name":"shippingPostalCode","type":"string","default":"","description":"Details of the shipping address for this account. Postal code maximum size is 20 characters."},{"displayName":"Shipping State","name":"shippingState","type":"string","default":"","description":"Details of the shipping address for this account. State maximum size is 80 characters."},{"displayName":"Shipping Street","name":"shippingStreet","type":"string","default":"","description":"The street address of the shipping address for this account. Maximum of 255 characters."},{"displayName":"Website","name":"website","type":"string","default":"","description":"The website of this account. Maximum of 255 characters."}]},{"displayName":"Account ID","name":"accountId","type":"string","required":true,"default":"","displayOptions":{"show":{"resource":["account"],"operation":["update"]}},"description":"ID of account that needs to be fetched"},{"displayName":"Update Fields","name":"updateFields","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"resource":["account"],"operation":["update"]}},"options":[{"displayName":"Account Number","name":"accountNumber","type":"string","default":"","description":"Account number assigned to this account (not the unique ID). Maximum size is 40 characters."},{"displayName":"Account Source Name or ID","name":"accountSource","type":"options","typeOptions":{"loadOptionsMethod":"getAccountSources"},"default":"","description":"The source of the account record. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Annual Revenue","name":"annualRevenue","type":"number","typeOptions":{"numberPrecision":2},"default":"","description":"Estimated annual revenue of the account"},{"displayName":"Billing City","name":"billingCity","type":"string","default":"","description":"Details for the billing address of this account. Maximum size is 40 characters."},{"displayName":"Billing Country","name":"billingCountry","type":"string","default":"","description":"Details for the billing address of this account. Maximum size is 80 characters."},{"displayName":"Billing Postal Code","name":"billingPostalCode","type":"string","default":"","description":"Details for the billing address of this account. Maximum size is 20 characters."},{"displayName":"Billing State","name":"billingState","type":"string","default":"","description":"Details for the billing address of this account. Maximum size is 80 characters."},{"displayName":"Billing Street","name":"billingStreet","type":"string","default":"","description":"Street address for the billing address of this account"},{"displayName":"Custom Fields","name":"customFieldsUi","placeholder":"Add Custom Field","type":"fixedCollection","typeOptions":{"multipleValues":true},"description":"Filter by custom fields","default":{},"options":[{"name":"customFieldsValues","displayName":"Custom Field","values":[{"displayName":"Field Name or ID","name":"fieldId","type":"options","typeOptions":{"loadOptionsMethod":"getCustomFields"},"default":"","description":"The ID of the field to add custom field to. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Value","name":"value","type":"string","default":"","description":"The value to set on custom field"}]}]},{"displayName":"Description","name":"description","type":"string","default":"","description":"Text description of the account. Limited to 32,000 KB."},{"displayName":"Fax","name":"fax","type":"string","default":"","description":"Fax number for the account"},{"displayName":"Industry","name":"industry","type":"string","default":"","description":"The website of this account. Maximum of 255 characters."},{"displayName":"Jigsaw","name":"jigsaw","type":"string","default":"","description":"References the ID of a company in Data.com"},{"displayName":"Name","name":"name","type":"string","default":"","description":"Name of the account. Maximum size is 255 characters."},{"displayName":"Number Of Employees","name":"numberOfEmployees","type":"number","default":""},{"displayName":"Owner Name or ID","name":"ownerId","type":"options","typeOptions":{"loadOptionsMethod":"getUsers"},"default":"","description":"The owner of the account. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Parent ID","name":"parentId","type":"string","default":"","description":"ID of the parent object, if any"},{"displayName":"Phone","name":"phone","type":"string","default":"","description":"Phone number for the account"},{"displayName":"Record Type Name or ID","name":"recordTypeId","type":"options","description":"Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>","typeOptions":{"loadOptionsMethod":"getRecordTypes"},"default":""},{"displayName":"SicDesc","name":"sicDesc","type":"string","default":"","description":"A brief description of an organization’s line of business, based on its SIC code"},{"displayName":"Shipping City","name":"shippingCity","type":"string","default":"","description":"Details of the shipping address for this account. City maximum size is 40 characters."},{"displayName":"Shipping Country","name":"shippingCountry","type":"string","default":"","description":"Details of the shipping address for this account. Country maximum size is 80 characters."},{"displayName":"Shipping Postal Code","name":"shippingPostalCode","type":"string","default":"","description":"Details of the shipping address for this account. Postal code maximum size is 20 characters."},{"displayName":"Shipping State","name":"shippingState","type":"string","default":"","description":"Details of the shipping address for this account. State maximum size is 80 characters."},{"displayName":"Shipping Street","name":"shippingStreet","type":"string","default":"","description":"The street address of the shipping address for this account. Maximum of 255 characters."},{"displayName":"Type Name or ID","name":"type","type":"options","default":"","typeOptions":{"loadOptionsMethod":"getAccountTypes"},"description":"Type of account. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Website","name":"website","type":"string","default":"","description":"The website of this account. Maximum of 255 characters."}]},{"displayName":"Account ID","name":"accountId","type":"string","required":true,"default":"","displayOptions":{"show":{"resource":["account"],"operation":["get"]}},"description":"ID of account that needs to be fetched"},{"displayName":"Account ID","name":"accountId","type":"string","required":true,"default":"","displayOptions":{"show":{"resource":["account"],"operation":["delete"]}},"description":"ID of account that needs to be fetched"},{"displayName":"Return All","name":"returnAll","type":"boolean","displayOptions":{"show":{"resource":["account"],"operation":["getAll"]}},"default":false,"description":"Whether to return all results or only up to a given limit"},{"displayName":"Limit","name":"limit","type":"number","displayOptions":{"show":{"resource":["account"],"operation":["getAll"],"returnAll":[false]}},"typeOptions":{"minValue":1,"maxValue":100},"default":50,"description":"Max number of results to return"},{"displayName":"Options","name":"options","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"resource":["account"],"operation":["getAll"]}},"options":[{"displayName":"Fields","name":"fields","type":"string","default":"","description":"Fields to include separated by ,"},{"displayName":"Conditions","name":"conditionsUi","placeholder":"Add Condition","type":"fixedCollection","typeOptions":{"multipleValues":true},"description":"The condition to set","default":{},"options":[{"name":"conditionValues","displayName":"Condition","values":[{"displayName":"Field Name or ID","name":"field","type":"options","typeOptions":{"loadOptionsMethod":"getAccountFields"},"default":"","description":"For date, number, or boolean, please use expressions. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"options":[{"name":"<","value":"<"},{"name":"<=","value":"<="},{"name":"=","value":"equal"},{"name":">","value":">"},{"name":">=","value":">="}],"default":"equal"},{"displayName":"Value","name":"value","type":"string","default":""}]}]}]},{"displayName":"Account ID","name":"accountId","type":"string","required":true,"default":"","displayOptions":{"show":{"resource":["account"],"operation":["addNote"]}},"description":"ID of account that needs to be fetched"},{"displayName":"Title","name":"title","type":"string","required":true,"default":"","displayOptions":{"show":{"resource":["account"],"operation":["addNote"]}},"description":"Title of the note"},{"displayName":"Options","name":"options","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"resource":["account"],"operation":["addNote"]}},"options":[{"displayName":"Body","name":"body","type":"string","default":"","description":"Body of the note. Limited to 32 KB."},{"displayName":"Is Private","name":"isPrivate","type":"boolean","default":false,"description":"Whether true, only the note owner or a user with the “Modify All Data” permission can view the note or query it via the API"},{"displayName":"Owner Name or ID","name":"ownerId","type":"options","typeOptions":{"loadOptionsMethod":"getUsers"},"default":"","description":"ID of the user who owns the note. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."}]},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["search"]}},"options":[{"name":"Query","value":"query","description":"Execute a SOQL query that returns all the results in a single response","action":"Perform a query"}],"default":"query"},{"displayName":"Query","name":"query","type":"string","required":true,"default":"","displayOptions":{"show":{"resource":["search"],"operation":["query"]}},"description":"A SOQL query. An example query parameter string might look like: “SELECT+Name+FROM+MyObject”. If the SOQL query string is invalid, a MALFORMED_QUERY response is returned."},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["case"]}},"options":[{"name":"Add Comment","value":"addComment","description":"Add a comment to a case","action":"Add a comment to a case"},{"name":"Create","value":"create","description":"Create a case","action":"Create a case"},{"name":"Delete","value":"delete","description":"Delete a case","action":"Delete a case"},{"name":"Get","value":"get","description":"Get a case","action":"Get a case"},{"name":"Get Many","value":"getAll","description":"Get many cases","action":"Get many cases"},{"name":"Get Summary","value":"getSummary","description":"Returns an overview of case's metadata","action":"Get a case summary"},{"name":"Update","value":"update","description":"Update a case","action":"Update a case"}],"default":"create"},{"displayName":"Type Name or ID","name":"type","type":"options","required":true,"typeOptions":{"loadOptionsMethod":"getCaseTypes"},"displayOptions":{"show":{"resource":["case"],"operation":["create"]}},"default":"","description":"The type of case. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Additional Fields","name":"additionalFields","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"resource":["case"],"operation":["create"]}},"options":[{"displayName":"Account ID","name":"accountId","type":"string","default":"","description":"ID of the account associated with this case"},{"displayName":"Contact ID","name":"contactId","type":"string","default":"","description":"ID of the associated Contact"},{"displayName":"Custom Fields","name":"customFieldsUi","placeholder":"Add Custom Field","type":"fixedCollection","typeOptions":{"multipleValues":true},"description":"Filter by custom fields","default":{},"options":[{"name":"customFieldsValues","displayName":"Custom Field","values":[{"displayName":"Field Name or ID","name":"fieldId","type":"options","typeOptions":{"loadOptionsMethod":"getCustomFields"},"default":"","description":"The ID of the field to add custom field to. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Value","name":"value","type":"string","default":"","description":"The value to set on custom field"}]}]},{"displayName":"Description","name":"description","type":"string","default":"","description":"A text description of the case. Limit: 32 KB."},{"displayName":"Is Escalated","name":"isEscalated","type":"boolean","default":false,"description":"Whether indicates whether the case has been escalated (true) or not"},{"displayName":"Origin Name or ID","name":"origin","type":"options","typeOptions":{"loadOptionsMethod":"getCaseOrigins"},"default":"","description":"The source of the case, such as Email, Phone, or Web. Label is Case Origin. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Owner Name or ID","name":"owner","type":"options","typeOptions":{"loadOptionsMethod":"getCaseOwners"},"default":"","description":"The owner of the case. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Parent ID","name":"ParentId","type":"string","default":"","description":"The ID of the parent case in the hierarchy. The label is Parent Case."},{"displayName":"Priority Name or ID","name":"priority","type":"options","typeOptions":{"loadOptionsMethod":"getCasePriorities"},"default":"","description":"The importance or urgency of the case, such as High, Medium, or Low. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Reason Name or ID","name":"reason","type":"options","typeOptions":{"loadOptionsMethod":"getCaseReasons"},"default":"","description":"The reason why the case was created, such as Instructions not clear, or User didn’t attend training. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Record Type Name or ID","name":"recordTypeId","type":"options","description":"Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>","typeOptions":{"loadOptionsMethod":"getRecordTypes"},"default":""},{"displayName":"Status Name or ID","name":"status","type":"options","typeOptions":{"loadOptionsMethod":"getCaseStatuses"},"default":"","description":"The status of the case, such as “New,” “Closed,” or “Escalated.” This field directly controls the IsClosed flag. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Subject","name":"subject","type":"string","default":"","description":"The subject of the case. Limit: 255 characters."},{"displayName":"Supplied Company","name":"suppliedCompany","type":"string","default":"","description":"The company name that was entered when the case was created. This field can't be updated after the case has been created.."},{"displayName":"Supplied Email","name":"suppliedEmail","type":"string","default":"","description":"The email address that was entered when the case was created. This field can't be updated after the case has been created."},{"displayName":"Supplied Name","name":"suppliedName","type":"string","default":"","description":"The name that was entered when the case was created. This field can't be updated after the case has been created."},{"displayName":"Supplied Phone","name":"suppliedPhone","type":"string","default":"","description":"The phone number that was entered when the case was created. This field can't be updated after the case has been created."}]},{"displayName":"Case ID","name":"caseId","type":"string","required":true,"default":"","displayOptions":{"show":{"resource":["case"],"operation":["update"]}},"description":"ID of case that needs to be fetched"},{"displayName":"Update Fields","name":"updateFields","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"resource":["case"],"operation":["update"]}},"options":[{"displayName":"Account ID","name":"accountId","type":"string","default":"","description":"ID of the account associated with this case"},{"displayName":"Contact ID","name":"contactId","type":"string","default":"","description":"ID of the associated Contact"},{"displayName":"Custom Fields","name":"customFieldsUi","placeholder":"Add Custom Field","type":"fixedCollection","typeOptions":{"multipleValues":true},"description":"Filter by custom fields","default":{},"options":[{"name":"customFieldsValues","displayName":"Custom Field","values":[{"displayName":"Field Name or ID","name":"fieldId","type":"options","typeOptions":{"loadOptionsMethod":"getCustomFields"},"default":"","description":"The ID of the field to add custom field to. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Value","name":"value","type":"string","default":"","description":"The value to set on custom field"}]}]},{"displayName":"Description","name":"description","type":"string","default":"","description":"A text description of the case. Limit: 32 KB."},{"displayName":"Is Escalated","name":"isEscalated","type":"boolean","default":false,"description":"Whether the case has been escalated (true) or not"},{"displayName":"Origin Name or ID","name":"origin","type":"options","typeOptions":{"loadOptionsMethod":"getCaseOrigins"},"default":"","description":"The source of the case, such as Email, Phone, or Web. Label is Case Origin. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Owner Name or ID","name":"owner","type":"options","typeOptions":{"loadOptionsMethod":"getCaseOwners"},"default":"","description":"The owner of the case. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Parent ID","name":"ParentId","type":"string","default":"","description":"The ID of the parent case in the hierarchy. The label is Parent Case."},{"displayName":"Priority Name or ID","name":"priority","type":"options","typeOptions":{"loadOptionsMethod":"getCasePriorities"},"default":"","description":"The importance or urgency of the case, such as High, Medium, or Low. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Reason Name or ID","name":"reason","type":"options","typeOptions":{"loadOptionsMethod":"getCaseReasons"},"default":"","description":"The reason why the case was created, such as Instructions not clear, or User didn’t attend training. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Record Type Name or ID","name":"recordTypeId","type":"options","description":"Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>","typeOptions":{"loadOptionsMethod":"getRecordTypes"},"default":""},{"displayName":"Status Name or ID","name":"status","type":"options","typeOptions":{"loadOptionsMethod":"getCaseStatuses"},"default":"","description":"The status of the case, such as “New,” “Closed,” or “Escalated.” This field directly controls the IsClosed flag. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Subject","name":"subject","type":"string","default":"","description":"The subject of the case. Limit: 255 characters."},{"displayName":"Supplied Company","name":"suppliedCompany","type":"string","default":"","description":"The company name that was entered when the case was created. This field can't be updated after the case has been created.."},{"displayName":"Supplied Email","name":"suppliedEmail","type":"string","default":"","description":"The email address that was entered when the case was created. This field can't be updated after the case has been created."},{"displayName":"Supplied Name","name":"suppliedName","type":"string","default":"","description":"The name that was entered when the case was created. This field can't be updated after the case has been created."},{"displayName":"Supplied Phone","name":"suppliedPhone","type":"string","default":"","description":"The phone number that was entered when the case was created. This field can't be updated after the case has been created."},{"displayName":"Type Name or ID","name":"type","type":"options","typeOptions":{"loadOptionsMethod":"getCaseTypes"},"default":"","description":"The type of case. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."}]},{"displayName":"Case ID","name":"caseId","type":"string","required":true,"default":"","displayOptions":{"show":{"resource":["case"],"operation":["get"]}},"description":"ID of case that needs to be fetched"},{"displayName":"Case ID","name":"caseId","type":"string","required":true,"default":"","displayOptions":{"show":{"resource":["case"],"operation":["delete"]}},"description":"ID of case that needs to be fetched"},{"displayName":"Return All","name":"returnAll","type":"boolean","displayOptions":{"show":{"resource":["case"],"operation":["getAll"]}},"default":false,"description":"Whether to return all results or only up to a given limit"},{"displayName":"Limit","name":"limit","type":"number","displayOptions":{"show":{"resource":["case"],"operation":["getAll"],"returnAll":[false]}},"typeOptions":{"minValue":1,"maxValue":100},"default":50,"description":"Max number of results to return"},{"displayName":"Options","name":"options","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"resource":["case"],"operation":["getAll"]}},"options":[{"displayName":"Conditions","name":"conditionsUi","placeholder":"Add Condition","type":"fixedCollection","typeOptions":{"multipleValues":true},"description":"The condition to set","default":{},"options":[{"name":"conditionValues","displayName":"Condition","values":[{"displayName":"Field Name or ID","name":"field","type":"options","typeOptions":{"loadOptionsMethod":"getCaseFields"},"default":"","description":"For date, number, or boolean, please use expressions. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Operation","name":"operation","type":"options","options":[{"name":"<","value":"<"},{"name":"<=","value":"<="},{"name":"=","value":"equal"},{"name":">","value":">"},{"name":">=","value":">="}],"default":"equal"},{"displayName":"Value","name":"value","type":"string","default":""}]}]},{"displayName":"Fields","name":"fields","type":"string","default":"","description":"Fields to include separated by ,"}]},{"displayName":"Case ID","name":"caseId","type":"string","required":true,"default":"","displayOptions":{"show":{"resource":["case"],"operation":["addComment"]}},"description":"ID of case that needs to be fetched"},{"displayName":"Options","name":"options","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"resource":["case"],"operation":["addComment"]}},"options":[{"displayName":"Comment Body","name":"commentBody","type":"string","default":"","description":"Text of the CaseComment. The maximum size of the comment body is 4,000 bytes. Label is Body."},{"displayName":"Is Published","name":"isPublished","type":"boolean","default":false,"description":"Whether the CaseComment is visible to customers in the Self-Service portal (true) or not (false)"}]},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["task"]}},"options":[{"name":"Create","value":"create","description":"Create a task","action":"Create a task"},{"name":"Delete","value":"delete","description":"Delete a task","action":"Delete a task"},{"name":"Get","value":"get","description":"Get a task","action":"Get a task"},{"name":"Get Many","value":"getAll","description":"Get many tasks","action":"Get many tasks"},{"name":"Get Summary","value":"getSummary","description":"Returns an overview of task's metadata","action":"Get a task summary"},{"name":"Update","value":"update","description":"Update a task","action":"Update a task"}],"default":"create"},{"displayName":"Status Name or ID","name":"status","type":"options","required":true,"default":"","displayOptions":{"show":{"resource":["task"],"operation":["create"]}},"typeOptions":{"loadOptionsMethod":"getTaskStatuses"},"description":"The current status of the task, such as In Progress or Completed. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Additional Fields","name":"additionalFields","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"resource":["task"],"operation":["create"]}},"options":[{"displayName":"Activity Date","name":"activityDate","type":"dateTime","default":"","description":"Represents the due date of the task. This field has a timestamp that is always set to midnight in the Coordinated Universal Time (UTC) time zone."},{"displayName":"Call Disposition","name":"callDisposition","type":"string","default":"","description":"Represents the result of a given call, for example, “we'll call back,” or “call unsuccessful.” Limit is 255 characters. Not subject to field-level security, available for any user in an organization with Salesforce CRM Call Center."},{"displayName":"Call Duration In Seconds","name":"callDurationInSeconds","type":"number","default":"","description":"Duration of the call in seconds. Not subject to field-level security, available for any user in an organization with Salesforce CRM Call Center."},{"displayName":"Call Object","name":"callObject","type":"string","default":"","description":"Name of a call center. Limit is 255 characters. Not subject to field-level security, available for any user in an organization with Salesforce CRM Call Center."},{"displayName":"Call Type Name or ID","name":"callType","type":"options","default":"","typeOptions":{"loadOptionsMethod":"getTaskCallTypes"},"description":"The type of call being answered: Inbound, Internal, or Outbound. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Custom Fields","name":"customFieldsUi","placeholder":"Add Custom Field","type":"fixedCollection","typeOptions":{"multipleValues":true},"description":"Filter by custom fields","default":{},"options":[{"name":"customFieldsValues","displayName":"Custom Field","values":[{"displayName":"Field Name or ID","name":"fieldId","type":"options","typeOptions":{"loadOptionsMethod":"getCustomFields"},"default":"","description":"The ID of the field to add custom field to. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Value","name":"value","type":"string","default":"","description":"The value to set on custom field"}]}]},{"displayName":"Description","name":"description","type":"string","default":"","description":"Contains a text description of the task"},{"displayName":"Is ReminderSet","name":"isReminderSet","type":"boolean","default":false,"description":"Whether a popup reminder has been set for the task (true) or not (false)"},{"displayName":"Owner Name or ID","name":"owner","type":"options","typeOptions":{"loadOptionsMethod":"getUsers"},"default":"","description":"ID of the User who owns the record. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Priority Name or ID","name":"priority","type":"options","default":"","typeOptions":{"loadOptionsMethod":"getTaskPriorities"},"description":"Indicates the importance or urgency of a task, such as high or low. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Recurrence Type Name or ID","name":"recurrenceType","type":"options","default":"","typeOptions":{"loadOptionsMethod":"getTaskRecurrenceTypes"},"description":"Recurrence Type of the task. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Recurrence Instance Name or ID","name":"recurrenceInstance","type":"options","typeOptions":{"loadOptionsMethod":"getTaskRecurrenceInstances"},"default":"","description":"The frequency of the recurring task. For example, “2nd” or “3rd.”. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Recurrence Interval","name":"recurrenceInterval","type":"number","default":"","description":"The interval between recurring tasks"},{"displayName":"Recurrence Day Of Month","name":"recurrenceDayOfMonth","type":"number","default":"","description":"The day of the month in which the task repeats"},{"displayName":"Recurrence Day Of Week Mask","name":"recurrenceDayOfWeekMask","type":"number","default":"","description":"The day or days of the week on which the task repeats. This field contains a bitmask. The values are as follows: Sunday = 1 Monday = 2 Tuesday = 4 Wednesday = 8 Thursday = 16 Friday = 32 Saturday = 64 Multiple days are represented as the sum of their numerical values. For example, Tuesday and Thursday = 4 + 16 = 20."},{"displayName":"Recurrence End Date Only","name":"recurrenceEndDateOnly","type":"dateTime","default":"","description":"The last date on which the task repeats. This field has a timestamp that is always set to midnight in the Coordinated Universal Time (UTC) time zone."},{"displayName":"Recurrence Month Of Year","name":"recurrenceMonthOfYear","type":"options","options":[{"name":"January","value":"January"},{"name":"February","value":"February"},{"name":"March","value":"March"},{"name":"April","value":"April"},{"name":"May","value":"May"},{"name":"June","value":"June"},{"name":"July","value":"July"},{"name":"August","value":"August"},{"name":"September","value":"September"},{"name":"October","value":"October"},{"name":"November","value":"November"},{"name":"December","value":"December"}],"default":"","description":"The month of the year in which the task repeats"},{"displayName":"Recurrence Regenerated Type","name":"recurrenceRegeneratedType","type":"options","default":"","options":[{"name":"After Due Date","value":"RecurrenceRegenerateAfterDueDate"},{"name":"After Date Completed","value":"RecurrenceRegenerateAfterToday"},{"name":"(Task Closed)","value":"RecurrenceRegenerated"}],"description":"Represents what triggers a repeating task to repeat. Add this field to a page layout together with the RecurrenceInterval field, which determines the number of days between the triggering date (due date or close date) and the due date of the next repeating task in the series. Label is Repeat This Task."},{"displayName":"Recurrence Start Date Only","name":"recurrenceEndDateOnly","type":"dateTime","default":"","description":"The date when the recurring task begins. Must be a date and time before RecurrenceEndDateOnly."},{"displayName":"Recurrence TimeZone SidKey","name":"recurrenceTimeZoneSidKey","type":"string","default":"","description":"The time zone associated with the recurring task. For example, “UTC-8:00” for Pacific Standard Time."},{"displayName":"Reminder Date Time","name":"reminderDateTime","type":"dateTime","default":"","description":"Represents the time when the reminder is scheduled to fire, if IsReminderSet is set to true. If IsReminderSet is set to false, then the user may have deselected the reminder checkbox in the Salesforce user interface, or the reminder has already fired at the time indicated by the value."},{"displayName":"Subject Name or ID","name":"subject","type":"options","default":"","typeOptions":{"loadOptionsMethod":"getTaskSubjects"},"description":"The subject line of the task, such as “Call” or “Send Quote.” Limit: 255 characters. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Type Name or ID","name":"type","type":"options","default":"","typeOptions":{"loadOptionsMethod":"getTaskTypes"},"description":"Represents Type of the task, such as Call or Meeting. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"What ID","name":"whatId","type":"string","default":"","description":"The WhatId represents nonhuman objects such as accounts, opportunities, campaigns, cases, or custom objects. WhatIds are polymorphic. Polymorphic means a WhatId is equivalent to the ID of a related object."},{"displayName":"Who ID","name":"whoId","type":"string","default":"","description":"The WhoId represents a human such as a lead or a contact. WhoIds are polymorphic. Polymorphic means a WhoId is equivalent to a contact’s ID or a lead’s ID."}]},{"displayName":"Task ID","name":"taskId","type":"string","required":true,"default":"","displayOptions":{"show":{"resource":["task"],"operation":["update"]}},"description":"ID of task that needs to be fetched"},{"displayName":"Update Fields","name":"updateFields","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"resource":["task"],"operation":["update"]}},"options":[{"displayName":"Activity Date","name":"activityDate","type":"dateTime","default":"","description":"Represents the due date of the task. This field has a timestamp that is always set to midnight in the Coordinated Universal Time (UTC) time zone."},{"displayName":"Call Disposition","name":"callDisposition","type":"string","default":"","description":"Represents the result of a given call, for example, “we'll call back,” or “call unsuccessful.” Limit is 255 characters. Not subject to field-level security, available for any user in an organization with Salesforce CRM Call Center."},{"displayName":"Call Duration In Seconds","name":"callDurationInSeconds","type":"number","default":"","description":"Duration of the call in seconds. Not subject to field-level security, available for any user in an organization with Salesforce CRM Call Center."},{"displayName":"Call Object","name":"callObject","type":"string","default":"","description":"Name of a call center. Limit is 255 characters. Not subject to field-level security, available for any user in an organization with Salesforce CRM Call Center."},{"displayName":"Call Type Name or ID","name":"callType","type":"options","default":"","typeOptions":{"loadOptionsMethod":"getTaskCallTypes"},"description":"The type of call being answered: Inbound, Internal, or Outbound. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Custom Fields","name":"customFieldsUi","placeholder":"Add Custom Field","type":"fixedCollection","typeOptions":{"multipleValues":true},"description":"Filter by custom fields","default":{},"options":[{"name":"customFieldsValues","displayName":"Custom Field","values":[{"displayName":"Field Name or ID","name":"fieldId","type":"options","typeOptions":{"loadOptionsMethod":"getCustomFields"},"default":"","description":"The ID of the field to add custom field to. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Value","name":"value","type":"string","default":"","description":"The value to set on custom field"}]}]},{"displayName":"Description","name":"description","type":"string","default":"","description":"Contains a text description of the task"},{"displayName":"Is ReminderSet","name":"isReminderSet","type":"boolean","default":false,"description":"Whether a popup reminder has been set for the task (true) or not (false)"},{"displayName":"Owner Name or ID","name":"owner","type":"options","typeOptions":{"loadOptionsMethod":"getUsers"},"default":"","description":"ID of the User who owns the record. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Priority Name or ID","name":"priority","type":"options","default":"","typeOptions":{"loadOptionsMethod":"getTaskPriorities"},"description":"Indicates the importance or urgency of a task, such as high or low. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Status Name or ID","name":"status","type":"options","default":"","typeOptions":{"loadOptionsMethod":"getTaskStatuses"},"description":"The current status of the task, such as In Progress or Completed. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Subject Name or ID","name":"subject","type":"options","default":"","typeOptions":{"loadOptionsMethod":"getTaskSubjects"},"description":"The subject line of the task, such as “Call” or “Send Quote.” Limit: 255 characters. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Recurrence Day Of Month","name":"recurrenceDayOfMonth","type":"number","default":"","description":"The day of the month in which the task repeats"},{"displayName":"Recurrence Day Of Week Mask","name":"recurrenceDayOfWeekMask","type":"number","default":"","description":"The day or days of the week on which the task repeats. This field contains a bitmask. The values are as follows: Sunday = 1 Monday = 2 Tuesday = 4 Wednesday = 8 Thursday = 16 Friday = 32 Saturday = 64. Multiple days are represented as the sum of their numerical values. For example, Tuesday and Thursday = 4 + 16 = 20."},{"displayName":"Recurrence End Date Only","name":"recurrenceEndDateOnly","type":"dateTime","default":"","description":"The last date on which the task repeats. This field has a timestamp that is always set to midnight in the Coordinated Universal Time (UTC) time zone."},{"displayName":"Recurrence Instance Name or ID","name":"recurrenceInstance","type":"options","typeOptions":{"loadOptionsMethod":"getTaskRecurrenceInstances"},"default":"","description":"The frequency of the recurring task. For example, “2nd” or “3rd.”. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Recurrence Interval","name":"recurrenceInterval","type":"number","default":"","description":"The interval between recurring tasks"},{"displayName":"Recurrence Month Of Year","name":"recurrenceMonthOfYear","type":"options","options":[{"name":"January","value":"January"},{"name":"February","value":"February"},{"name":"March","value":"March"},{"name":"April","value":"April"},{"name":"May","value":"May"},{"name":"June","value":"June"},{"name":"July","value":"July"},{"name":"August","value":"August"},{"name":"September","value":"September"},{"name":"October","value":"October"},{"name":"November","value":"November"},{"name":"December","value":"December"}],"default":"","description":"The month of the year in which the task repeats"},{"displayName":"Recurrence Start Date Only","name":"recurrenceEndDateOnly","type":"dateTime","default":"","description":"The date when the recurring task begins. Must be a date and time before RecurrenceEndDateOnly."},{"displayName":"Recurrence Regenerated Type","name":"recurrenceRegeneratedType","type":"options","default":"","options":[{"name":"After Due Date","value":"RecurrenceRegenerateAfterDueDate"},{"name":"After Date Completed","value":"RecurrenceRegenerateAfterToday"},{"name":"(Task Closed)","value":"RecurrenceRegenerated"}],"description":"Represents what triggers a repeating task to repeat. Add this field to a page layout together with the RecurrenceInterval field, which determines the number of days between the triggering date (due date or close date) and the due date of the next repeating task in the series. Label is Repeat This Task."},{"displayName":"Recurrence Type Name or ID","name":"recurrenceType","type":"options","default":"","typeOptions":{"loadOptionsMethod":"getTaskRecurrenceTypes"},"description":"Website for the task. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Recurrence TimeZone SidKey","name":"recurrenceTimeZoneSidKey","type":"string","default":"","description":"The time zone associated with the recurring task. For example, “UTC-8:00” for Pacific Standard Time."},{"displayName":"Reminder Date Time","name":"reminderDateTime","type":"dateTime","default":"","description":"Represents the time when the reminder is scheduled to fire, if IsReminderSet is set to true. If IsReminderSet is set to false, then the user may have deselected the reminder checkbox in the Salesforce user interface, or the reminder has already fired at the time indicated by the value."},{"displayName":"Type Name or ID","name":"type","type":"options","default":"","typeOptions":{"loadOptionsMethod":"getTaskTypes"},"description":"Represents Type of the task, such as Call or Meeting. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"What ID","name":"whatId","type":"string","default":"","description":"The WhatId represents nonhuman objects such as accounts, opportunities, campaigns, cases, or custom objects. WhatIds are polymorphic. Polymorphic means a WhatId is equivalent to the ID of a related object."},{"displayName":"Who ID","name":"whoId","type":"string","default":"","description":"The WhoId represents a human such as a lead or a contact. WhoIds are polymorphic. Polymorphic means a WhoId is equivalent to a contact’s ID or a lead’s ID."}]},{"displayName":"Task ID","name":"taskId","type":"string","required":true,"default":"","displayOptions":{"show":{"resource":["task"],"operation":["get"]}},"description":"ID of task that needs to be fetched"},{"displayName":"Task ID","name":"taskId","type":"string","required":true,"default":"","displayOptions":{"show":{"resource":["task"],"operation":["delete"]}},"description":"ID of task that needs to be fetched"},{"displayName":"Return All","name":"returnAll","type":"boolean","displayOptions":{"show":{"resource":["task"],"operation":["getAll"]}},"default":false,"description":"Whether to return all results or only up to a given limit"},{"displayName":"Limit","name":"limit","type":"number","displayOptions":{"show":{"resource":["task"],"operation":["getAll"],"returnAll":[false]}},"typeOptions":{"minValue":1,"maxValue":100},"default":50,"description":"Max number of results to return"},{"displayName":"Options","name":"options","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"resource":["task"],"operation":["getAll"]}},"options":[{"displayName":"Conditions","name":"conditionsUi","placeholder":"Add Condition","type":"fixedCollection","typeOptions":{"multipleValues":true},"description":"The condition to set","default":{},"options":[{"name":"conditionValues","displayName":"Condition","values":[{"displayName":"Field Name or ID","name":"field","type":"options","typeOptions":{"loadOptionsMethod":"getTaskFields"},"default":"","description":"For date, number, or boolean, please use expressions. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Operation","name":"operation","type":"options","options":[{"name":"<","value":"<"},{"name":"<=","value":"<="},{"name":"=","value":"equal"},{"name":">","value":">"},{"name":">=","value":">="}],"default":"equal"},{"displayName":"Value","name":"value","type":"string","default":""}]}]},{"displayName":"Fields","name":"fields","type":"string","default":"","description":"Fields to include separated by ,"}]},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["attachment"]}},"options":[{"name":"Create","value":"create","description":"Create a attachment","action":"Create an attachment"},{"name":"Delete","value":"delete","description":"Delete a attachment","action":"Delete an attachment"},{"name":"Get","value":"get","description":"Get a attachment","action":"Get an attachment"},{"name":"Get Many","value":"getAll","description":"Get many attachments","action":"Get many attachments"},{"name":"Get Summary","value":"getSummary","description":"Returns an overview of attachment's metadata","action":"Get an attachment summary"},{"name":"Update","value":"update","description":"Update a attachment","action":"Update an attachment"}],"default":"create"},{"displayName":"Parent ID","name":"parentId","type":"string","default":"","required":true,"displayOptions":{"show":{"resource":["attachment"],"operation":["create"]}}},{"displayName":"Name","name":"name","type":"string","default":"","required":true,"displayOptions":{"show":{"resource":["attachment"],"operation":["create"]}},"description":"Required. Name of the attached file. Maximum size is 255 characters. Label is File Name."},{"displayName":"Binary Property","name":"binaryPropertyName","type":"string","default":"data","required":true,"displayOptions":{"show":{"resource":["attachment"],"operation":["create"]}},"placeholder":"","description":"Name of the binary property which contains the data for the file to be uploaded"},{"displayName":"Additional Fields","name":"additionalFields","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"resource":["attachment"],"operation":["create"]}},"options":[{"displayName":"Description","name":"description","type":"string","default":"","description":"Text description of the Document. Limit: 255 characters."},{"displayName":"Is Private","name":"isPrivate","type":"boolean","default":false,"description":"Whether this record is viewable only by the owner and administrators (true) or viewable by all otherwise-allowed users (false)"},{"displayName":"Owner Name or ID","name":"owner","type":"options","typeOptions":{"loadOptionsMethod":"getUsers"},"default":"","description":"ID of the User who owns the attachment. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."}]},{"displayName":"Attachment ID","name":"attachmentId","type":"string","required":true,"default":"","displayOptions":{"show":{"resource":["attachment"],"operation":["update"]}},"description":"ID of attachment that needs to be fetched"},{"displayName":"Update Fields","name":"updateFields","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"resource":["attachment"],"operation":["update"]}},"options":[{"displayName":"Binary Property","name":"binaryPropertyName","type":"string","default":"data","placeholder":"","description":"Name of the binary property which contains the data for the file to be uploaded"},{"displayName":"Description","name":"description","type":"string","default":"","description":"Text description of the Document. Limit: 255 characters."},{"displayName":"Is Private","name":"isPrivate","type":"boolean","default":false,"description":"Whether this record is viewable only by the owner and administrators (true) or viewable by all otherwise-allowed users (false)"},{"displayName":"Name","name":"name","type":"string","default":"","description":"Required. Name of the attached file. Maximum size is 255 characters. Label is File Name."},{"displayName":"Owner Name or ID","name":"owner","type":"options","typeOptions":{"loadOptionsMethod":"getUsers"},"default":"","description":"ID of the User who owns the attachment. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."}]},{"displayName":"Attachment ID","name":"attachmentId","type":"string","required":true,"default":"","displayOptions":{"show":{"resource":["attachment"],"operation":["get"]}},"description":"ID of attachment that needs to be fetched"},{"displayName":"Attachment ID","name":"attachmentId","type":"string","required":true,"default":"","displayOptions":{"show":{"resource":["attachment"],"operation":["delete"]}},"description":"ID of attachment that needs to be fetched"},{"displayName":"Return All","name":"returnAll","type":"boolean","displayOptions":{"show":{"resource":["attachment"],"operation":["getAll"]}},"default":false,"description":"Whether to return all results or only up to a given limit"},{"displayName":"Limit","name":"limit","type":"number","displayOptions":{"show":{"resource":["attachment"],"operation":["getAll"],"returnAll":[false]}},"typeOptions":{"minValue":1,"maxValue":100},"default":50,"description":"Max number of results to return"},{"displayName":"Options","name":"options","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"resource":["attachment"],"operation":["getAll"]}},"options":[{"displayName":"Conditions","name":"conditionsUi","placeholder":"Add Condition","type":"fixedCollection","typeOptions":{"multipleValues":true},"description":"The condition to set","default":{},"options":[{"name":"conditionValues","displayName":"Condition","values":[{"displayName":"Field Name or ID","name":"field","type":"options","typeOptions":{"loadOptionsMethod":"getAtachmentFields"},"default":"","description":"For date, number, or boolean, please use expressions. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Operation","name":"operation","type":"options","options":[{"name":"<","value":"<"},{"name":"<=","value":"<="},{"name":"=","value":"equal"},{"name":">","value":">"},{"name":">=","value":">="}],"default":"equal"},{"displayName":"Value","name":"value","type":"string","default":""}]}]},{"displayName":"Fields","name":"fields","type":"string","default":"","description":"Fields to include separated by ,"}]},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["user"]}},"options":[{"name":"Get","value":"get","description":"Get a user","action":"Get a user"},{"name":"Get Many","value":"getAll","description":"Get many users","action":"Get many users"}],"default":"get"},{"displayName":"User ID","name":"userId","type":"string","required":true,"default":"","displayOptions":{"show":{"resource":["user"],"operation":["get"]}},"description":"ID of user that needs to be fetched"},{"displayName":"Return All","name":"returnAll","type":"boolean","displayOptions":{"show":{"resource":["user"],"operation":["getAll"]}},"default":false,"description":"Whether to return all results or only up to a given limit"},{"displayName":"Limit","name":"limit","type":"number","displayOptions":{"show":{"resource":["user"],"operation":["getAll"],"returnAll":[false]}},"typeOptions":{"minValue":1,"maxValue":100},"default":50,"description":"Max number of results to return"},{"displayName":"Options","name":"options","type":"collection","placeholder":"Add Field","default":{},"displayOptions":{"show":{"resource":["user"],"operation":["getAll"]}},"options":[{"displayName":"Conditions","name":"conditionsUi","placeholder":"Add Condition","type":"fixedCollection","typeOptions":{"multipleValues":true},"description":"The condition to set","default":{},"options":[{"name":"conditionValues","displayName":"Condition","values":[{"displayName":"Field Name or ID","name":"field","type":"options","typeOptions":{"loadOptionsMethod":"getUserFields"},"default":"","description":"For date, number, or boolean, please use expressions. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>."},{"displayName":"Operation","name":"operation","type":"options","options":[{"name":"<","value":"<"},{"name":"<=","value":"<="},{"name":"=","value":"equal"},{"name":">","value":">"},{"name":">=","value":">="}],"default":"equal"},{"displayName":"Value","name":"value","type":"string","default":""}]}]},{"displayName":"Fields","name":"fields","type":"string","default":"","description":"Fields to include separated by ,"}]},{"displayName":"Operation","name":"operation","type":"options","noDataExpression":true,"displayOptions":{"show":{"resource":["flow"]}},"options":[{"name":"Get Many","value":"getAll","description":"Get many flows","action":"Get many flows"},{"name":"Invoke","value":"invoke","description":"Invoke a flow","action":"Invoke a flow"}],"default":"invoke"},{"displayName":"Return All","name":"returnAll","type":"boolean","displayOptions":{"show":{"operation":["getAll"],"resource":["flow"]}},"default":false,"description":"Whether to return all results or only up to a given limit"},{"displayName":"Limit","name":"limit","type":"number","displayOptions":{"show":{"operation":["getAll"],"resource":["flow"],"returnAll":[false]}},"typeOptions":{"minValue":1,"maxValue":500},"default":50,"description":"Max number of results to return"},{"displayName":"API Name","name":"apiName","type":"string","default":"","required":true,"displayOptions":{"show":{"resource":["flow"],"operation":["invoke"]}},"description":"Required. API name of the flow."},{"displayName":"JSON Parameters","name":"jsonParameters","type":"boolean","default":false,"displayOptions":{"show":{"resource":["flow"],"operation":["invoke"]}},"description":"Whether the input variables should be set via the value-key pair UI or JSON/RAW"},{"displayName":"Variables","name":"variablesJson","type":"json","displayOptions":{"show":{"resource":["flow"],"operation":["invoke"],"jsonParameters":[true]}},"default":"","description":"Input variables as JSON object"},{"displayName":"Variables","name":"variablesUi","placeholder":"Add Variable","type":"fixedCollection","typeOptions":{"multipleValues":true},"displayOptions":{"show":{"resource":["flow"],"operation":["invoke"],"jsonParameters":[false]}},"description":"The input variable to send","default":{},"options":[{"displayName":"Variable","name":"variablesValues","values":[{"displayName":"Name","name":"name","type":"string","default":"","description":"Name of the input variable"},{"displayName":"Value","name":"value","type":"string","default":"","description":"Value of the input variable"}]}]}]

operations:
  [{"type":"resource","resource":"account","name":"Account"},{"type":"resource","resource":"attachment","name":"Attachment"},{"type":"resource","resource":"case","name":"Case"},{"type":"resource","resource":"contact","name":"Contact"},{"type":"resource","resource":"customObject","name":"Custom Object"},{"type":"resource","resource":"document","name":"Document"},{"type":"resource","resource":"flow","name":"Flow"},{"type":"resource","resource":"lead","name":"Lead"},{"type":"resource","resource":"opportunity","name":"Opportunity"},{"type":"resource","resource":"search","name":"Search"},{"type":"resource","resource":"task","name":"Task"},{"type":"resource","resource":"user","name":"User"},{"type":"operation","operation":"addToCampaign","name":"Add Lead To Campaign","action":"Add a lead to a campaign","resources":["lead"]},{"type":"operation","operation":"addNote","name":"Add Note","action":"Add a note to a lead","resources":["lead"]},{"type":"operation","operation":"create","name":"Create","action":"Create a lead","resources":["lead"]},{"type":"operation","operation":"upsert","name":"Create or Update","action":"Create or update a lead","resources":["lead"]},{"type":"operation","operation":"delete","name":"Delete","action":"Delete a lead","resources":["lead"]},{"type":"operation","operation":"get","name":"Get","action":"Get a lead","resources":["lead"]},{"type":"operation","operation":"getAll","name":"Get Many","action":"Get many leads","resources":["lead"]},{"type":"operation","operation":"getSummary","name":"Get Summary","action":"Get a lead summary","resources":["lead"]},{"type":"operation","operation":"update","name":"Update","action":"Update a lead","resources":["lead"]},{"type":"operation","operation":"addToCampaign","name":"Add Contact To Campaign","action":"Add a contact to a campaign","resources":["contact"]},{"type":"operation","operation":"addNote","name":"Add Note","action":"Add a note to a contact","resources":["contact"]},{"type":"operation","operation":"create","name":"Create","action":"Create a contact","resources":["contact"]},{"type":"operation","operation":"upsert","name":"Create or Update","action":"Create or update a contact","resources":["contact"]},{"type":"operation","operation":"delete","name":"Delete","action":"Delete a contact","resources":["contact"]},{"type":"operation","operation":"get","name":"Get","action":"Get a contact","resources":["contact"]},{"type":"operation","operation":"getAll","name":"Get Many","action":"Get many contacts","resources":["contact"]},{"type":"operation","operation":"getSummary","name":"Get Summary","action":"Get a contact summary","resources":["contact"]},{"type":"operation","operation":"update","name":"Update","action":"Update a contact","resources":["contact"]},{"type":"operation","operation":"create","name":"Create","action":"Create a custom object","resources":["customObject"]},{"type":"operation","operation":"upsert","name":"Create or Update","action":"Create or update a custom object","resources":["customObject"]},{"type":"operation","operation":"delete","name":"Delete","action":"Delete a custom object","resources":["customObject"]},{"type":"operation","operation":"get","name":"Get","action":"Get a custom object","resources":["customObject"]},{"type":"operation","operation":"getAll","name":"Get Many","action":"Get many custom objects","resources":["customObject"]},{"type":"operation","operation":"update","name":"Update","action":"Update a custom object","resources":["customObject"]},{"type":"operation","operation":"upload","name":"Upload","action":"Upload a document","resources":["document"]},{"type":"operation","operation":"addNote","name":"Add Note","action":"Add a note to an opportunity","resources":["opportunity"]},{"type":"operation","operation":"create","name":"Create","action":"Create an opportunity","resources":["opportunity"]},{"type":"operation","operation":"upsert","name":"Create or Update","action":"Create or update an opportunity","resources":["opportunity"]},{"type":"operation","operation":"delete","name":"Delete","action":"Delete an opportunity","resources":["opportunity"]},{"type":"operation","operation":"get","name":"Get","action":"Get an opportunity","resources":["opportunity"]},{"type":"operation","operation":"getAll","name":"Get Many","action":"Get many opportunities","resources":["opportunity"]},{"type":"operation","operation":"getSummary","name":"Get Summary","action":"Get an opportunity summary","resources":["opportunity"]},{"type":"operation","operation":"update","name":"Update","action":"Update an opportunity","resources":["opportunity"]},{"type":"operation","operation":"addNote","name":"Add Note","action":"Add a note to an account","resources":["account"]},{"type":"operation","operation":"create","name":"Create","action":"Create an account","resources":["account"]},{"type":"operation","operation":"upsert","name":"Create or Update","action":"Create or update an account","resources":["account"]},{"type":"operation","operation":"delete","name":"Delete","action":"Delete an account","resources":["account"]},{"type":"operation","operation":"get","name":"Get","action":"Get an account","resources":["account"]},{"type":"operation","operation":"getAll","name":"Get Many","action":"Get many accounts","resources":["account"]},{"type":"operation","operation":"getSummary","name":"Get Summary","action":"Get an account summary","resources":["account"]},{"type":"operation","operation":"update","name":"Update","action":"Update an account","resources":["account"]},{"type":"operation","operation":"query","name":"Query","action":"Perform a query","resources":["search"]},{"type":"operation","operation":"addComment","name":"Add Comment","action":"Add a comment to a case","resources":["case"]},{"type":"operation","operation":"create","name":"Create","action":"Create a case","resources":["case"]},{"type":"operation","operation":"delete","name":"Delete","action":"Delete a case","resources":["case"]},{"type":"operation","operation":"get","name":"Get","action":"Get a case","resources":["case"]},{"type":"operation","operation":"getAll","name":"Get Many","action":"Get many cases","resources":["case"]},{"type":"operation","operation":"getSummary","name":"Get Summary","action":"Get a case summary","resources":["case"]},{"type":"operation","operation":"update","name":"Update","action":"Update a case","resources":["case"]},{"type":"operation","operation":"create","name":"Create","action":"Create a task","resources":["task"]},{"type":"operation","operation":"delete","name":"Delete","action":"Delete a task","resources":["task"]},{"type":"operation","operation":"get","name":"Get","action":"Get a task","resources":["task"]},{"type":"operation","operation":"getAll","name":"Get Many","action":"Get many tasks","resources":["task"]},{"type":"operation","operation":"getSummary","name":"Get Summary","action":"Get a task summary","resources":["task"]},{"type":"operation","operation":"update","name":"Update","action":"Update a task","resources":["task"]},{"type":"operation","operation":"create","name":"Create","action":"Create an attachment","resources":["attachment"]},{"type":"operation","operation":"delete","name":"Delete","action":"Delete an attachment","resources":["attachment"]},{"type":"operation","operation":"get","name":"Get","action":"Get an attachment","resources":["attachment"]},{"type":"operation","operation":"getAll","name":"Get Many","action":"Get many attachments","resources":["attachment"]},{"type":"operation","operation":"getSummary","name":"Get Summary","action":"Get an attachment summary","resources":["attachment"]},{"type":"operation","operation":"update","name":"Update","action":"Update an attachment","resources":["attachment"]},{"type":"operation","operation":"get","name":"Get","action":"Get a user","resources":["user"]},{"type":"operation","operation":"getAll","name":"Get Many","action":"Get many users","resources":["user"]},{"type":"operation","operation":"getAll","name":"Get Many","action":"Get many flows","resources":["flow"]},{"type":"operation","operation":"invoke","name":"Invoke","action":"Invoke a flow","resources":["flow"]}]

credentials_required:
  [{"name":"salesforceOAuth2Api","required":true,"displayOptions":{"show":{"authentication":["oAuth2"]}}},{"name":"salesforceJwtApi","required":true,"displayOptions":{"show":{"authentication":["jwt"]}}}]


