# nodes

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

updated_at: 2025-07-01 06:53:38
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: Notion Trigger node documentation
  description: Learn how to use the Notion Trigger node in n8n. Follow technical documentation to integrate Notion Trigger node into your workflows.
  contentType: [integration, reference]
  priority: high
  ---

  # Notion Trigger node

  [Notion](https://notion.so){:target=_blank .external-link} is an all-in-one workspace for your notes, tasks, wikis, and databases.

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

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

  ## Events

  * Page added to database
  * Page updated in database

  ## Related resources

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

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

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

properties_schema:
  [
    {
      "displayName": "Event",
      "name": "event",
      "type": "options",
      "default": "pageAddedToDatabase",
      "options": [
        {
          "name": "Page Added to Database",
          "value": "pageAddedToDatabase"
        },
        {
          "name": "Page Updated in Database",
          "value": "pagedUpdatedInDatabase"
        }
      ],
      "required": true
    },
    {
      "displayName": "In Notion, make sure to <a href=\"https://www.notion.so/help/add-and-manage-connections-with-the-api\" target=\"_blank\">add your connection</a> to the pages you want to access.",
      "name": "notionNotice",
      "type": "notice",
      "default": ""
    },
    {
      "displayName": "Database",
      "name": "databaseId",
      "type": "resourceLocator",
      "default": {
        "mode": "list",
        "value": ""
      },
      "description": "The Notion Database to operate on",
      "required": true,
      "displayOptions": {
        "show": {
          "event": [
            "pageAddedToDatabase",
            "pagedUpdatedInDatabase"
          ]
        }
      }
    },
    {
      "displayName": "Simplify",
      "name": "simple",
      "type": "boolean",
      "default": true,
      "description": "Whether to return a simplified version of the response instead of the raw data",
      "displayOptions": {
        "show": {
          "event": [
            "pageAddedToDatabase",
            "pagedUpdatedInDatabase"
          ]
        }
      }
    }
  ]


node_type: nodes-base.npm
package_name: n8n-nodes-base
display_name: Npm
description: Consume NPM registry API
category: input
development_style: programmatic
version: 1
credentials_required:
  [
  {
  "name": "npmApi",
  "required": false
  }
  ]

updated_at: 2025-07-01 06:53:38
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: npm node documentation
  description: Learn how to use the npm node in n8n. Follow technical documentation to integrate npm node into your workflows.
  contentType: [integration, reference]
  ---

  # npm node

  Use the npm node to automate work in npm, and integrate npm with other applications.

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

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

  ## Operations

  * Package
  	* Get Package Metadata
  	* Get Package Versions
  	* Search for Packages
  * Distribution Tag
  	* Get All Tags
  	* Update a Tag

  ## Templates and examples

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

  ## Related resources

  Refer to [npm's documentation](https://docs.npmjs.com/){:target=_blank .external-link} for more information about the service.

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

properties_schema:
  [
    {
      "displayName": "Resource",
      "name": "resource",
      "type": "options",
      "default": "package",
      "options": [
        {
          "name": "Package",
          "value": "package"
        },
        {
          "name": "Distribution Tag",
          "value": "distTag"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "getMetadata",
      "options": [
        {
          "name": "Get Metadata",
          "value": "getMetadata",
          "action": "Returns all the metadata for a package at a specific version",
          "description": "Returns all the metadata for a package at a specific version",
          "routing": {
            "request": {
              "method": "GET",
              "url": "=/{{ encodeURIComponent($parameter.packageName) }}/{{ $parameter.packageVersion }}"
            }
          }
        },
        {
          "name": "Get Versions",
          "value": "getVersions",
          "action": "Returns all the versions for a package",
          "description": "Returns all the versions for a package",
          "routing": {
            "request": {
              "method": "GET",
              "url": "=/{{ encodeURIComponent($parameter.packageName) }}"
            },
            "output": {
              "postReceive": [
                null
              ]
            }
          }
        },
        {
          "name": "Search",
          "value": "search",
          "action": "Search for packages",
          "description": "Search for packages",
          "routing": {
            "request": {
              "method": "GET",
              "url": "/-/v1/search",
              "qs": {
                "text": "={{$parameter.query}}",
                "size": "={{$parameter.limit}}",
                "from": "={{$parameter.offset}}",
                "popularity": 0.99
              }
            },
            "output": {
              "postReceive": [
                null
              ]
            }
          }
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "package"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Package Name",
      "name": "packageName",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "package"
          ],
          "operation": [
            "getMetadata",
            "getVersions"
          ]
        }
      }
    },
    {
      "displayName": "Package Version",
      "name": "packageVersion",
      "type": "string",
      "default": "latest",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "package"
          ],
          "operation": [
            "getMetadata"
          ]
        }
      }
    },
    {
      "displayName": "Query",
      "name": "query",
      "type": "string",
      "default": "",
      "description": "The query text used to search for packages",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "package"
          ],
          "operation": [
            "search"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 10,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "package"
          ],
          "operation": [
            "search"
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 100
      }
    },
    {
      "displayName": "Offset",
      "name": "offset",
      "type": "number",
      "default": 0,
      "description": "Offset to return results from",
      "displayOptions": {
        "show": {
          "resource": [
            "package"
          ],
          "operation": [
            "search"
          ]
        }
      },
      "typeOptions": {
        "minValue": 0
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "getMany",
      "options": [
        {
          "name": "Get All",
          "value": "getMany",
          "action": "Returns all the dist-tags for a package",
          "description": "Returns all the dist-tags for a package",
          "routing": {
            "request": {
              "method": "GET",
              "url": "=/-/package/{{ encodeURIComponent($parameter.packageName) }}/dist-tags"
            }
          }
        },
        {
          "name": "Update",
          "value": "update",
          "action": "Update a the dist-tags for a package",
          "description": "Update a the dist-tags for a package",
          "routing": {
            "request": {
              "method": "PUT",
              "url": "=/-/package/{{ encodeURIComponent($parameter.packageName) }}/dist-tags/{{ encodeURIComponent($parameter.distTagName) }}"
            },
            "send": {
              "preSend": [
                null
              ]
            }
          }
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "distTag"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Package Name",
      "name": "packageName",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "distTag"
          ],
          "operation": [
            "getMany",
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Package Version",
      "name": "packageVersion",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "distTag"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Distribution Tag Name",
      "name": "distTagName",
      "type": "string",
      "default": "latest",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "distTag"
          ],
          "operation": [
            "update"
          ]
        }
      }
    }
  ]

operations:
  [
    {
      "operation": "getMetadata",
      "name": "Get Metadata",
      "description": "Returns all the metadata for a package at a specific version"
    },
    {
      "operation": "getVersions",
      "name": "Get Versions",
      "description": "Returns all the versions for a package"
    },
    {
      "operation": "search",
      "name": "Search",
      "description": "Search for packages"
    }
  ]


node_type: nodes-base.odoo
package_name: n8n-nodes-base
display_name: Odoo
description: Consume Odoo API
category: transform
development_style: programmatic
version: 1
credentials_required:
  [
  {
  "name": "odooApi",
  "required": true,
  "testedBy": "odooApiTest"
  }
  ]

updated_at: 2025-07-01 06:53:38
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: Odoo node documentation
  description: Learn how to use the Odoo node in n8n. Follow technical documentation to integrate Odoo node into your workflows.
  contentType: [integration, reference]
  priority: medium
  ---

  # Odoo node

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

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

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

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

  ## Operations

  * Contact
      * Create a new contact
      * Delete a contact
      * Get a contact
      * Get all contacts
      * Update a contact
  * Custom Resource
      * Create a new item
      * Delete an item
      * Get an item
      * Get all items
      * Update an item
  * Note
      * Create a new note
      * Delete a note
      * Get a note
      * Get all notes
      * Update a note
  * Opportunity
      * Create a new opportunity
      * Delete an opportunity
      * Get an opportunity
      * Get all opportunities
      * Update an opportunity

  ## Templates and examples

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

properties_schema:
  [
    {
      "displayName": "Resource",
      "name": "resource",
      "type": "options",
      "default": "contact",
      "options": [
        {
          "name": "Contact",
          "value": "contact"
        },
        {
          "name": "Custom Resource",
          "value": "custom"
        },
        {
          "name": "Note",
          "value": "note"
        },
        {
          "name": "Opportunity",
          "value": "opportunity"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "Custom Resource Name or ID",
      "name": "customResource",
      "type": "options",
      "default": "",
      "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
      "displayOptions": {
        "show": {
          "resource": [
            "custom"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getModels"
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create a new item",
          "action": "Create an item"
        },
        {
          "name": "Delete",
          "value": "delete",
          "description": "Delete an item",
          "action": "Delete an item"
        },
        {
          "name": "Get",
          "value": "get",
          "description": "Get an item",
          "action": "Get an item"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get many items",
          "action": "Get many items"
        },
        {
          "name": "Update",
          "value": "update",
          "description": "Update an item",
          "action": "Update an item"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "custom"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Fields",
      "name": "fieldsToCreateOrUpdate",
      "type": "fixedCollection",
      "default": {},
      "options": [
        {
          "displayName": "Field Record:",
          "name": "fields",
          "values": [
            {
              "displayName": "Field Name or ID",
              "name": "fieldName",
              "type": "options",
              "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
              "default": "",
              "typeOptions": {
                "loadOptionsMethod": "getModelFields"
              }
            },
            {
              "displayName": "New Value",
              "name": "fieldValue",
              "type": "string",
              "default": ""
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "create"
          ],
          "resource": [
            "custom"
          ]
        }
      },
      "typeOptions": {
        "multipleValues": true,
        "multipleValueButtonText": "Add Field"
      }
    },
    {
      "displayName": "Custom Resource ID",
      "name": "customResourceId",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "get",
            "delete"
          ],
          "resource": [
            "custom"
          ]
        }
      }
    },
    {
      "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": [
            "custom"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 50,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "custom"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 1000
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Fields to Include",
          "name": "fieldsList",
          "type": "multiOptions",
          "description": "Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
          "default": [],
          "typeOptions": {
            "loadOptionsMethod": "getModelFields",
            "loadOptionsDependsOn": [
              "customResource"
            ]
          }
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "getAll",
            "get"
          ],
          "resource": [
            "custom"
          ]
        }
      }
    },
    {
      "displayName": "Filters",
      "name": "filterRequest",
      "type": "fixedCollection",
      "default": {},
      "description": "Filter request by applying filters",
      "options": [
        {
          "name": "filter",
          "displayName": "Filter",
          "values": [
            {
              "displayName": "Field Name or ID",
              "name": "fieldName",
              "type": "options",
              "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
              "default": "",
              "typeOptions": {
                "loadOptionsDependsOn": [
                  "customResource"
                ],
                "loadOptionsMethod": "getModelFields"
              }
            },
            {
              "displayName": "Operator",
              "name": "operator",
              "type": "options",
              "default": "equal",
              "description": "Specify an operator",
              "options": [
                {
                  "name": "!=",
                  "value": "notEqual"
                },
                {
                  "name": "<",
                  "value": "lesserThen"
                },
                {
                  "name": "<=",
                  "value": "lesserOrEqual"
                },
                {
                  "name": "=",
                  "value": "equal"
                },
                {
                  "name": ">",
                  "value": "greaterThen"
                },
                {
                  "name": ">=",
                  "value": "greaterOrEqual"
                },
                {
                  "name": "Child Of",
                  "value": "childOf"
                },
                {
                  "name": "In",
                  "value": "in"
                },
                {
                  "name": "Like",
                  "value": "like"
                },
                {
                  "name": "Not In",
                  "value": "notIn"
                }
              ]
            },
            {
              "displayName": "Value",
              "name": "value",
              "type": "string",
              "default": "",
              "description": "Specify value for comparison"
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "custom"
          ]
        }
      },
      "typeOptions": {
        "multipleValues": true,
        "multipleValueButtonText": "Add Filter"
      }
    },
    {
      "displayName": "Custom Resource ID",
      "name": "customResourceId",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "update"
          ],
          "resource": [
            "custom"
          ]
        }
      }
    },
    {
      "displayName": "Update Fields",
      "name": "fieldsToCreateOrUpdate",
      "type": "fixedCollection",
      "default": {},
      "options": [
        {
          "displayName": "Field Record:",
          "name": "fields",
          "values": [
            {
              "displayName": "Field Name or ID",
              "name": "fieldName",
              "type": "options",
              "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
              "default": "",
              "typeOptions": {
                "loadOptionsMethod": "getModelFields"
              }
            },
            {
              "displayName": "New Value",
              "name": "fieldValue",
              "type": "string",
              "default": ""
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "update"
          ],
          "resource": [
            "custom"
          ]
        }
      },
      "typeOptions": {
        "multipleValues": true,
        "multipleValueButtonText": "Add Field"
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create a new opportunity",
          "action": "Create 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": "Update",
          "value": "update",
          "description": "Update an opportunity",
          "action": "Update an opportunity"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "opportunity"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Name",
      "name": "opportunityName",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "create"
          ],
          "resource": [
            "opportunity"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Email",
          "name": "email_from",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Expected Revenue",
          "name": "expected_revenue",
          "type": "number",
          "default": 0
        },
        {
          "displayName": "Internal Notes",
          "name": "description",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Phone",
          "name": "phone",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Priority",
          "name": "priority",
          "type": "options",
          "default": "1",
          "options": [
            {
              "name": "1",
              "value": "1"
            },
            {
              "name": "2",
              "value": "2"
            },
            {
              "name": "3",
              "value": "3"
            }
          ]
        },
        {
          "displayName": "Probability",
          "name": "probability",
          "type": "number",
          "default": 0,
          "typeOptions": {
            "maxValue": 100,
            "minValue": 0
          }
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "create"
          ],
          "resource": [
            "opportunity"
          ]
        }
      }
    },
    {
      "displayName": "Opportunity ID",
      "name": "opportunityId",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "get",
            "delete"
          ],
          "resource": [
            "opportunity"
          ]
        }
      }
    },
    {
      "displayName": "Return All",
      "name": "returnAll",
      "type": "boolean",
      "default": false,
      "description": "Whether to return all results or only up to a given limit",
      "displayOptions": {
        "show": {
          "resource": [
            "opportunity"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 50,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "opportunity"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 1000
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Fields to Include",
          "name": "fieldsList",
          "type": "multiOptions",
          "description": "Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
          "default": [],
          "typeOptions": {
            "loadOptionsMethod": "getModelFields"
          }
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "getAll",
            "get"
          ],
          "resource": [
            "opportunity"
          ]
        }
      }
    },
    {
      "displayName": "Opportunity ID",
      "name": "opportunityId",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "update"
          ],
          "resource": [
            "opportunity"
          ]
        }
      }
    },
    {
      "displayName": "Update Fields",
      "name": "updateFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Email",
          "name": "email_from",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Expected Revenue",
          "name": "expected_revenue",
          "type": "number",
          "default": 0
        },
        {
          "displayName": "Internal Notes",
          "name": "description",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Name",
          "name": "name",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Phone",
          "name": "phone",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Priority",
          "name": "priority",
          "type": "options",
          "default": "1",
          "options": [
            {
              "name": "1",
              "value": "1"
            },
            {
              "name": "2",
              "value": "2"
            },
            {
              "name": "3",
              "value": "3"
            }
          ]
        },
        {
          "displayName": "Probability",
          "name": "probability",
          "type": "number",
          "default": 0,
          "typeOptions": {
            "maxValue": 100,
            "minValue": 0
          }
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "update"
          ],
          "resource": [
            "opportunity"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create a new contact",
          "action": "Create 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": "Update",
          "value": "update",
          "description": "Update a contact",
          "action": "Update a contact"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "contact"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Name",
      "name": "contactName",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "create"
          ],
          "resource": [
            "contact"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Address",
          "name": "address",
          "type": "fixedCollection",
          "default": {},
          "placeholder": "Add Address",
          "typeOptions": {
            "multipleValues": false
          },
          "options": [
            {
              "name": "value",
              "displayName": "Address",
              "values": [
                {
                  "displayName": "City",
                  "name": "city",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Country Name or ID",
                  "name": "country_id",
                  "type": "options",
                  "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
                  "default": "",
                  "typeOptions": {
                    "loadOptionsMethod": "getCountries"
                  }
                },
                {
                  "displayName": "State Name or ID",
                  "name": "state_id",
                  "type": "options",
                  "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
                  "default": "",
                  "typeOptions": {
                    "loadOptionsMethod": "getStates"
                  }
                },
                {
                  "displayName": "Street",
                  "name": "street",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Street 2",
                  "name": "street2",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Zip Code",
                  "name": "zip",
                  "type": "string",
                  "default": ""
                }
              ]
            }
          ]
        },
        {
          "displayName": "Email",
          "name": "email",
          "type": "string",
          "placeholder": "name@email.com",
          "default": ""
        },
        {
          "displayName": "Internal Notes",
          "name": "comment",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Job Position",
          "name": "function",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Mobile",
          "name": "mobile",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Phone",
          "name": "phone",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Tax ID",
          "name": "vat",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Website",
          "name": "website",
          "type": "string",
          "default": ""
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "create"
          ],
          "resource": [
            "contact"
          ]
        }
      }
    },
    {
      "displayName": "Contact ID",
      "name": "contactId",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "get",
            "delete"
          ],
          "resource": [
            "contact"
          ]
        }
      }
    },
    {
      "displayName": "Return All",
      "name": "returnAll",
      "type": "boolean",
      "default": false,
      "description": "Whether to return all results or only up to a given limit",
      "displayOptions": {
        "show": {
          "resource": [
            "contact"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 50,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "contact"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 1000
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Fields to Include",
          "name": "fieldsList",
          "type": "multiOptions",
          "description": "Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
          "default": [],
          "typeOptions": {
            "loadOptionsMethod": "getModelFields"
          }
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "getAll",
            "get"
          ],
          "resource": [
            "contact"
          ]
        }
      }
    },
    {
      "displayName": "Contact ID",
      "name": "contactId",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "update"
          ],
          "resource": [
            "contact"
          ]
        }
      }
    },
    {
      "displayName": "Update Fields",
      "name": "updateFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Address",
          "name": "address",
          "type": "fixedCollection",
          "default": {},
          "placeholder": "Add Address",
          "typeOptions": {
            "multipleValues": false
          },
          "options": [
            {
              "name": "value",
              "displayName": "Address",
              "values": [
                {
                  "displayName": "City",
                  "name": "city",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Country Name or ID",
                  "name": "country_id",
                  "type": "options",
                  "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
                  "default": "",
                  "typeOptions": {
                    "loadOptionsMethod": "getCountries"
                  }
                },
                {
                  "displayName": "State Name or ID",
                  "name": "state_id",
                  "type": "options",
                  "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
                  "default": "",
                  "typeOptions": {
                    "loadOptionsMethod": "getStates"
                  }
                },
                {
                  "displayName": "Street",
                  "name": "street",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Street 2",
                  "name": "street2",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Zip Code",
                  "name": "zip",
                  "type": "string",
                  "default": ""
                }
              ]
            }
          ]
        },
        {
          "displayName": "Email",
          "name": "email",
          "type": "string",
          "placeholder": "name@email.com",
          "default": ""
        },
        {
          "displayName": "Internal Notes",
          "name": "comment",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Job Position",
          "name": "function",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Mobile",
          "name": "mobile",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Name",
          "name": "name",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Phone",
          "name": "phone",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Tax ID",
          "name": "vat",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Website",
          "name": "website",
          "type": "string",
          "default": ""
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "update"
          ],
          "resource": [
            "contact"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create a new note",
          "action": "Create a note"
        },
        {
          "name": "Delete",
          "value": "delete",
          "description": "Delete a note",
          "action": "Delete a note"
        },
        {
          "name": "Get",
          "value": "get",
          "description": "Get a note",
          "action": "Get a note"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get many notes",
          "action": "Get many notes"
        },
        {
          "name": "Update",
          "value": "update",
          "description": "Update a note",
          "action": "Update a note"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "note"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Memo",
      "name": "memo",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "create"
          ],
          "resource": [
            "note"
          ]
        }
      }
    },
    {
      "displayName": "Note ID",
      "name": "noteId",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "get",
            "delete"
          ],
          "resource": [
            "note"
          ]
        }
      }
    },
    {
      "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": [
            "note"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 50,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "note"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 1000
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Fields to Include",
          "name": "fieldsList",
          "type": "multiOptions",
          "description": "Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
          "default": [],
          "typeOptions": {
            "loadOptionsMethod": "getModelFields"
          }
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "getAll",
            "get"
          ],
          "resource": [
            "note"
          ]
        }
      }
    },
    {
      "displayName": "Note ID",
      "name": "noteId",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "update"
          ],
          "resource": [
            "note"
          ]
        }
      }
    },
    {
      "displayName": "Memo",
      "name": "memo",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "update"
          ],
          "resource": [
            "note"
          ]
        }
      }
    }
  ]

operations:
  [
    {
      "operation": "create",
      "name": "Create",
      "description": "Create a new item"
    },
    {
      "operation": "delete",
      "name": "Delete",
      "description": "Delete an item"
    },
    {
      "operation": "get",
      "name": "Get",
      "description": "Get an item"
    },
    {
      "operation": "getAll",
      "name": "Get Many",
      "description": "Get many items"
    },
    {
      "operation": "update",
      "name": "Update",
      "description": "Update an item"
    }
  ]


node_type: nodes-base.okta
package_name: n8n-nodes-base
display_name: Okta
description: Use the Okta API
category: transform
development_style: programmatic
version: 1
credentials_required:
  [
  {
  "name": "oktaApi",
  "required": true
  }
  ]

updated_at: 2025-07-01 06:53:38
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: Okta node documentation
  description: Learn how to use the Okta node in n8n. Follow technical documentation to integrate Okta node into your workflows.
  contentType: [integration, reference]
  ---

  # Okta node

  Use the Okta node to automate work in Okta and integrate Okta with other applications. n8n has built-in support for a wide range of Okta features, which includes creating, updating, and deleting users.

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

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

  ## Operations

  - User
      - Create a new user
      - Delete an existing user
      - Get details of a user
      - Get many users
      - Update an existing user

  ## Templates and examples

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

  ## Related resources

  <!-- add a link to the service's documentation. This should usually go direct to the API docs -->
  Refer to [Okta's documentation](https://developer.okta.com/docs/guides/){:target=_blank .external-link} for more information about the service.

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

properties_schema:
  [
    {
      "displayName": "Resource",
      "name": "resource",
      "type": "options",
      "default": "user",
      "options": [
        {
          "name": "User",
          "value": "user"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "getAll",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create a new user",
          "routing": {
            "request": {
              "method": "POST",
              "url": "/api/v1/users/",
              "qs": {
                "activate": "={{$parameter[\"activate\"]}}"
              },
              "returnFullResponse": true
            }
          },
          "action": "Create a new user"
        },
        {
          "name": "Delete",
          "value": "delete",
          "description": "Delete an existing user",
          "routing": {
            "request": {
              "method": "DELETE",
              "url": "={{\"/api/v1/users/\" + $parameter[\"userId\"]}}",
              "returnFullResponse": true
            },
            "output": {
              "postReceive": [
                {
                  "type": "set",
                  "properties": {
                    "value": "={{ { \"success\": true } }}"
                  }
                }
              ]
            }
          },
          "action": "Delete a user"
        },
        {
          "name": "Get",
          "value": "get",
          "description": "Get details of a user",
          "routing": {
            "request": {
              "method": "GET",
              "url": "={{\"/api/v1/users/\" + $parameter[\"userId\"]}}",
              "returnFullResponse": true,
              "qs": {}
            },
            "output": {
              "postReceive": [
                null
              ]
            }
          },
          "action": "Get a user"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get many users",
          "routing": {
            "request": {
              "method": "GET",
              "url": "/api/v1/users/",
              "qs": {
                "search": "={{$parameter[\"searchQuery\"]}}"
              },
              "returnFullResponse": true
            },
            "output": {
              "postReceive": [
                null
              ]
            },
            "send": {
              "paginate": true
            },
            "operations": {}
          },
          "action": "Get many users"
        },
        {
          "name": "Update",
          "value": "update",
          "description": "Update an existing user",
          "routing": {
            "request": {
              "method": "POST",
              "url": "={{\"/api/v1/users/\" + $parameter[\"userId\"]}}",
              "returnFullResponse": true
            }
          },
          "action": "Update a user"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "User",
      "name": "userId",
      "type": "resourceLocator",
      "default": {
        "mode": "list",
        "value": ""
      },
      "description": "The user you want to operate on. Choose from the list, or specify an ID.",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "get",
            "update",
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "First Name",
      "name": "firstName",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Last Name",
      "name": "lastName",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Username",
      "name": "login",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Email",
      "name": "email",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Activate",
      "name": "activate",
      "type": "boolean",
      "default": true,
      "description": "Whether to activate the user and allow access to all assigned applications",
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Fields",
      "name": "getCreateFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "City",
          "name": "city",
          "type": "string",
          "default": "",
          "routing": {
            "send": {
              "property": "profile.city",
              "type": "body"
            }
          }
        },
        {
          "displayName": "Cost Center",
          "name": "costCenter",
          "type": "string",
          "default": "",
          "routing": {
            "send": {
              "property": "profile.costCenter",
              "type": "body"
            }
          }
        },
        {
          "displayName": "Country Code",
          "name": "countryCode",
          "type": "string",
          "default": "",
          "routing": {
            "send": {
              "property": "profile.countryCode",
              "type": "body"
            }
          }
        },
        {
          "displayName": "Department",
          "name": "department",
          "type": "string",
          "default": "",
          "routing": {
            "send": {
              "property": "profile.department",
              "type": "body"
            }
          }
        },
        {
          "displayName": "Display Name",
          "name": "displayName",
          "type": "string",
          "default": "",
          "routing": {
            "send": {
              "property": "profile.displayName",
              "type": "body"
            }
          }
        },
        {
          "displayName": "Division",
          "name": "division",
          "type": "string",
          "default": "",
          "routing": {
            "send": {
              "property": "profile.division",
              "type": "body"
            }
          }
        },
        {
          "displayName": "Employee Number",
          "name": "employeeNumber",
          "type": "string",
          "default": "",
          "routing": {
            "send": {
              "property": "profile.employeeNumber",
              "type": "body"
            }
          }
        },
        {
          "displayName": "Honorific Prefix",
          "name": "honorificPrefix",
          "type": "string",
          "default": "",
          "routing": {
            "send": {
              "property": "profile.honorificPrefix",
              "type": "body"
            }
          }
        },
        {
          "displayName": "Honorific Suffix",
          "name": "honorificSuffix",
          "type": "string",
          "default": "",
          "routing": {
            "send": {
              "property": "profile.honorificSuffix",
              "type": "body"
            }
          }
        },
        {
          "displayName": "Locale",
          "name": "locale",
          "type": "string",
          "default": "",
          "routing": {
            "send": {
              "property": "profile.locale",
              "type": "body"
            }
          }
        },
        {
          "displayName": "Manager",
          "name": "manager",
          "type": "string",
          "default": "",
          "routing": {
            "send": {
              "property": "profile.manager",
              "type": "body"
            }
          }
        },
        {
          "displayName": "ManagerId",
          "name": "managerId",
          "type": "string",
          "default": "",
          "routing": {
            "send": {
              "property": "profile.managerId",
              "type": "body"
            }
          }
        },
        {
          "displayName": "Middle Name",
          "name": "middleName",
          "type": "string",
          "default": "",
          "routing": {
            "send": {
              "property": "profile.middleName",
              "type": "body"
            }
          }
        },
        {
          "displayName": "Mobile Phone",
          "name": "mobilePhone",
          "type": "string",
          "default": "",
          "routing": {
            "send": {
              "property": "profile.mobilePhone",
              "type": "body"
            }
          }
        },
        {
          "displayName": "Nick Name",
          "name": "nickName",
          "type": "string",
          "default": "",
          "routing": {
            "send": {
              "property": "profile.nickName",
              "type": "body"
            }
          }
        },
        {
          "displayName": "Password",
          "name": "password",
          "type": "string",
          "typeOptions": {
            "password": true
          },
          "default": "",
          "routing": {
            "send": {
              "property": "credentials.password.value",
              "type": "body"
            }
          }
        },
        {
          "displayName": "Organization",
          "name": "organization",
          "type": "string",
          "default": "",
          "routing": {
            "send": {
              "property": "profile.organization",
              "type": "body"
            }
          }
        },
        {
          "displayName": "Postal Address",
          "name": "postalAddress",
          "type": "string",
          "default": "",
          "routing": {
            "send": {
              "property": "profile.postalAddress",
              "type": "body"
            }
          }
        },
        {
          "displayName": "Preferred Language",
          "name": "preferredLanguage",
          "type": "string",
          "default": "",
          "routing": {
            "send": {
              "property": "profile.preferredLanguage",
              "type": "body"
            }
          }
        },
        {
          "displayName": "Primary Phone",
          "name": "primaryPhone",
          "type": "string",
          "default": "",
          "routing": {
            "send": {
              "property": "profile.primaryPhone",
              "type": "body"
            }
          }
        },
        {
          "displayName": "Profile Url",
          "name": "profileUrl",
          "type": "string",
          "default": "",
          "routing": {
            "send": {
              "property": "profile.profileUrl",
              "type": "body"
            }
          }
        },
        {
          "displayName": "Recovery Question Answer",
          "name": "recoveryQuestionAnswer",
          "type": "string",
          "default": "",
          "routing": {
            "send": {
              "property": "credentials.recovery_question.answer",
              "type": "body"
            }
          }
        },
        {
          "displayName": "Recovery Question Question",
          "name": "recoveryQuestionQuestion",
          "type": "string",
          "default": "",
          "routing": {
            "send": {
              "property": "credentials.recovery_question.question",
              "type": "body"
            }
          }
        },
        {
          "displayName": "Second Email",
          "name": "secondEmail",
          "type": "string",
          "typeOptions": {
            "email": true
          },
          "default": "",
          "routing": {
            "send": {
              "property": "profile.secondEmail",
              "type": "body"
            }
          }
        },
        {
          "displayName": "State",
          "name": "state",
          "type": "string",
          "default": "",
          "routing": {
            "send": {
              "property": "profile.state",
              "type": "body"
            }
          }
        },
        {
          "displayName": "Street Address",
          "name": "streetAddress",
          "type": "string",
          "default": "",
          "routing": {
            "send": {
              "property": "profile.streetAddress",
              "type": "body"
            }
          }
        },
        {
          "displayName": "Timezone",
          "name": "timezone",
          "type": "string",
          "default": "",
          "routing": {
            "send": {
              "property": "profile.timezone",
              "type": "body"
            }
          }
        },
        {
          "displayName": "Title",
          "name": "title",
          "type": "string",
          "default": "",
          "routing": {
            "send": {
              "property": "profile.title",
              "type": "body"
            }
          }
        },
        {
          "displayName": "User Type",
          "name": "userType",
          "type": "string",
          "default": "",
          "routing": {
            "send": {
              "property": "profile.userType",
              "type": "body"
            }
          }
        },
        {
          "displayName": "Zip Code",
          "name": "zipCode",
          "type": "string",
          "default": "",
          "routing": {
            "send": {
              "property": "profile.zipCode",
              "type": "body"
            }
          }
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Fields",
      "name": "getUpdateFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "City",
          "name": "city",
          "type": "string",
          "default": "",
          "routing": {
            "send": {
              "property": "profile.city",
              "type": "body"
            }
          }
        },
        {
          "displayName": "Cost Center",
          "name": "costCenter",
          "type": "string",
          "default": "",
          "routing": {
            "send": {
              "property": "profile.costCenter",
              "type": "body"
            }
          }
        },
        {
          "displayName": "Country Code",
          "name": "countryCode",
          "type": "string",
          "default": "",
          "routing": {
            "send": {
              "property": "profile.countryCode",
              "type": "body"
            }
          }
        },
        {
          "displayName": "Department",
          "name": "department",
          "type": "string",
          "default": "",
          "routing": {
            "send": {
              "property": "profile.department",
              "type": "body"
            }
          }
        },
        {
          "displayName": "Display Name",
          "name": "displayName",
          "type": "string",
          "default": "",
          "routing": {
            "send": {
              "property": "profile.displayName",
              "type": "body"
            }
          }
        },
        {
          "displayName": "Division",
          "name": "division",
          "type": "string",
          "default": "",
          "routing": {
            "send": {
              "property": "profile.division",
              "type": "body"
            }
          }
        },
        {
          "displayName": "Email",
          "name": "email",
          "type": "string",
          "placeholder": "e.g. nathan@example.com",
          "default": "",
          "routing": {
            "send": {
              "property": "profile.email",
              "type": "body"
            }
          }
        },
        {
          "displayName": "Employee Number",
          "name": "employeeNumber",
          "type": "string",
          "default": "",
          "routing": {
            "send": {
              "property": "profile.employeeNumber",
              "type": "body"
            }
          }
        },
        {
          "displayName": "First Name",
          "name": "firstName",
          "type": "string",
          "placeholder": "e.g. Nathan",
          "default": "",
          "routing": {
            "send": {
              "property": "profile.firstName",
              "type": "body"
            }
          }
        },
        {
          "displayName": "Honorific Prefix",
          "name": "honorificPrefix",
          "type": "string",
          "default": "",
          "routing": {
            "send": {
              "property": "profile.honorificPrefix",
              "type": "body"
            }
          }
        },
        {
          "displayName": "Honorific Suffix",
          "name": "honorificSuffix",
          "type": "string",
          "default": "",
          "routing": {
            "send": {
              "property": "profile.honorificSuffix",
              "type": "body"
            }
          }
        },
        {
          "displayName": "Last Name",
          "name": "lastName",
          "type": "string",
          "placeholder": "e.g. Smith",
          "default": "",
          "routing": {
            "send": {
              "property": "profile.lastName",
              "type": "body"
            }
          }
        },
        {
          "displayName": "Locale",
          "name": "locale",
          "type": "string",
          "default": "",
          "routing": {
            "send": {
              "property": "profile.locale",
              "type": "body"
            }
          }
        },
        {
          "displayName": "Manager",
          "name": "manager",
          "type": "string",
          "default": "",
          "routing": {
            "send": {
              "property": "profile.manager",
              "type": "body"
            }
          }
        },
        {
          "displayName": "ManagerId",
          "name": "managerId",
          "type": "string",
          "default": "",
          "routing": {
            "send": {
              "property": "profile.managerId",
              "type": "body"
            }
          }
        },
        {
          "displayName": "Middle Name",
          "name": "middleName",
          "type": "string",
          "default": "",
          "routing": {
            "send": {
              "property": "profile.middleName",
              "type": "body"
            }
          }
        },
        {
          "displayName": "Mobile Phone",
          "name": "mobilePhone",
          "type": "string",
          "default": "",
          "routing": {
            "send": {
              "property": "profile.mobilePhone",
              "type": "body"
            }
          }
        },
        {
          "displayName": "Nick Name",
          "name": "nickName",
          "type": "string",
          "default": "",
          "routing": {
            "send": {
              "property": "profile.nickName",
              "type": "body"
            }
          }
        },
        {
          "displayName": "Organization",
          "name": "organization",
          "type": "string",
          "default": "",
          "routing": {
            "send": {
              "property": "profile.organization",
              "type": "body"
            }
          }
        },
        {
          "displayName": "Password",
          "name": "password",
          "type": "string",
          "typeOptions": {
            "password": true
          },
          "default": "",
          "routing": {
            "send": {
              "property": "credentials.password.value",
              "type": "body"
            }
          }
        },
        {
          "displayName": "Postal Address",
          "name": "postalAddress",
          "type": "string",
          "default": "",
          "routing": {
            "send": {
              "property": "profile.postalAddress",
              "type": "body"
            }
          }
        },
        {
          "displayName": "Preferred Language",
          "name": "preferredLanguage",
          "type": "string",
          "default": "",
          "routing": {
            "send": {
              "property": "profile.preferredLanguage",
              "type": "body"
            }
          }
        },
        {
          "displayName": "Primary Phone",
          "name": "primaryPhone",
          "type": "string",
          "default": "",
          "routing": {
            "send": {
              "property": "profile.primaryPhone",
              "type": "body"
            }
          }
        },
        {
          "displayName": "Profile Url",
          "name": "profileUrl",
          "type": "string",
          "default": "",
          "routing": {
            "send": {
              "property": "profile.profileUrl",
              "type": "body"
            }
          }
        },
        {
          "displayName": "Recovery Question Answer",
          "name": "recoveryQuestionAnswer",
          "type": "string",
          "default": "",
          "routing": {
            "send": {
              "property": "credentials.recovery_question.answer",
              "type": "body"
            }
          }
        },
        {
          "displayName": "Recovery Question Question",
          "name": "recoveryQuestionQuestion",
          "type": "string",
          "default": "",
          "routing": {
            "send": {
              "property": "credentials.recovery_question.question",
              "type": "body"
            }
          }
        },
        {
          "displayName": "Second Email",
          "name": "secondEmail",
          "type": "string",
          "typeOptions": {
            "email": true
          },
          "default": "",
          "routing": {
            "send": {
              "property": "profile.secondEmail",
              "type": "body"
            }
          }
        },
        {
          "displayName": "State",
          "name": "state",
          "type": "string",
          "default": "",
          "routing": {
            "send": {
              "property": "profile.state",
              "type": "body"
            }
          }
        },
        {
          "displayName": "Street Address",
          "name": "streetAddress",
          "type": "string",
          "default": "",
          "routing": {
            "send": {
              "property": "profile.streetAddress",
              "type": "body"
            }
          }
        },
        {
          "displayName": "Timezone",
          "name": "timezone",
          "type": "string",
          "default": "",
          "routing": {
            "send": {
              "property": "profile.timezone",
              "type": "body"
            }
          }
        },
        {
          "displayName": "Title",
          "name": "title",
          "type": "string",
          "default": "",
          "routing": {
            "send": {
              "property": "profile.title",
              "type": "body"
            }
          }
        },
        {
          "displayName": "User Type",
          "name": "userType",
          "type": "string",
          "default": "",
          "routing": {
            "send": {
              "property": "profile.userType",
              "type": "body"
            }
          }
        },
        {
          "displayName": "Username",
          "name": "login",
          "type": "string",
          "placeholder": "e.g. nathan@example.com",
          "hint": "Unique identifier for the user, must be an email",
          "default": "",
          "routing": {
            "send": {
              "property": "profile.login",
              "type": "body"
            }
          }
        },
        {
          "displayName": "Zip Code",
          "name": "zipCode",
          "type": "string",
          "default": "",
          "routing": {
            "send": {
              "property": "profile.zipCode",
              "type": "body"
            }
          }
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Search Query",
      "name": "searchQuery",
      "type": "string",
      "default": "",
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 20,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 200
      }
    },
    {
      "displayName": "Return All",
      "name": "returnAll",
      "type": "boolean",
      "default": false,
      "description": "Whether to return all results or only up to a given limit",
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Simplify",
      "name": "simplify",
      "type": "boolean",
      "default": true,
      "description": "Whether to return a simplified version of the response instead of the raw data",
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "get",
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Send Email",
      "name": "sendEmail",
      "type": "boolean",
      "default": false,
      "description": "Whether to send a deactivation email to the administrator",
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "delete"
          ]
        }
      }
    }
  ]

operations:
  [
    {
      "operation": "create",
      "name": "Create",
      "description": "Create a new user"
    },
    {
      "operation": "delete",
      "name": "Delete",
      "description": "Delete an existing user"
    },
    {
      "operation": "get",
      "name": "Get",
      "description": "Get details of a user"
    },
    {
      "operation": "getAll",
      "name": "Get Many",
      "description": "Get many users"
    },
    {
      "operation": "update",
      "name": "Update",
      "description": "Update an existing user"
    }
  ]


node_type: nodes-base.oneSimpleApi
package_name: n8n-nodes-base
display_name: One Simple API
description: A toolbox of no-code utilities
category: transform
development_style: programmatic
version: 1
credentials_required:
  [
  {
  "name": "oneSimpleApi",
  "required": true
  }
  ]

updated_at: 2025-07-01 06:53:38
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: One Simple API node documentation
  description: Learn how to use the One Simple API node in n8n. Follow technical documentation to integrate One Simple API node into your workflows.
  contentType: [integration, reference]
  ---
  <!-- vale off -->
  <!-- linting off because 'simple' isn't something I want to add to accept.txt -->
  # One Simple API node

  Use the One Simple API node to automate work in One Simple API, and integrate One Simple API with other applications. n8n has built-in support for a wide range of One Simple API features, including getting profiles, retrieving information, and generating utilities. 

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

  /// note | Credentials
  Refer to [One Simple API credentials](/integrations/builtin/credentials/onesimpleapi.md) for guidance on setting up authentication. 
  ///

  ## Operations

  * Information
      * Convert a value between currencies
      * Retrieve image metadata from a URL
  * Social Profile
      * Get details about an Instagram profile
      * Get details about a Spotify Artist
  * Utility
      * Expand a shortened url
      * Generate a QR Code
      * Validate an email address
  * Website
      * Generate a PDF from a webpage
      * Get SEO information from website
      * Create a screenshot from a webpage

  ## Templates and examples

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

  ## Related resources

  Refer to [One Simple API's documentation](https://onesimpleapi.com/docs){:target=_blank .external-link} for more information about the service.

  <!-- vale on -->

properties_schema:
  [
    {
      "displayName": "Resource",
      "name": "resource",
      "type": "options",
      "default": "website",
      "options": [
        {
          "name": "Information",
          "value": "information"
        },
        {
          "name": "Social Profile",
          "value": "socialProfile"
        },
        {
          "name": "Utility",
          "value": "utility"
        },
        {
          "name": "Website",
          "value": "website"
        }
      ],
      "required": true,
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "pdf",
      "options": [
        {
          "name": "Generate PDF",
          "value": "pdf",
          "description": "Generate a PDF from a webpage",
          "action": "Generate PDF"
        },
        {
          "name": "Get SEO Data",
          "value": "seo",
          "description": "Get SEO information from website",
          "action": "Get SEO Data"
        },
        {
          "name": "Take Screenshot",
          "value": "screenshot",
          "description": "Create a screenshot from a webpage",
          "action": "Screenshot"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "website"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "instagramProfile",
      "options": [
        {
          "name": "Instagram",
          "value": "instagramProfile",
          "description": "Get details about an Instagram profile",
          "action": "Get details about an Instagram profile"
        },
        {
          "name": "Spotify",
          "value": "spotifyArtistProfile",
          "description": "Get details about a Spotify Artist",
          "action": "Get details about a Spotify artist"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "socialProfile"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "exchangeRate",
      "options": [
        {
          "name": "Exchange Rate",
          "value": "exchangeRate",
          "description": "Convert a value between currencies",
          "action": "Convert a value between currencies"
        },
        {
          "name": "Image Metadata",
          "value": "imageMetadata",
          "description": "Retrieve image metadata from a URL",
          "action": "Get image metadata from a URL"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "information"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "validateEmail",
      "options": [
        {
          "name": "Expand URL",
          "value": "expandURL",
          "description": "Expand a shortened URL",
          "action": "Expand a shortened URL"
        },
        {
          "name": "Generate QR Code",
          "value": "qrCode",
          "description": "Generate a QR Code",
          "action": "Generate a QR code utility"
        },
        {
          "name": "Validate Email",
          "value": "validateEmail",
          "description": "Validate an email address",
          "action": "Validate an email address"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "utility"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Webpage URL",
      "name": "link",
      "type": "string",
      "default": "",
      "description": "Link to webpage to convert",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "pdf"
          ],
          "resource": [
            "website"
          ]
        }
      }
    },
    {
      "displayName": "Download PDF?",
      "name": "download",
      "type": "boolean",
      "default": false,
      "description": "Whether to download the PDF or return a link to it",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "pdf"
          ],
          "resource": [
            "website"
          ]
        }
      }
    },
    {
      "displayName": "Put Output In Field",
      "name": "output",
      "type": "string",
      "default": "data",
      "description": "The name of the output field to put the binary file data in",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "pdf"
          ],
          "resource": [
            "website"
          ],
          "download": [
            true
          ]
        }
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Page Size",
          "name": "page",
          "type": "options",
          "options": [
            {
              "name": "A0",
              "value": "A0"
            },
            {
              "name": "A1",
              "value": "A1"
            },
            {
              "name": "A2",
              "value": "A2"
            },
            {
              "name": "A3",
              "value": "A3"
            },
            {
              "name": "A4",
              "value": "A4"
            },
            {
              "name": "A5",
              "value": "A5"
            },
            {
              "name": "A6",
              "value": "A6"
            },
            {
              "name": "Ledger",
              "value": "Ledger"
            },
            {
              "name": "Legal",
              "value": "Legal"
            },
            {
              "name": "Letter",
              "value": "Letter"
            },
            {
              "name": "Tabloid",
              "value": "Tabloid"
            }
          ],
          "default": ""
        },
        {
          "displayName": "Force Refresh",
          "name": "force",
          "type": "boolean",
          "default": false,
          "description": "Normally the API will reuse a previously taken screenshot of the URL to give a faster response. This option allows you to retake the screenshot at that exact time, for those times when it's necessary."
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "website"
          ],
          "operation": [
            "pdf"
          ]
        }
      }
    },
    {
      "displayName": "QR Content",
      "name": "message",
      "type": "string",
      "default": "",
      "description": "The text that should be turned into a QR code - like a website URL",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "qrCode"
          ],
          "resource": [
            "utility"
          ]
        }
      }
    },
    {
      "displayName": "Download Image?",
      "name": "download",
      "type": "boolean",
      "default": false,
      "description": "Whether to download the QR code or return a link to it",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "qrCode"
          ],
          "resource": [
            "utility"
          ]
        }
      }
    },
    {
      "displayName": "Put Output In Field",
      "name": "output",
      "type": "string",
      "default": "data",
      "description": "The name of the output field to put the binary file data in",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "qrCode"
          ],
          "resource": [
            "utility"
          ],
          "download": [
            true
          ]
        }
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Size",
          "name": "size",
          "type": "options",
          "options": [
            {
              "name": "Small",
              "value": "Small"
            },
            {
              "name": "Medium",
              "value": "Medium"
            },
            {
              "name": "Large",
              "value": "Large"
            }
          ],
          "default": "Small",
          "description": "The QR Code size"
        },
        {
          "displayName": "Format",
          "name": "format",
          "type": "options",
          "options": [
            {
              "name": "PNG",
              "value": "PNG"
            },
            {
              "name": "SVG",
              "value": "SVG"
            }
          ],
          "default": "PNG",
          "description": "The QR Code format"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "utility"
          ],
          "operation": [
            "qrCode"
          ]
        }
      }
    },
    {
      "displayName": "Webpage URL",
      "name": "link",
      "type": "string",
      "default": "",
      "description": "Link to webpage to convert",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "screenshot"
          ],
          "resource": [
            "website"
          ]
        }
      }
    },
    {
      "displayName": "Download Screenshot?",
      "name": "download",
      "type": "boolean",
      "default": false,
      "description": "Whether to download the screenshot or return a link to it",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "screenshot"
          ],
          "resource": [
            "website"
          ]
        }
      }
    },
    {
      "displayName": "Put Output In Field",
      "name": "output",
      "type": "string",
      "default": "data",
      "description": "The name of the output field to put the binary file data in",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "screenshot"
          ],
          "resource": [
            "website"
          ],
          "download": [
            true
          ]
        }
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Screen Size",
          "name": "screen",
          "type": "options",
          "options": [
            {
              "name": "Phone",
              "value": "phone"
            },
            {
              "name": "Phone Landscape",
              "value": "phone-landscape"
            },
            {
              "name": "Retina",
              "value": "retina"
            },
            {
              "name": "Tablet",
              "value": "tablet"
            },
            {
              "name": "Tablet Landscape",
              "value": "tablet-landscape"
            }
          ],
          "default": ""
        },
        {
          "displayName": "Force Refresh",
          "name": "force",
          "type": "boolean",
          "default": false,
          "description": "Normally the API will reuse a previously taken screenshot of the URL to give a faster response. This option allows you to retake the screenshot at that exact time, for those times when it's necessary."
        },
        {
          "displayName": "Full Page",
          "name": "fullpage",
          "type": "boolean",
          "default": false,
          "description": "The API takes a screenshot of the viewable area for the desired screen size. If you need a screenshot of the whole length of the page, use this option."
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "website"
          ],
          "operation": [
            "screenshot"
          ]
        }
      }
    },
    {
      "displayName": "Profile Name",
      "name": "profileName",
      "type": "string",
      "default": "",
      "description": "Profile name to get details of",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "instagramProfile"
          ],
          "resource": [
            "socialProfile"
          ]
        }
      }
    },
    {
      "displayName": "Artist Name",
      "name": "artistName",
      "type": "string",
      "default": "",
      "description": "Artist name to get details for",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "spotifyArtistProfile"
          ],
          "resource": [
            "socialProfile"
          ]
        }
      }
    },
    {
      "displayName": "Value",
      "name": "value",
      "type": "string",
      "default": "",
      "description": "Value to convert",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "exchangeRate"
          ],
          "resource": [
            "information"
          ]
        }
      }
    },
    {
      "displayName": "From Currency",
      "name": "fromCurrency",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "exchangeRate"
          ],
          "resource": [
            "information"
          ]
        }
      }
    },
    {
      "displayName": "To Currency",
      "name": "toCurrency",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "exchangeRate"
          ],
          "resource": [
            "information"
          ]
        }
      }
    },
    {
      "displayName": "Link To Image",
      "name": "link",
      "type": "string",
      "default": "",
      "description": "Image to get metadata from",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "imageMetadata"
          ],
          "resource": [
            "information"
          ]
        }
      }
    },
    {
      "displayName": "Webpage URL",
      "name": "link",
      "type": "string",
      "default": "",
      "description": "Webpage to get SEO information for",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "seo"
          ],
          "resource": [
            "website"
          ]
        }
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Include Headers?",
          "name": "headers",
          "type": "boolean",
          "default": false
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "website"
          ],
          "operation": [
            "seo"
          ]
        }
      }
    },
    {
      "displayName": "Email Address",
      "name": "emailAddress",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "validateEmail"
          ],
          "resource": [
            "utility"
          ]
        }
      }
    },
    {
      "displayName": "URL",
      "name": "link",
      "type": "string",
      "default": "",
      "description": "URL to unshorten",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "expandURL"
          ],
          "resource": [
            "utility"
          ]
        }
      }
    }
  ]

operations:
  [
    {
      "operation": "pdf",
      "name": "Generate PDF",
      "description": "Generate a PDF from a webpage"
    },
    {
      "operation": "seo",
      "name": "Get SEO Data",
      "description": "Get SEO information from website"
    },
    {
      "operation": "screenshot",
      "name": "Take Screenshot",
      "description": "Create a screenshot from a webpage"
    }
  ]


node_type: nodes-base.openAi
package_name: n8n-nodes-base
display_name: OpenAI
description: Consume Open AI
category: transform
development_style: programmatic
version: 1.1
credentials_required:
  [
  {
  "name": "openAiApi",
  "required": true
  }
  ]

updated_at: 2025-07-01 06:53:38
properties_schema:
  [
    {
      "displayName": "<strong>New node version available:</strong> get the latest version with added features from the nodes panel.",
      "name": "oldVersionNotice",
      "type": "notice",
      "default": ""
    },
    {
      "displayName": "Resource",
      "name": "resource",
      "type": "options",
      "default": "text",
      "options": [
        {
          "name": "Chat",
          "value": "chat"
        },
        {
          "name": "Image",
          "value": "image"
        },
        {
          "name": "Text",
          "value": "text"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "complete",
      "options": [
        {
          "name": "Complete",
          "value": "complete",
          "action": "Create a Completion",
          "description": "Create one or more completions for a given text",
          "routing": {
            "request": {
              "method": "POST",
              "url": "/v1/chat/completions"
            },
            "output": {
              "postReceive": [
                null
              ]
            }
          }
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "chat"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Model",
      "name": "model",
      "type": "options",
      "default": "gpt-3.5-turbo",
      "description": "The model which will generate the completion. <a href=\"https://beta.openai.com/docs/models/overview\">Learn more</a>.",
      "displayOptions": {
        "show": {
          "operation": [
            "complete"
          ],
          "resource": [
            "chat"
          ],
          "@version": [
            1
          ]
        }
      },
      "typeOptions": {
        "loadOptions": {
          "routing": {
            "request": {
              "method": "GET",
              "url": "/v1/models"
            },
            "output": {
              "postReceive": [
                {
                  "type": "rootProperty",
                  "properties": {
                    "property": "data"
                  }
                },
                {
                  "type": "filter",
                  "properties": {
                    "pass": "={{ $responseItem.id.startsWith('gpt-') && !$responseItem.id.startsWith('gpt-4-vision') }}"
                  }
                },
                {
                  "type": "setKeyValue",
                  "properties": {
                    "name": "={{$responseItem.id}}",
                    "value": "={{$responseItem.id}}"
                  }
                },
                {
                  "type": "sort",
                  "properties": {
                    "key": "name"
                  }
                }
              ]
            }
          }
        }
      }
    },
    {
      "displayName": "Model",
      "name": "chatModel",
      "type": "options",
      "default": "gpt-3.5-turbo",
      "description": "The model which will generate the completion. <a href=\"https://beta.openai.com/docs/models/overview\">Learn more</a>.",
      "displayOptions": {
        "show": {
          "operation": [
            "complete"
          ],
          "resource": [
            "chat"
          ]
        },
        "hide": {
          "@version": [
            1
          ]
        }
      },
      "typeOptions": {
        "loadOptions": {
          "routing": {
            "request": {
              "method": "GET",
              "url": "/v1/models"
            },
            "output": {
              "postReceive": [
                {
                  "type": "rootProperty",
                  "properties": {
                    "property": "data"
                  }
                },
                {
                  "type": "filter",
                  "properties": {
                    "pass": "={{ $responseItem.id.startsWith('gpt-') && !$responseItem.id.startsWith('gpt-4-vision') }}"
                  }
                },
                {
                  "type": "setKeyValue",
                  "properties": {
                    "name": "={{$responseItem.id}}",
                    "value": "={{$responseItem.id}}"
                  }
                },
                {
                  "type": "sort",
                  "properties": {
                    "key": "name"
                  }
                }
              ]
            }
          }
        }
      }
    },
    {
      "displayName": "Prompt",
      "name": "prompt",
      "type": "fixedCollection",
      "default": {},
      "options": [
        {
          "displayName": "Messages",
          "name": "messages",
          "values": [
            {
              "displayName": "Role",
              "name": "role",
              "type": "options",
              "options": [
                {
                  "name": "Assistant",
                  "value": "assistant"
                },
                {
                  "name": "System",
                  "value": "system"
                },
                {
                  "name": "User",
                  "value": "user"
                }
              ],
              "default": "user"
            },
            {
              "displayName": "Content",
              "name": "content",
              "type": "string",
              "default": ""
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "chat"
          ],
          "operation": [
            "complete"
          ]
        }
      },
      "typeOptions": {
        "sortable": true,
        "multipleValues": true
      }
    },
    {
      "displayName": "Simplify",
      "name": "simplifyOutput",
      "type": "boolean",
      "default": true,
      "description": "Whether to return a simplified version of the response instead of the raw data",
      "displayOptions": {
        "show": {
          "operation": [
            "complete"
          ],
          "resource": [
            "chat"
          ]
        }
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "description": "Additional options to add",
      "options": [
        {
          "displayName": "Echo Prompt",
          "name": "echo",
          "type": "boolean",
          "description": "Whether the prompt should be echo back in addition to the completion",
          "default": false,
          "displayOptions": {
            "show": {
              "/operation": [
                "complete"
              ]
            }
          },
          "routing": {
            "send": {
              "type": "body",
              "property": "echo"
            }
          }
        },
        {
          "displayName": "Frequency Penalty",
          "name": "frequency_penalty",
          "default": 0,
          "typeOptions": {
            "maxValue": 2,
            "minValue": -2,
            "numberPrecision": 1
          },
          "description": "Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim",
          "type": "number",
          "routing": {
            "send": {
              "type": "body",
              "property": "frequency_penalty"
            }
          }
        },
        {
          "displayName": "Maximum Number of Tokens",
          "name": "maxTokens",
          "default": 16,
          "description": "The maximum number of tokens to generate in the completion. Most models have a context length of 2048 tokens (except for the newest models, which support 32,768).",
          "type": "number",
          "displayOptions": {
            "show": {
              "/operation": [
                "complete"
              ]
            }
          },
          "typeOptions": {
            "maxValue": 32768
          },
          "routing": {
            "send": {
              "type": "body",
              "property": "max_tokens"
            }
          }
        },
        {
          "displayName": "Number of Completions",
          "name": "n",
          "default": 1,
          "description": "How many completions to generate for each prompt. Note: Because this parameter generates many completions, it can quickly consume your token quota. Use carefully and ensure that you have reasonable settings for max_tokens and stop.",
          "type": "number",
          "routing": {
            "send": {
              "type": "body",
              "property": "n"
            }
          }
        },
        {
          "displayName": "Presence Penalty",
          "name": "presence_penalty",
          "default": 0,
          "typeOptions": {
            "maxValue": 2,
            "minValue": -2,
            "numberPrecision": 1
          },
          "description": "Positive values penalize new tokens based on whether they appear in the text so far, increasing the model's likelihood to talk about new topics",
          "type": "number",
          "routing": {
            "send": {
              "type": "body",
              "property": "presence_penalty"
            }
          }
        },
        {
          "displayName": "Sampling Temperature",
          "name": "temperature",
          "default": 1,
          "typeOptions": {
            "maxValue": 1,
            "minValue": 0,
            "numberPrecision": 1
          },
          "description": "Controls randomness: Lowering results in less random completions. As the temperature approaches zero, the model will become deterministic and repetitive.",
          "type": "number",
          "routing": {
            "send": {
              "type": "body",
              "property": "temperature"
            }
          }
        },
        {
          "displayName": "Top P",
          "name": "topP",
          "default": 1,
          "typeOptions": {
            "maxValue": 1,
            "minValue": 0,
            "numberPrecision": 1
          },
          "description": "Controls diversity via nucleus sampling: 0.5 means half of all likelihood-weighted options are considered. We generally recommend altering this or temperature but not both.",
          "type": "number",
          "routing": {
            "send": {
              "type": "body",
              "property": "top_p"
            }
          }
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "complete"
          ],
          "resource": [
            "chat"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "action": "Create an Image",
          "description": "Create an image for a given text",
          "routing": {
            "request": {
              "method": "POST",
              "url": "/v1/images/generations"
            },
            "output": {
              "postReceive": [
                null
              ]
            }
          }
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "image"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Prompt",
      "name": "prompt",
      "type": "string",
      "default": "",
      "description": "A text description of the desired image(s). The maximum length is 1000 characters.",
      "displayOptions": {
        "show": {
          "resource": [
            "image"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Model",
      "name": "model",
      "type": "options",
      "default": "dall-e-2",
      "description": "The model to use for image generation",
      "displayOptions": {
        "show": {
          "resource": [
            "image"
          ],
          "operation": [
            "create"
          ],
          "@version": [
            1
          ]
        }
      },
      "typeOptions": {
        "loadOptions": {
          "routing": {
            "request": {
              "method": "GET",
              "url": "/v1/models"
            },
            "output": {
              "postReceive": [
                {
                  "type": "rootProperty",
                  "properties": {
                    "property": "data"
                  }
                },
                {
                  "type": "filter",
                  "properties": {
                    "pass": "={{ $responseItem.id.startsWith('dall-') }}"
                  }
                },
                {
                  "type": "setKeyValue",
                  "properties": {
                    "name": "={{$responseItem.id}}",
                    "value": "={{$responseItem.id}}"
                  }
                },
                {
                  "type": "sort",
                  "properties": {
                    "key": "name"
                  }
                }
              ]
            }
          }
        }
      }
    },
    {
      "displayName": "Model",
      "name": "imageModel",
      "type": "options",
      "default": "dall-e-2",
      "description": "The model to use for image generation",
      "displayOptions": {
        "show": {
          "resource": [
            "image"
          ],
          "operation": [
            "create"
          ]
        },
        "hide": {
          "@version": [
            1
          ]
        }
      },
      "typeOptions": {
        "loadOptions": {
          "routing": {
            "request": {
              "method": "GET",
              "url": "/v1/models"
            },
            "output": {
              "postReceive": [
                {
                  "type": "rootProperty",
                  "properties": {
                    "property": "data"
                  }
                },
                {
                  "type": "filter",
                  "properties": {
                    "pass": "={{ $responseItem.id.startsWith('dall-') }}"
                  }
                },
                {
                  "type": "setKeyValue",
                  "properties": {
                    "name": "={{$responseItem.id}}",
                    "value": "={{$responseItem.id}}"
                  }
                },
                {
                  "type": "sort",
                  "properties": {
                    "key": "name"
                  }
                }
              ]
            }
          }
        }
      }
    },
    {
      "displayName": "Response Format",
      "name": "responseFormat",
      "type": "options",
      "default": "binaryData",
      "description": "The format in which to return the image(s)",
      "options": [
        {
          "name": "Binary File",
          "value": "binaryData"
        },
        {
          "name": "Image Url",
          "value": "imageUrl"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "image"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "description": "Additional options to add",
      "options": [
        {
          "displayName": "Number of Images",
          "name": "n",
          "default": 1,
          "description": "Number of images to generate",
          "type": "number",
          "typeOptions": {
            "minValue": 1,
            "maxValue": 10
          },
          "routing": {
            "send": {
              "type": "body",
              "property": "n"
            }
          }
        },
        {
          "displayName": "Quality",
          "name": "quality",
          "type": "options",
          "options": [
            {
              "name": "HD",
              "value": "hd"
            },
            {
              "name": "Standard",
              "value": "standard"
            }
          ],
          "displayOptions": {
            "show": {
              "/model": [
                "dall-e-3"
              ]
            }
          },
          "routing": {
            "send": {
              "type": "body",
              "property": "quality"
            }
          },
          "default": "standard"
        },
        {
          "displayName": "Resolution",
          "name": "size",
          "type": "options",
          "options": [
            {
              "name": "256x256",
              "value": "256x256"
            },
            {
              "name": "512x512",
              "value": "512x512"
            },
            {
              "name": "1024x1024",
              "value": "1024x1024"
            }
          ],
          "displayOptions": {
            "show": {
              "/model": [
                "dall-e-2"
              ]
            }
          },
          "routing": {
            "send": {
              "type": "body",
              "property": "size"
            }
          },
          "default": "1024x1024"
        },
        {
          "displayName": "Resolution",
          "name": "size",
          "type": "options",
          "options": [
            {
              "name": "1024x1024",
              "value": "1024x1024"
            },
            {
              "name": "1792x1024",
              "value": "1792x1024"
            },
            {
              "name": "1024x1792",
              "value": "1024x1792"
            }
          ],
          "displayOptions": {
            "show": {
              "/model": [
                "dall-e-3"
              ]
            }
          },
          "routing": {
            "send": {
              "type": "body",
              "property": "size"
            }
          },
          "default": "1024x1024"
        },
        {
          "displayName": "Style",
          "name": "style",
          "type": "options",
          "options": [
            {
              "name": "Natural",
              "value": "natural"
            },
            {
              "name": "Vivid",
              "value": "vivid"
            }
          ],
          "displayOptions": {
            "show": {
              "/model": [
                "dall-e-3"
              ]
            }
          },
          "routing": {
            "send": {
              "type": "body",
              "property": "style"
            }
          },
          "default": "vivid"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "image"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "complete",
      "options": [
        {
          "name": "Complete",
          "value": "complete",
          "action": "Create a Completion",
          "description": "Create one or more completions for a given text",
          "routing": {
            "request": {
              "method": "POST",
              "url": "/v1/completions"
            },
            "output": {
              "postReceive": [
                null
              ]
            }
          }
        },
        {
          "name": "Edit",
          "value": "edit",
          "action": "Create an Edit",
          "description": "Create an edited version for a given text",
          "routing": {
            "request": {
              "method": "POST",
              "url": "/v1/edits"
            },
            "output": {
              "postReceive": [
                null
              ]
            }
          }
        },
        {
          "name": "Moderate",
          "value": "moderate",
          "action": "Create a Moderation",
          "description": "Classify if a text violates OpenAI's content policy",
          "routing": {
            "request": {
              "method": "POST",
              "url": "/v1/moderations"
            },
            "output": {
              "postReceive": [
                null
              ]
            }
          }
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "text"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Model",
      "name": "model",
      "type": "options",
      "default": "gpt-3.5-turbo-instruct",
      "description": "The model which will generate the completion. <a href=\"https://beta.openai.com/docs/models/overview\">Learn more</a>.",
      "displayOptions": {
        "show": {
          "operation": [
            "complete"
          ],
          "resource": [
            "text"
          ]
        }
      },
      "typeOptions": {
        "loadOptions": {
          "routing": {
            "request": {
              "method": "GET",
              "url": "/v1/models"
            },
            "output": {
              "postReceive": [
                {
                  "type": "rootProperty",
                  "properties": {
                    "property": "data"
                  }
                },
                {
                  "type": "filter",
                  "properties": {
                    "pass": "={{ !$responseItem.id.startsWith('audio-') && ($responseItem.id === 'gpt-3.5-turbo-instruct' || !$responseItem.id.startsWith('gpt-') ) && !$responseItem.id.startsWith('dall-') && !$responseItem.id.startsWith('tts-') && !$responseItem.id.startsWith('whisper-') && !['cushman:2020-05-03', 'davinci-if:3.0.0', 'davinci-instruct-beta:2.0.0', 'if'].includes($responseItem.id) && !$responseItem.id.includes('-edit-') && !$responseItem.id.endsWith(':001') }}"
                  }
                },
                {
                  "type": "setKeyValue",
                  "properties": {
                    "name": "={{$responseItem.id}}",
                    "value": "={{$responseItem.id}}"
                  }
                },
                {
                  "type": "sort",
                  "properties": {
                    "key": "name"
                  }
                }
              ]
            }
          }
        }
      }
    },
    {
      "displayName": "Prompt",
      "name": "prompt",
      "type": "string",
      "default": "",
      "description": "The prompt to generate completion(s) for",
      "displayOptions": {
        "show": {
          "resource": [
            "text"
          ],
          "operation": [
            "complete"
          ]
        }
      },
      "typeOptions": {
        "rows": 2
      }
    },
    {
      "displayName": "Model",
      "name": "model",
      "type": "options",
      "default": "text-davinci-edit-001",
      "description": "The model which will generate the edited version. <a href=\"https://beta.openai.com/docs/models/overview\">Learn more</a>.",
      "options": [
        {
          "name": "code-davinci-edit-001",
          "value": "code-davinci-edit-001"
        },
        {
          "name": "text-davinci-edit-001",
          "value": "text-davinci-edit-001"
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "edit"
          ],
          "resource": [
            "text"
          ]
        }
      }
    },
    {
      "displayName": "Input",
      "name": "input",
      "type": "string",
      "default": "",
      "description": "The input text to be edited",
      "displayOptions": {
        "show": {
          "resource": [
            "text"
          ],
          "operation": [
            "edit"
          ]
        }
      }
    },
    {
      "displayName": "Instruction",
      "name": "instruction",
      "type": "string",
      "default": "",
      "description": "The instruction that tells the model how to edit the input text",
      "displayOptions": {
        "show": {
          "resource": [
            "text"
          ],
          "operation": [
            "edit"
          ]
        }
      }
    },
    {
      "displayName": "Model",
      "name": "model",
      "type": "options",
      "default": "text-moderation-latest",
      "description": "The model which will classify the text. <a href=\"https://beta.openai.com/docs/models/overview\">Learn more</a>.",
      "options": [
        {
          "name": "text-moderation-stable",
          "value": "text-moderation-stable"
        },
        {
          "name": "text-moderation-latest",
          "value": "text-moderation-latest"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "text"
          ],
          "operation": [
            "moderate"
          ]
        }
      }
    },
    {
      "displayName": "Input",
      "name": "input",
      "type": "string",
      "default": "",
      "description": "The input text to classify",
      "displayOptions": {
        "show": {
          "resource": [
            "text"
          ],
          "operation": [
            "moderate"
          ]
        }
      }
    },
    {
      "displayName": "Simplify",
      "name": "simplifyOutput",
      "type": "boolean",
      "default": true,
      "description": "Whether to return a simplified version of the response instead of the raw data",
      "displayOptions": {
        "show": {
          "operation": [
            "moderate"
          ],
          "resource": [
            "text"
          ]
        }
      }
    },
    {
      "displayName": "Simplify",
      "name": "simplifyOutput",
      "type": "boolean",
      "default": true,
      "description": "Whether to return a simplified version of the response instead of the raw data",
      "displayOptions": {
        "show": {
          "operation": [
            "complete",
            "edit"
          ],
          "resource": [
            "text"
          ]
        }
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "description": "Additional options to add",
      "options": [
        {
          "displayName": "Echo Prompt",
          "name": "echo",
          "type": "boolean",
          "description": "Whether the prompt should be echo back in addition to the completion",
          "default": false,
          "displayOptions": {
            "show": {
              "/operation": [
                "complete"
              ]
            }
          },
          "routing": {
            "send": {
              "type": "body",
              "property": "echo"
            }
          }
        },
        {
          "displayName": "Frequency Penalty",
          "name": "frequency_penalty",
          "default": 0,
          "typeOptions": {
            "maxValue": 2,
            "minValue": -2,
            "numberPrecision": 1
          },
          "description": "Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim",
          "type": "number",
          "routing": {
            "send": {
              "type": "body",
              "property": "frequency_penalty"
            }
          }
        },
        {
          "displayName": "Maximum Number of Tokens",
          "name": "maxTokens",
          "default": 16,
          "description": "The maximum number of tokens to generate in the completion. Most models have a context length of 2048 tokens (except for the newest models, which support 32,768).",
          "type": "number",
          "displayOptions": {
            "show": {
              "/operation": [
                "complete"
              ]
            }
          },
          "typeOptions": {
            "maxValue": 32768
          },
          "routing": {
            "send": {
              "type": "body",
              "property": "max_tokens"
            }
          }
        },
        {
          "displayName": "Number of Completions",
          "name": "n",
          "default": 1,
          "description": "How many completions to generate for each prompt. Note: Because this parameter generates many completions, it can quickly consume your token quota. Use carefully and ensure that you have reasonable settings for max_tokens and stop.",
          "type": "number",
          "routing": {
            "send": {
              "type": "body",
              "property": "n"
            }
          }
        },
        {
          "displayName": "Presence Penalty",
          "name": "presence_penalty",
          "default": 0,
          "typeOptions": {
            "maxValue": 2,
            "minValue": -2,
            "numberPrecision": 1
          },
          "description": "Positive values penalize new tokens based on whether they appear in the text so far, increasing the model's likelihood to talk about new topics",
          "type": "number",
          "routing": {
            "send": {
              "type": "body",
              "property": "presence_penalty"
            }
          }
        },
        {
          "displayName": "Sampling Temperature",
          "name": "temperature",
          "default": 1,
          "typeOptions": {
            "maxValue": 1,
            "minValue": 0,
            "numberPrecision": 1
          },
          "description": "Controls randomness: Lowering results in less random completions. As the temperature approaches zero, the model will become deterministic and repetitive.",
          "type": "number",
          "routing": {
            "send": {
              "type": "body",
              "property": "temperature"
            }
          }
        },
        {
          "displayName": "Top P",
          "name": "topP",
          "default": 1,
          "typeOptions": {
            "maxValue": 1,
            "minValue": 0,
            "numberPrecision": 1
          },
          "description": "Controls diversity via nucleus sampling: 0.5 means half of all likelihood-weighted options are considered. We generally recommend altering this or temperature but not both.",
          "type": "number",
          "routing": {
            "send": {
              "type": "body",
              "property": "top_p"
            }
          }
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "complete",
            "edit"
          ],
          "resource": [
            "text"
          ]
        }
      }
    }
  ]

operations:
  [
    {
      "operation": "complete",
      "name": "Complete",
      "description": "Create one or more completions for a given text"
    }
  ]


node_type: nodes-base.openThesaurus
package_name: n8n-nodes-base
display_name: OpenThesaurus
description: Get synonmns for German words using the OpenThesaurus API
category: output
development_style: programmatic
version: 1
credentials_required: []
updated_at: 2025-07-01 06:53:38
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: OpenThesaurus node documentation
  description: Learn how to use the OpenThesaurus node in n8n. Follow technical documentation to integrate OpenThesaurus node into your workflows.
  contentType: [integration, reference]
  ---

  # OpenThesaurus node

  Use the OpenThesaurus node to automate work in OpenThesaurus, and integrate OpenThesaurus with other applications. n8n supports synonym look-up for German words. 

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

  /// note | Credentials
  OpenThesaurus node doesn't require authentication. 
  ///

  ## Operations

  * Get synonyms for a German word in German

  ## Templates and examples

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

properties_schema:
  [
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "getSynonyms",
      "options": [
        {
          "name": "Get Synonyms",
          "value": "getSynonyms",
          "description": "Get synonyms for a German word in German",
          "action": "Get synonyms"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "Text",
      "name": "text",
      "type": "string",
      "default": "",
      "description": "The word to get synonyms for",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "getSynonyms"
          ]
        }
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Baseform",
          "name": "baseform",
          "type": "boolean",
          "default": false,
          "description": "Specifies the basic form for the search term if it is not already a basic form"
        },
        {
          "displayName": "Similar",
          "name": "similar",
          "type": "boolean",
          "default": false,
          "description": "This also returns up to five similarly written words for each answer. This is useful to be able to make a suggestion to the user in the event of a possible typing error."
        },
        {
          "displayName": "Starts With",
          "name": "startswith",
          "type": "boolean",
          "default": false,
          "description": "Like substring = true, but only finds words that begin with the specified search term"
        },
        {
          "displayName": "Substring",
          "name": "substring",
          "type": "boolean",
          "default": false,
          "description": "Whether up to ten words are returned for each answer that only contain the search term as a partial word"
        },
        {
          "displayName": "Substring From Results",
          "name": "substringFromResults",
          "type": "number",
          "default": 0,
          "description": "Specifies from which entry the partial word hits are to be returned. Only works together with substring = true."
        },
        {
          "displayName": "Substring Max Results",
          "name": "substringMaxResults",
          "type": "number",
          "typeOptions": {
            "maxValue": 250
          },
          "default": 10,
          "description": "Specifies how many partial word hits should be returned in total. Only works together with substring = true."
        },
        {
          "displayName": "Subsynsets",
          "name": "subsynsets",
          "type": "boolean",
          "default": false,
          "description": "Whether each synonym group has its (optional) sub-terms supplied"
        },
        {
          "displayName": "Supersynsets",
          "name": "supersynsets",
          "type": "boolean",
          "default": false,
          "description": "Whether each synonym group is supplied with its (optional) generic terms"
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "getSynonyms"
          ]
        }
      }
    }
  ]

operations:
  [
    {
      "operation": "getSynonyms",
      "name": "Get Synonyms",
      "description": "Get synonyms for a German word in German"
    }
  ]


node_type: nodes-base.openWeatherMap
package_name: n8n-nodes-base
display_name: OpenWeatherMap
description: Gets current and future weather information
category: input
development_style: programmatic
version: 1
credentials_required:
  [
  {
  "name": "openWeatherMapApi",
  "required": true
  }
  ]

updated_at: 2025-07-01 06:53:38
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: OpenWeatherMap node documentation
  description: Learn how to use the OpenWeatherMap node in n8n. Follow technical documentation to integrate OpenWeatherMap node into your workflows.
  contentType: [integration, reference]
  priority: medium
  ---

  # OpenWeatherMap node

  Use the OpenWeatherMap node to automate work in OpenWeatherMap, and integrate OpenWeatherMap with other applications. n8n supports retrieving current and upcoming weather data with OpenWeatherMap.

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

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

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

  ## Operations

  * Returns the current weather data
  * Returns the weather data for the next 5 days

  ## Templates and examples

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

properties_schema:
  [
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "currentWeather",
      "options": [
        {
          "name": "Current Weather",
          "value": "currentWeather",
          "description": "Returns the current weather data",
          "action": "Return current weather data"
        },
        {
          "name": "5 Day Forecast",
          "value": "5DayForecast",
          "description": "Returns the weather data for the next 5 days",
          "action": "Return weather data for the next 5 days"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "Format",
      "name": "format",
      "type": "options",
      "default": "metric",
      "description": "The format in which format the data should be returned",
      "options": [
        {
          "name": "Imperial",
          "value": "imperial",
          "description": "Fahrenheit | miles/hour"
        },
        {
          "name": "Metric",
          "value": "metric",
          "description": "Celsius | meter/sec"
        },
        {
          "name": "Scientific",
          "value": "standard",
          "description": "Kelvin | meter/sec"
        }
      ]
    },
    {
      "displayName": "Location Selection",
      "name": "locationSelection",
      "type": "options",
      "default": "cityName",
      "description": "How to define the location for which to return the weather",
      "options": [
        {
          "name": "City Name",
          "value": "cityName"
        },
        {
          "name": "City ID",
          "value": "cityId"
        },
        {
          "name": "Coordinates",
          "value": "coordinates"
        },
        {
          "name": "Zip Code",
          "value": "zipCode"
        }
      ]
    },
    {
      "displayName": "City",
      "name": "cityName",
      "type": "string",
      "default": "",
      "description": "The name of the city to return the weather of",
      "required": true,
      "displayOptions": {
        "show": {
          "locationSelection": [
            "cityName"
          ]
        }
      }
    },
    {
      "displayName": "City ID",
      "name": "cityId",
      "type": "number",
      "default": 160001123,
      "description": "The ID of city to return the weather of. List can be downloaded here: http://bulk.openweathermap.org/sample/.",
      "required": true,
      "displayOptions": {
        "show": {
          "locationSelection": [
            "cityId"
          ]
        }
      }
    },
    {
      "displayName": "Latitude",
      "name": "latitude",
      "type": "string",
      "default": "",
      "description": "The latitude of the location to return the weather of",
      "required": true,
      "displayOptions": {
        "show": {
          "locationSelection": [
            "coordinates"
          ]
        }
      }
    },
    {
      "displayName": "Longitude",
      "name": "longitude",
      "type": "string",
      "default": "",
      "description": "The longitude of the location to return the weather of",
      "required": true,
      "displayOptions": {
        "show": {
          "locationSelection": [
            "coordinates"
          ]
        }
      }
    },
    {
      "displayName": "Zip Code",
      "name": "zipCode",
      "type": "string",
      "default": "",
      "description": "The ID of city to return the weather of. List can be downloaded here: http://bulk.openweathermap.org/sample/.",
      "required": true,
      "displayOptions": {
        "show": {
          "locationSelection": [
            "zipCode"
          ]
        }
      }
    },
    {
      "displayName": "Language",
      "name": "language",
      "type": "string",
      "default": "",
      "description": "The two letter language code to get your output in (eg. en, de, ...)."
    }
  ]

operations:
  [
    {
      "operation": "currentWeather",
      "name": "Current Weather",
      "description": "Returns the current weather data"
    },
    {
      "operation": "5DayForecast",
      "name": "5 Day Forecast",
      "description": "Returns the weather data for the next 5 days"
    }
  ]


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

updated_at: 2025-07-01 06:53:38
properties_schema:
  [
    {
      "displayName": "Orbit has been shutdown and will no longer function from July 11th, You can read more <a target=\"_blank\" href=\"https://orbit.love/blog/orbit-is-joining-postman\">here</a>.",
      "name": "deprecated",
      "type": "notice",
      "default": ""
    },
    {
      "displayName": "Resource",
      "name": "resource",
      "type": "options",
      "default": "member",
      "options": [
        {
          "name": "Activity",
          "value": "activity"
        },
        {
          "name": "Member",
          "value": "member"
        },
        {
          "name": "Note",
          "value": "note"
        },
        {
          "name": "Post",
          "value": "post"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create an activity for a member",
          "action": "Create an activity"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get many activities",
          "action": "Get many activities"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "activity"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Workspace Name or ID",
      "name": "workspaceId",
      "type": "options",
      "default": "Deprecated",
      "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "activity"
          ],
          "operation": [
            "create"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getWorkspaces"
      }
    },
    {
      "displayName": "Member ID",
      "name": "memberId",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "activity"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Title",
      "name": "title",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "activity"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Activity Type Name or ID",
          "name": "activityType",
          "type": "options",
          "typeOptions": {
            "loadOptionsMethod": "getActivityTypes"
          },
          "default": "Deprecated",
          "description": "A user-defined way to group activities of the same nature. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        },
        {
          "displayName": "Description",
          "name": "description",
          "type": "string",
          "default": "",
          "description": "A description of the activity; displayed in the timeline"
        },
        {
          "displayName": "Key",
          "name": "key",
          "type": "string",
          "default": "",
          "description": "Supply a key that must be unique or leave blank to have one generated"
        },
        {
          "displayName": "Link",
          "name": "link",
          "type": "string",
          "default": "",
          "description": "A URL for the activity; displayed in the timeline"
        },
        {
          "displayName": "Link Text",
          "name": "linkText",
          "type": "string",
          "default": "",
          "description": "The text for the timeline link"
        },
        {
          "displayName": "Occurred At",
          "name": "occurredAt",
          "type": "dateTime",
          "default": "",
          "description": "The date and time the activity occurred; defaults to now"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "activity"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Workspace Name or ID",
      "name": "workspaceId",
      "type": "options",
      "default": "Deprecated",
      "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "activity"
          ],
          "operation": [
            "getAll"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getWorkspaces"
      }
    },
    {
      "displayName": "Return All",
      "name": "returnAll",
      "type": "boolean",
      "default": false,
      "description": "Whether to return all results or only up to a given limit",
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "activity"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 100,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "activity"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 500
      }
    },
    {
      "displayName": "Filters",
      "name": "filters",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Member ID",
          "name": "memberId",
          "type": "string",
          "default": "",
          "description": "When set the post will be filtered by the member ID"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "activity"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "get",
      "options": [
        {
          "name": "Create or Update",
          "value": "upsert",
          "description": "Create a new member, or update the current one if it already exists (upsert)",
          "action": "Create or update a member"
        },
        {
          "name": "Delete",
          "value": "delete",
          "description": "Delete a member",
          "action": "Delete a member"
        },
        {
          "name": "Get",
          "value": "get",
          "description": "Get a member",
          "action": "Get a member"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get many members in a workspace",
          "action": "Get many members"
        },
        {
          "name": "Lookup",
          "value": "lookup",
          "description": "Lookup a member by identity",
          "action": "Lookup a member"
        },
        {
          "name": "Update",
          "value": "update",
          "description": "Update a member",
          "action": "Update a member"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "member"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Workspace Name or ID",
      "name": "workspaceId",
      "type": "options",
      "default": "Deprecated",
      "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "member"
          ],
          "operation": [
            "delete"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getWorkspaces"
      }
    },
    {
      "displayName": "Member ID",
      "name": "memberId",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "member"
          ],
          "operation": [
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "Workspace Name or ID",
      "name": "workspaceId",
      "type": "options",
      "default": "Deprecated",
      "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "member"
          ],
          "operation": [
            "get"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getWorkspaces"
      }
    },
    {
      "displayName": "Member ID",
      "name": "memberId",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "member"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Resolve Identities",
      "name": "resolveIdentities",
      "type": "boolean",
      "default": false,
      "description": "By default, the response just includes the reference of the identity. When set to true the identities will be resolved automatically.",
      "displayOptions": {
        "show": {
          "operation": [
            "get"
          ],
          "resource": [
            "member"
          ]
        }
      }
    },
    {
      "displayName": "Workspace Name or ID",
      "name": "workspaceId",
      "type": "options",
      "default": "Deprecated",
      "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "member"
          ],
          "operation": [
            "getAll"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getWorkspaces"
      }
    },
    {
      "displayName": "Return All",
      "name": "returnAll",
      "type": "boolean",
      "default": false,
      "description": "Whether to return all results or only up to a given limit",
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "member"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 100,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "member"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 500
      }
    },
    {
      "displayName": "Resolve Identities",
      "name": "resolveIdentities",
      "type": "boolean",
      "default": false,
      "description": "By default, the response just includes the reference of the identity. When set to true the identities will be resolved automatically.",
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "member"
          ]
        }
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Sort By",
          "name": "sort",
          "type": "string",
          "default": "",
          "description": "Name of the field the response will be sorted by"
        },
        {
          "displayName": "Sort Direction",
          "name": "direction",
          "type": "options",
          "options": [
            {
              "name": "ASC",
              "value": "ASC"
            },
            {
              "name": "DESC",
              "value": "DESC"
            }
          ],
          "default": ""
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "member"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Workspace Name or ID",
      "name": "workspaceId",
      "type": "options",
      "default": "Deprecated",
      "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "member"
          ],
          "operation": [
            "lookup"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getWorkspaces"
      }
    },
    {
      "displayName": "Source",
      "name": "source",
      "type": "options",
      "default": "",
      "description": "Set to github, twitter, email, discourse or the source of any identities you've manually created",
      "options": [
        {
          "name": "Discourse",
          "value": "discourse"
        },
        {
          "name": "Email",
          "value": "email"
        },
        {
          "name": "GitHub",
          "value": "github"
        },
        {
          "name": "Twitter",
          "value": "twitter"
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "member"
          ],
          "operation": [
            "lookup"
          ]
        }
      }
    },
    {
      "displayName": "Search By",
      "name": "searchBy",
      "type": "options",
      "default": "",
      "options": [
        {
          "name": "Username",
          "value": "username"
        },
        {
          "name": "ID",
          "value": "id"
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "member"
          ],
          "operation": [
            "lookup"
          ],
          "source": [
            "discourse",
            "github",
            "twitter"
          ]
        }
      }
    },
    {
      "displayName": "ID",
      "name": "id",
      "type": "string",
      "default": "",
      "description": "The username at the source",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "member"
          ],
          "operation": [
            "lookup"
          ],
          "searchBy": [
            "id"
          ],
          "source": [
            "discourse",
            "github",
            "twitter"
          ]
        }
      }
    },
    {
      "displayName": "Username",
      "name": "username",
      "type": "string",
      "default": "",
      "description": "The username at the source",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "member"
          ],
          "operation": [
            "lookup"
          ],
          "searchBy": [
            "username"
          ],
          "source": [
            "discourse",
            "github",
            "twitter"
          ]
        }
      }
    },
    {
      "displayName": "Email",
      "name": "email",
      "type": "string",
      "default": "",
      "description": "The email address",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "member"
          ],
          "operation": [
            "lookup"
          ],
          "source": [
            "email"
          ]
        }
      }
    },
    {
      "displayName": "Host",
      "name": "host",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "member"
          ],
          "operation": [
            "lookup"
          ],
          "source": [
            "discourse"
          ]
        }
      }
    },
    {
      "displayName": "Workspace Name or ID",
      "name": "workspaceId",
      "type": "options",
      "default": "Deprecated",
      "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "member"
          ],
          "operation": [
            "update"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getWorkspaces"
      }
    },
    {
      "displayName": "Member ID",
      "name": "memberId",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "member"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Update Fields",
      "name": "updateFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Bio",
          "name": "bio",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Birthday",
          "name": "birthday",
          "type": "dateTime",
          "default": ""
        },
        {
          "displayName": "Company",
          "name": "company",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Location",
          "name": "location",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Name",
          "name": "name",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Pronouns",
          "name": "pronouns",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Shipping Address",
          "name": "shippingAddress",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Slug",
          "name": "slug",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Tags to Add",
          "name": "tagsToAdd",
          "type": "string",
          "default": "",
          "description": "Adds tags to member; comma-separated string or array"
        },
        {
          "displayName": "Tag List",
          "name": "tagList",
          "type": "string",
          "default": "",
          "description": "Replaces all tags for the member; comma-separated string or array"
        },
        {
          "displayName": "T-Shirt",
          "name": "tShirt",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Teammate",
          "name": "teammate",
          "type": "boolean",
          "default": false
        },
        {
          "displayName": "URL",
          "name": "url",
          "type": "string",
          "default": ""
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "member"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Workspace Name or ID",
      "name": "workspaceId",
      "type": "options",
      "default": "Deprecated",
      "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "member"
          ],
          "operation": [
            "upsert"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getWorkspaces"
      }
    },
    {
      "displayName": "Identity",
      "name": "identityUi",
      "type": "fixedCollection",
      "default": {},
      "description": "The identity is used to find the member. If no member exists, a new member will be created and linked to the provided identity.",
      "options": [
        {
          "displayName": "Identity",
          "name": "identityValue",
          "values": [
            {
              "displayName": "Source",
              "name": "source",
              "type": "options",
              "options": [
                {
                  "name": "Discourse",
                  "value": "discourse"
                },
                {
                  "name": "Email",
                  "value": "email"
                },
                {
                  "name": "GitHub",
                  "value": "github"
                },
                {
                  "name": "Twitter",
                  "value": "twitter"
                }
              ],
              "default": "",
              "description": "Set to github, twitter, email, discourse or the source of any identities you've manually created"
            },
            {
              "displayName": "Search By",
              "name": "searchBy",
              "type": "options",
              "options": [
                {
                  "name": "Username",
                  "value": "username"
                },
                {
                  "name": "ID",
                  "value": "id"
                }
              ],
              "default": "",
              "required": true,
              "displayOptions": {
                "show": {
                  "source": [
                    "discourse",
                    "github",
                    "twitter"
                  ]
                }
              }
            },
            {
              "displayName": "ID",
              "name": "id",
              "type": "string",
              "default": "",
              "required": true,
              "displayOptions": {
                "show": {
                  "searchBy": [
                    "id"
                  ],
                  "source": [
                    "discourse",
                    "github",
                    "twitter"
                  ]
                }
              },
              "description": "The username at the source"
            },
            {
              "displayName": "Username",
              "name": "username",
              "type": "string",
              "default": "",
              "required": true,
              "displayOptions": {
                "show": {
                  "searchBy": [
                    "username"
                  ],
                  "source": [
                    "discourse",
                    "github",
                    "twitter"
                  ]
                }
              },
              "description": "The username at the source"
            },
            {
              "displayName": "Email",
              "name": "email",
              "type": "string",
              "placeholder": "name@email.com",
              "default": "",
              "required": true,
              "displayOptions": {
                "show": {
                  "source": [
                    "email"
                  ]
                }
              }
            },
            {
              "displayName": "Host",
              "name": "host",
              "type": "string",
              "default": "",
              "required": true,
              "displayOptions": {
                "show": {
                  "source": [
                    "discourse"
                  ]
                }
              }
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "member"
          ],
          "operation": [
            "upsert"
          ]
        }
      },
      "typeOptions": {
        "multipleValues": false
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Bio",
          "name": "bio",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Birthday",
          "name": "birthday",
          "type": "dateTime",
          "default": ""
        },
        {
          "displayName": "Company",
          "name": "company",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Location",
          "name": "location",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Name",
          "name": "name",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Pronouns",
          "name": "pronouns",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Shipping Address",
          "name": "shippingAddress",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Slug",
          "name": "slug",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Tags to Add",
          "name": "tagsToAdd",
          "type": "string",
          "default": "",
          "description": "Adds tags to member; comma-separated string or array"
        },
        {
          "displayName": "Tag List",
          "name": "tagList",
          "type": "string",
          "default": "",
          "description": "Replaces all tags for the member; comma-separated string or array"
        },
        {
          "displayName": "T-Shirt",
          "name": "tShirt",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Teammate",
          "name": "teammate",
          "type": "boolean",
          "default": false
        },
        {
          "displayName": "URL",
          "name": "url",
          "type": "string",
          "default": ""
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "member"
          ],
          "operation": [
            "upsert"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create a note",
          "action": "Create a note"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get many notes for a member",
          "action": "Get many notes"
        },
        {
          "name": "Update",
          "value": "update",
          "description": "Update a note",
          "action": "Update a note"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "note"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Workspace Name or ID",
      "name": "workspaceId",
      "type": "options",
      "default": "Deprecated",
      "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "note"
          ],
          "operation": [
            "create"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getWorkspaces"
      }
    },
    {
      "displayName": "Member ID",
      "name": "memberId",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "note"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Note",
      "name": "note",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "note"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Workspace Name or ID",
      "name": "workspaceId",
      "type": "options",
      "default": "Deprecated",
      "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "note"
          ],
          "operation": [
            "getAll"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getWorkspaces"
      }
    },
    {
      "displayName": "Member ID",
      "name": "memberId",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "note"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Return All",
      "name": "returnAll",
      "type": "boolean",
      "default": false,
      "description": "Whether to return all results or only up to a given limit",
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "note"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 100,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "note"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 500
      }
    },
    {
      "displayName": "Resolve Member",
      "name": "resolveMember",
      "type": "boolean",
      "default": false,
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "note"
          ]
        }
      }
    },
    {
      "displayName": "Workspace Name or ID",
      "name": "workspaceId",
      "type": "options",
      "default": "Deprecated",
      "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "note"
          ],
          "operation": [
            "update"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getWorkspaces"
      }
    },
    {
      "displayName": "Member ID",
      "name": "memberId",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "note"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Note ID",
      "name": "noteId",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "note"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Note",
      "name": "note",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "note"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create a post",
          "action": "Create a post"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get many posts",
          "action": "Get many posts"
        },
        {
          "name": "Delete",
          "value": "delete",
          "description": "Delete a post",
          "action": "Delete a post"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "post"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Workspace Name or ID",
      "name": "workspaceId",
      "type": "options",
      "default": "Deprecated",
      "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "post"
          ],
          "operation": [
            "create"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getWorkspaces"
      }
    },
    {
      "displayName": "Member ID",
      "name": "memberId",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "post"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "URL",
      "name": "url",
      "type": "string",
      "default": "",
      "description": "Supply any URL and Orbit will do its best job to parse out a title, description, and image",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "post"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Occurred At",
          "name": "publishedAt",
          "type": "dateTime",
          "default": ""
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "post"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Workspace Name or ID",
      "name": "workspaceId",
      "type": "options",
      "default": "Deprecated",
      "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "post"
          ],
          "operation": [
            "getAll"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getWorkspaces"
      }
    },
    {
      "displayName": "Return All",
      "name": "returnAll",
      "type": "boolean",
      "default": false,
      "description": "Whether to return all results or only up to a given limit",
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "post"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 100,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "post"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 500
      }
    },
    {
      "displayName": "Filters",
      "name": "filters",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Member ID",
          "name": "memberId",
          "type": "string",
          "default": "",
          "description": "When set the post will be filtered by the member ID"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "post"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Workspace Name or ID",
      "name": "workspaceId",
      "type": "options",
      "default": "Deprecated",
      "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "post"
          ],
          "operation": [
            "delete"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getWorkspaces"
      }
    },
    {
      "displayName": "Member ID",
      "name": "memberId",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "post"
          ],
          "operation": [
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "Post ID",
      "name": "postId",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "delete"
          ],
          "resource": [
            "post"
          ]
        }
      }
    }
  ]

operations:
  [
    {
      "operation": "create",
      "name": "Create",
      "description": "Create an activity for a member"
    },
    {
      "operation": "getAll",
      "name": "Get Many",
      "description": "Get many activities"
    }
  ]


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

updated_at: 2025-07-01 06:53:38
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: Oura node documentation
  description: Learn how to use the Oura node in n8n. Follow technical documentation to integrate Oura node into your workflows.
  contentType: [integration, reference]
  ---

  # Oura node

  Use the Oura node to automate work in Oura, and integrate Oura with other applications. n8n has built-in support for a wide range of Oura features, including getting profiles, and summaries. 

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

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

  ## Operations

  * Profile
      * Get the user's personal information.
  * Summary
      * Get the user's activity summary.
      * Get the user's readiness summary.
      * Get the user's sleep summary

  ## Templates and examples

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

properties_schema:
  [
    {
      "displayName": "Resource",
      "name": "resource",
      "type": "options",
      "default": "summary",
      "options": [
        {
          "name": "Profile",
          "value": "profile"
        },
        {
          "name": "Summary",
          "value": "summary"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "get",
      "options": [
        {
          "name": "Get",
          "value": "get",
          "description": "Get the user's personal information",
          "action": "Get a profile"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "profile"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "getSleep",
      "options": [
        {
          "name": "Get Activity Summary",
          "value": "getActivity",
          "description": "Get the user's activity summary",
          "action": "Get activity summary"
        },
        {
          "name": "Get Readiness Summary",
          "value": "getReadiness",
          "description": "Get the user's readiness summary",
          "action": "Get readiness summary"
        },
        {
          "name": "Get Sleep Periods",
          "value": "getSleep",
          "description": "Get the user's sleep summary",
          "action": "Get sleep summary"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "summary"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Return All",
      "name": "returnAll",
      "type": "boolean",
      "default": false,
      "description": "Whether to return all results or only up to a given limit",
      "displayOptions": {
        "show": {
          "resource": [
            "summary"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 5,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "summary"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 10
      }
    },
    {
      "displayName": "Filters",
      "name": "filters",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "End Date",
          "name": "end",
          "type": "dateTime",
          "default": "",
          "description": "End date for the summary retrieval. If omitted, it defaults to the current day."
        },
        {
          "displayName": "Start Date",
          "name": "start",
          "type": "dateTime",
          "default": "",
          "description": "Start date for the summary retrieval. If omitted, it defaults to a week ago."
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "summary"
          ]
        }
      }
    }
  ]

operations:
  [
    {
      "operation": "get",
      "name": "Get",
      "description": "Get the user's personal information"
    }
  ]


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

updated_at: 2025-07-01 06:53:38
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: Paddle node documentation
  description: Learn how to use the Paddle node in n8n. Follow technical documentation to integrate Paddle node into your workflows.
  contentType: [integration, reference]
  ---

  # Paddle node

  Use the Paddle node to automate work in Paddle, and integrate Paddle with other applications. n8n has built-in support for a wide range of Paddle features, including creating, updating, and getting coupons, as well as getting plans, products, and users. 

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

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

  ## Operations

  * Coupon
      * Create a coupon.
      * Get all coupons.
      * Update a coupon.
  * Payment
      * Get all payment.
      * Reschedule payment.
  * Plan
      * Get a plan.
      * Get all plans.
  * Product
      * Get all products.
  * User
      * Get all users

  ## Templates and examples

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

properties_schema:
  [
    {
      "displayName": "Resource",
      "name": "resource",
      "type": "options",
      "default": "coupon",
      "options": [
        {
          "name": "Coupon",
          "value": "coupon"
        },
        {
          "name": "Payment",
          "value": "payment"
        },
        {
          "name": "Plan",
          "value": "plan"
        },
        {
          "name": "Product",
          "value": "product"
        },
        {
          "name": "User",
          "value": "user"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create a coupon",
          "action": "Create a coupon"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get many coupons",
          "action": "Get many coupons"
        },
        {
          "name": "Update",
          "value": "update",
          "description": "Update a coupon",
          "action": "Update a coupon"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "coupon"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Coupon Type",
      "name": "couponType",
      "type": "options",
      "default": "checkout",
      "description": "Either product (valid for specified products or subscription plans) or checkout (valid for any checkout)",
      "options": [
        {
          "name": "Checkout",
          "value": "checkout"
        },
        {
          "name": "Product",
          "value": "product"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "coupon"
          ],
          "operation": [
            "create"
          ],
          "jsonParameters": [
            false
          ]
        }
      }
    },
    {
      "displayName": "Product Names or IDs",
      "name": "productIds",
      "type": "multiOptions",
      "default": [],
      "description": "Comma-separated list of product IDs. Required if coupon_type is product. Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "coupon"
          ],
          "operation": [
            "create"
          ],
          "couponType": [
            "product"
          ],
          "jsonParameters": [
            false
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getProducts"
      }
    },
    {
      "displayName": "Discount Type",
      "name": "discountType",
      "type": "options",
      "default": "flat",
      "description": "Either flat or percentage",
      "options": [
        {
          "name": "Flat",
          "value": "flat"
        },
        {
          "name": "Percentage",
          "value": "percentage"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "coupon"
          ],
          "operation": [
            "create"
          ],
          "jsonParameters": [
            false
          ]
        }
      }
    },
    {
      "displayName": "Discount Amount Currency",
      "name": "discountAmount",
      "type": "number",
      "default": 1,
      "description": "Discount amount in currency",
      "displayOptions": {
        "show": {
          "resource": [
            "coupon"
          ],
          "operation": [
            "create"
          ],
          "discountType": [
            "flat"
          ],
          "jsonParameters": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1
      }
    },
    {
      "displayName": "Discount Amount %",
      "name": "discountAmount",
      "type": "number",
      "default": 1,
      "description": "Discount amount in percentage",
      "displayOptions": {
        "show": {
          "resource": [
            "coupon"
          ],
          "operation": [
            "create"
          ],
          "discountType": [
            "percentage"
          ],
          "jsonParameters": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 100
      }
    },
    {
      "displayName": "Currency",
      "name": "currency",
      "type": "options",
      "default": "EUR",
      "description": "The currency must match the balance currency specified in your account",
      "options": [
        {
          "name": "ARS",
          "value": "ARS"
        },
        {
          "name": "AUD",
          "value": "AUD"
        },
        {
          "name": "BRL",
          "value": "BRL"
        },
        {
          "name": "CAD",
          "value": "CAD"
        },
        {
          "name": "CHF",
          "value": "CHF"
        },
        {
          "name": "CNY",
          "value": "CNY"
        },
        {
          "name": "CZK",
          "value": "CZK"
        },
        {
          "name": "DKK",
          "value": "DKK"
        },
        {
          "name": "EUR",
          "value": "EUR"
        },
        {
          "name": "GBP",
          "value": "GBP"
        },
        {
          "name": "HKD",
          "value": "HKD"
        },
        {
          "name": "HUF",
          "value": "HUF"
        },
        {
          "name": "INR",
          "value": "INR"
        },
        {
          "name": "JPY",
          "value": "JPY"
        },
        {
          "name": "KRW",
          "value": "KRW"
        },
        {
          "name": "MXN",
          "value": "MXN"
        },
        {
          "name": "NOK",
          "value": "NOK"
        },
        {
          "name": "NZD",
          "value": "NZD"
        },
        {
          "name": "PLN",
          "value": "PLN"
        },
        {
          "name": "RUB",
          "value": "RUB"
        },
        {
          "name": "SEK",
          "value": "SEK"
        },
        {
          "name": "SGD",
          "value": "SGD"
        },
        {
          "name": "THB",
          "value": "THB"
        },
        {
          "name": "TWD",
          "value": "TWD"
        },
        {
          "name": "USD",
          "value": "USD"
        },
        {
          "name": "ZAR",
          "value": "ZAR"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "coupon"
          ],
          "operation": [
            "create"
          ],
          "discountType": [
            "flat"
          ],
          "jsonParameters": [
            false
          ]
        }
      }
    },
    {
      "displayName": "JSON Parameters",
      "name": "jsonParameters",
      "type": "boolean",
      "default": false,
      "displayOptions": {
        "show": {
          "resource": [
            "coupon"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFieldsJson",
      "type": "json",
      "default": "",
      "description": "Attributes in JSON form",
      "displayOptions": {
        "show": {
          "resource": [
            "coupon"
          ],
          "operation": [
            "create"
          ],
          "jsonParameters": [
            true
          ]
        }
      },
      "typeOptions": {
        "alwaysOpenEditWindow": true
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Allowed Uses",
          "name": "allowedUses",
          "type": "number",
          "default": 1,
          "description": "Number of times a coupon can be used in a checkout. This will be set to 999,999 by default, if not specified."
        },
        {
          "displayName": "Coupon Code",
          "name": "couponCode",
          "type": "string",
          "default": "",
          "description": "Will be randomly generated if not specified"
        },
        {
          "displayName": "Coupon Prefix",
          "name": "couponPrefix",
          "type": "string",
          "default": "",
          "description": "Prefix for generated codes. Not valid if coupon_code is specified."
        },
        {
          "displayName": "Description",
          "name": "description",
          "type": "string",
          "default": "",
          "description": "Description of the coupon. This will be displayed in the Seller Dashboard."
        },
        {
          "displayName": "Expires",
          "name": "expires",
          "type": "dateTime",
          "default": "",
          "description": "The coupon will expire on the date at 00:00:00 UTC"
        },
        {
          "displayName": "Group",
          "name": "group",
          "type": "string",
          "typeOptions": {
            "minValue": 1,
            "maxValue": 50
          },
          "default": "",
          "description": "The name of the coupon group this coupon should be assigned to"
        },
        {
          "displayName": "Number of Coupons",
          "name": "numberOfCoupons",
          "type": "number",
          "default": 1,
          "description": "Number of coupons to generate. Not valid if coupon_code is specified."
        },
        {
          "displayName": "Recurring",
          "name": "recurring",
          "type": "boolean",
          "default": false,
          "description": "If the coupon is used on subscription products, this indicates whether the discount should apply to recurring payments after the initial purchase"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "coupon"
          ],
          "operation": [
            "create"
          ],
          "jsonParameters": [
            false
          ]
        }
      }
    },
    {
      "displayName": "Product ID",
      "name": "productId",
      "type": "string",
      "default": "",
      "description": "The specific product/subscription ID",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "coupon"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Return All",
      "name": "returnAll",
      "type": "boolean",
      "default": false,
      "description": "Whether to return all results or only up to a given limit",
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "coupon"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 100,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "coupon"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 500
      }
    },
    {
      "displayName": "Update By",
      "name": "updateBy",
      "type": "options",
      "default": "couponCode",
      "description": "Either flat or percentage",
      "options": [
        {
          "name": "Coupon Code",
          "value": "couponCode"
        },
        {
          "name": "Group",
          "value": "group"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "coupon"
          ],
          "operation": [
            "update"
          ],
          "jsonParameters": [
            false
          ]
        }
      }
    },
    {
      "displayName": "Coupon Code",
      "name": "couponCode",
      "type": "string",
      "default": "",
      "description": "Identify the coupon to update",
      "displayOptions": {
        "show": {
          "resource": [
            "coupon"
          ],
          "operation": [
            "update"
          ],
          "updateBy": [
            "couponCode"
          ],
          "jsonParameters": [
            false
          ]
        }
      }
    },
    {
      "displayName": "Group",
      "name": "group",
      "type": "string",
      "default": "",
      "description": "The name of the group of coupons you want to update",
      "displayOptions": {
        "show": {
          "resource": [
            "coupon"
          ],
          "operation": [
            "update"
          ],
          "updateBy": [
            "group"
          ],
          "jsonParameters": [
            false
          ]
        }
      }
    },
    {
      "displayName": "JSON Parameters",
      "name": "jsonParameters",
      "type": "boolean",
      "default": false,
      "displayOptions": {
        "show": {
          "resource": [
            "coupon"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFieldsJson",
      "type": "json",
      "default": "",
      "description": "Attributes in JSON form",
      "displayOptions": {
        "show": {
          "resource": [
            "coupon"
          ],
          "operation": [
            "update"
          ],
          "jsonParameters": [
            true
          ]
        }
      },
      "typeOptions": {
        "alwaysOpenEditWindow": true
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Allowed Uses",
          "name": "allowedUses",
          "type": "number",
          "default": 1,
          "description": "Number of times a coupon can be used in a checkout. This will be set to 999,999 by default, if not specified."
        },
        {
          "displayName": "Discount",
          "name": "discount",
          "type": "fixedCollection",
          "default": {},
          "options": [
            {
              "displayName": "Discount Properties",
              "name": "discountProperties",
              "values": [
                {
                  "displayName": "Currency",
                  "name": "currency",
                  "type": "options",
                  "default": "EUR",
                  "description": "The currency must match the balance currency specified in your account",
                  "displayOptions": {
                    "show": {
                      "discountType": [
                        "flat"
                      ]
                    }
                  },
                  "options": [
                    {
                      "name": "ARS",
                      "value": "ARS"
                    },
                    {
                      "name": "AUD",
                      "value": "AUD"
                    },
                    {
                      "name": "BRL",
                      "value": "BRL"
                    },
                    {
                      "name": "CAD",
                      "value": "CAD"
                    },
                    {
                      "name": "CHF",
                      "value": "CHF"
                    },
                    {
                      "name": "CNY",
                      "value": "CNY"
                    },
                    {
                      "name": "CZK",
                      "value": "CZK"
                    },
                    {
                      "name": "DKK",
                      "value": "DKK"
                    },
                    {
                      "name": "EUR",
                      "value": "EUR"
                    },
                    {
                      "name": "GBP",
                      "value": "GBP"
                    },
                    {
                      "name": "HKD",
                      "value": "HKD"
                    },
                    {
                      "name": "HUF",
                      "value": "HUF"
                    },
                    {
                      "name": "INR",
                      "value": "INR"
                    },
                    {
                      "name": "JPY",
                      "value": "JPY"
                    },
                    {
                      "name": "KRW",
                      "value": "KRW"
                    },
                    {
                      "name": "MXN",
                      "value": "MXN"
                    },
                    {
                      "name": "NOK",
                      "value": "NOK"
                    },
                    {
                      "name": "NZD",
                      "value": "NZD"
                    },
                    {
                      "name": "PLN",
                      "value": "PLN"
                    },
                    {
                      "name": "RUB",
                      "value": "RUB"
                    },
                    {
                      "name": "SEK",
                      "value": "SEK"
                    },
                    {
                      "name": "SGD",
                      "value": "SGD"
                    },
                    {
                      "name": "THB",
                      "value": "THB"
                    },
                    {
                      "name": "TWD",
                      "value": "TWD"
                    },
                    {
                      "name": "USD",
                      "value": "USD"
                    },
                    {
                      "name": "ZAR",
                      "value": "ZAR"
                    }
                  ]
                },
                {
                  "displayName": "Discount Amount Currency",
                  "name": "discountAmount",
                  "type": "number",
                  "default": "",
                  "description": "Discount amount",
                  "displayOptions": {
                    "show": {
                      "discountType": [
                        "flat"
                      ]
                    }
                  },
                  "typeOptions": {
                    "minValue": 0
                  }
                },
                {
                  "displayName": "Discount Amount Percentage",
                  "name": "discountAmount",
                  "type": "number",
                  "default": "",
                  "description": "Discount amount",
                  "displayOptions": {
                    "show": {
                      "discountType": [
                        "percentage"
                      ]
                    }
                  },
                  "typeOptions": {
                    "minValue": 0,
                    "maxValue": 100
                  }
                },
                {
                  "displayName": "Discount Type",
                  "name": "discountType",
                  "type": "options",
                  "default": "flat",
                  "description": "Either flat or percentage",
                  "options": [
                    {
                      "name": "Flat",
                      "value": "flat"
                    },
                    {
                      "name": "Percentage",
                      "value": "percentage"
                    }
                  ]
                }
              ]
            }
          ]
        },
        {
          "displayName": "Expires",
          "name": "expires",
          "type": "dateTime",
          "default": "",
          "description": "The coupon will expire on the date at 00:00:00 UTC"
        },
        {
          "displayName": "New Coupon Code",
          "name": "newCouponCode",
          "type": "string",
          "default": "",
          "description": "New code to rename the coupon to"
        },
        {
          "displayName": "New Group Name",
          "name": "newGroup",
          "type": "string",
          "typeOptions": {
            "minValue": 1,
            "maxValue": 50
          },
          "default": "",
          "description": "New group name to move coupon to"
        },
        {
          "displayName": "Product IDs",
          "name": "productIds",
          "type": "string",
          "default": "",
          "description": "Comma-separated list of products e.g. 499531,1234,123546. If blank then remove associated products."
        },
        {
          "displayName": "Recurring",
          "name": "recurring",
          "type": "boolean",
          "default": false,
          "description": "If the coupon is used on subscription products, this indicates whether the discount should apply to recurring payments after the initial purchase"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "coupon"
          ],
          "operation": [
            "update"
          ],
          "jsonParameters": [
            false
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "getAll",
      "options": [
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get many payments",
          "action": "Get many payments"
        },
        {
          "name": "Reschedule",
          "value": "reschedule",
          "description": "Reschedule payment",
          "action": "Reschedule a payment"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "payment"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Return All",
      "name": "returnAll",
      "type": "boolean",
      "default": false,
      "description": "Whether to return all results or only up to a given limit",
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "payment"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 100,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "payment"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 500
      }
    },
    {
      "displayName": "JSON Parameters",
      "name": "jsonParameters",
      "type": "boolean",
      "default": false,
      "displayOptions": {
        "show": {
          "resource": [
            "payment"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFieldsJson",
      "type": "json",
      "default": "",
      "description": "Attributes in JSON form",
      "displayOptions": {
        "show": {
          "resource": [
            "payment"
          ],
          "operation": [
            "getAll"
          ],
          "jsonParameters": [
            true
          ]
        }
      },
      "typeOptions": {
        "alwaysOpenEditWindow": true
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Date From",
          "name": "from",
          "type": "dateTime",
          "default": "",
          "description": "Payment starting from date"
        },
        {
          "displayName": "Date To",
          "name": "to",
          "type": "dateTime",
          "default": "",
          "description": "Payment up until date"
        },
        {
          "displayName": "Is Paid",
          "name": "isPaid",
          "type": "boolean",
          "default": false,
          "description": "Whether payment is paid"
        },
        {
          "displayName": "Plan ID",
          "name": "plan",
          "type": "string",
          "default": "",
          "description": "Filter: The product/plan ID (single or comma-separated values)"
        },
        {
          "displayName": "Subscription ID",
          "name": "subscriptionId",
          "type": "number",
          "default": "",
          "description": "A specific user subscription ID"
        },
        {
          "displayName": "State",
          "name": "state",
          "type": "options",
          "default": "active",
          "description": "Filter: The user subscription status. Returns all active, past_due, trialing and paused subscription plans if not specified.",
          "options": [
            {
              "name": "Active",
              "value": "active"
            },
            {
              "name": "Past Due",
              "value": "past_due"
            },
            {
              "name": "Paused",
              "value": "paused"
            },
            {
              "name": "Trialing",
              "value": "trialing"
            }
          ]
        },
        {
          "displayName": "One Off Charge",
          "name": "isOneOffCharge",
          "type": "boolean",
          "default": false
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "payment"
          ],
          "operation": [
            "getAll"
          ],
          "jsonParameters": [
            false
          ]
        }
      }
    },
    {
      "displayName": "Payment Name or ID",
      "name": "paymentId",
      "type": "options",
      "default": "",
      "description": "The upcoming subscription payment ID. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "payment"
          ],
          "operation": [
            "reschedule"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getPayments"
      }
    },
    {
      "displayName": "Date",
      "name": "date",
      "type": "dateTime",
      "default": "",
      "description": "Date you want to move the payment to",
      "displayOptions": {
        "show": {
          "resource": [
            "payment"
          ],
          "operation": [
            "reschedule"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "get",
      "options": [
        {
          "name": "Get",
          "value": "get",
          "description": "Get a plan",
          "action": "Get a plan"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get many plans",
          "action": "Get many plans"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "plan"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Plan ID",
      "name": "planId",
      "type": "string",
      "default": "",
      "description": "Filter: The subscription plan ID",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "plan"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Return All",
      "name": "returnAll",
      "type": "boolean",
      "default": false,
      "description": "Whether to return all results or only up to a given limit",
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "plan"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 100,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "plan"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 500
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "getAll",
      "options": [
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get many products",
          "action": "Get many products"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "product"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Return All",
      "name": "returnAll",
      "type": "boolean",
      "default": false,
      "description": "Whether to return all results or only up to a given limit",
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "product"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 100,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "product"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 500
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "getAll",
      "options": [
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get many users",
          "action": "Get many users"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Return All",
      "name": "returnAll",
      "type": "boolean",
      "default": false,
      "description": "Whether to return all results or only up to a given limit",
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 100,
      "description": "Max number of results to return",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 200
      }
    },
    {
      "displayName": "JSON Parameters",
      "name": "jsonParameters",
      "type": "boolean",
      "default": false,
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFieldsJson",
      "type": "json",
      "default": "",
      "description": "Attributes in JSON form",
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "getAll"
          ],
          "jsonParameters": [
            true
          ]
        }
      },
      "typeOptions": {
        "alwaysOpenEditWindow": true
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Plan ID",
          "name": "planId",
          "type": "string",
          "default": "",
          "description": "Filter: The subscription plan ID"
        },
        {
          "displayName": "Subscription ID",
          "name": "subscriptionId",
          "type": "string",
          "default": "",
          "description": "A specific user subscription ID"
        },
        {
          "displayName": "State",
          "name": "state",
          "type": "options",
          "default": "active",
          "description": "Filter: The user subscription status. Returns all active, past_due, trialing and paused subscription plans if not specified.",
          "options": [
            {
              "name": "Active",
              "value": "active"
            },
            {
              "name": "Past Due",
              "value": "past_due"
            },
            {
              "name": "Paused",
              "value": "paused"
            },
            {
              "name": "Trialing",
              "value": "trialing"
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "getAll"
          ],
          "jsonParameters": [
            false
          ]
        }
      }
    }
  ]

operations:
  [
    {
      "operation": "create",
      "name": "Create",
      "description": "Create a coupon"
    },
    {
      "operation": "getAll",
      "name": "Get Many",
      "description": "Get many coupons"
    },
    {
      "operation": "update",
      "name": "Update",
      "description": "Update a coupon"
    }
  ]


node_type: nodes-base.pagerDuty
package_name: n8n-nodes-base
display_name: PagerDuty
description: Consume PagerDuty API
category: output
development_style: programmatic
version: 1
updated_at: 2025-07-01 06:53:38
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: PagerDuty node documentation
  description: Learn how to use the PagerDuty node in n8n. Follow technical documentation to integrate PagerDuty node into your workflows.
  contentType: [integration, reference]
  ---

  # PagerDuty node

  Use the PagerDuty node to automate work in PagerDuty, and integrate PagerDuty with other applications. n8n has built-in support for a wide range of PagerDuty features, including creating incident notes, as well as updating, and getting all log entries and users. 

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

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

  ## Operations

  * Incident
      * Create an incident
      * Get an incident
      * Get all incidents
      * Update an incident
  * Incident Note
      * Create an incident note
      * Get all incident's notes
  * Log Entry
      * Get a log entry
      * Get all log entries
  * User
      * Get a user

  ## Templates and examples

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

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

properties_schema:
  [
    {
      "displayName": "Authentication",
      "name": "authentication",
      "type": "options",
      "default": "apiToken",
      "options": [
        {
          "name": "API Token",
          "value": "apiToken"
        },
        {
          "name": "OAuth2",
          "value": "oAuth2"
        }
      ]
    },
    {
      "displayName": "Resource",
      "name": "resource",
      "type": "options",
      "default": "incident",
      "options": [
        {
          "name": "Incident",
          "value": "incident"
        },
        {
          "name": "Incident Note",
          "value": "incidentNote"
        },
        {
          "name": "Log Entry",
          "value": "logEntry"
        },
        {
          "name": "User",
          "value": "user"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create an incident",
          "action": "Create an incident"
        },
        {
          "name": "Get",
          "value": "get",
          "description": "Get an incident",
          "action": "Get an incident"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get many incidents",
          "action": "Get many incidents"
        },
        {
          "name": "Update",
          "value": "update",
          "description": "Update an incident",
          "action": "Update an incident"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "incident"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Title",
      "name": "title",
      "type": "string",
      "default": "",
      "description": "A succinct description of the nature, symptoms, cause, or effect of the incident",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "incident"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Service Name or ID",
      "name": "serviceId",
      "type": "options",
      "default": "",
      "description": "The incident will be created on this service. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "incident"
          ],
          "operation": [
            "create"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getServices"
      }
    },
    {
      "displayName": "Email",
      "name": "email",
      "type": "string",
      "default": "",
      "description": "The email address of a valid user associated with the account making the request",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "incident"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Escalation Policy Name or ID",
          "name": "escalationPolicyId",
          "type": "options",
          "typeOptions": {
            "loadOptionsMethod": "getEscalationPolicies"
          },
          "default": "",
          "description": "Delegate this incident to the specified escalation policy. Cannot be specified if an assignee is given. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        },
        {
          "displayName": "Incident Details",
          "name": "details",
          "type": "string",
          "default": "",
          "description": "Additional details about the incident which will go in the body"
        },
        {
          "displayName": "Incident Key",
          "name": "incidentKey",
          "type": "string",
          "default": "",
          "description": "Sending subsequent requests referencing the same service and with the same incident_key will result in those requests being rejected if an open incident matches that incident_key"
        },
        {
          "displayName": "Priority Name or ID",
          "name": "priorityId",
          "type": "options",
          "typeOptions": {
            "loadOptionsMethod": "getPriorities"
          },
          "default": "",
          "description": "The incident will be created on this service. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        },
        {
          "displayName": "Urgency",
          "name": "urgency",
          "type": "options",
          "options": [
            {
              "name": "Hight",
              "value": "high"
            },
            {
              "name": "Low",
              "value": "low"
            }
          ],
          "default": "",
          "description": "The urgency of the incident"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "incident"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Conference Bridge",
      "name": "conferenceBridgeUi",
      "type": "fixedCollection",
      "default": {},
      "options": [
        {
          "displayName": "Conference Bridge",
          "name": "conferenceBridgeValues",
          "values": [
            {
              "displayName": "Conference Number",
              "name": "conferenceNumber",
              "type": "string",
              "default": "",
              "description": "Phone numbers should be formatted like +1 415-555-1212,,,,1234#, where a comma (,) represents a one-second wait and pound (#) completes access code input"
            },
            {
              "displayName": "Conference URL",
              "name": "conferenceUrl",
              "type": "string",
              "default": "",
              "description": "An URL for the conference bridge. This could be a link to a web conference or Slack channel."
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "incident"
          ],
          "operation": [
            "create"
          ]
        }
      },
      "typeOptions": {
        "multipleValues": false
      }
    },
    {
      "displayName": "Incident ID",
      "name": "incidentId",
      "type": "string",
      "default": "",
      "description": "Unique identifier for the incident",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "incident"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Return All",
      "name": "returnAll",
      "type": "boolean",
      "default": false,
      "description": "Whether to return all results or only up to a given limit",
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "incident"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 100,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "incident"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 500
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Date Range",
          "name": "dateRange",
          "type": "options",
          "options": [
            {
              "name": "All",
              "value": "all"
            }
          ],
          "default": "",
          "description": "When set to all, the since and until parameters and defaults are ignored"
        },
        {
          "displayName": "Incident Key",
          "name": "incidentKey",
          "type": "string",
          "default": "",
          "description": "Incident de-duplication key. Incidents with child alerts do not have an incident key; querying by incident key will return incidents whose alerts have alert_key matching the given incident key."
        },
        {
          "displayName": "Include",
          "name": "include",
          "type": "multiOptions",
          "options": [
            {
              "name": "Acknowledgers",
              "value": "acknowledgers"
            },
            {
              "name": "Assignees",
              "value": "assignees"
            },
            {
              "name": "Conference Bridge",
              "value": "conferenceBridge"
            },
            {
              "name": "Escalation Policies",
              "value": "escalationPolicies"
            },
            {
              "name": "First Trigger Log Entries",
              "value": "firstTriggerLogEntries"
            },
            {
              "name": "Priorities",
              "value": "priorities"
            },
            {
              "name": "Services",
              "value": "services"
            },
            {
              "name": "Teams",
              "value": "teams"
            },
            {
              "name": "Users",
              "value": "users"
            }
          ],
          "default": [],
          "description": "Additional details to include"
        },
        {
          "displayName": "Service Names or IDs",
          "name": "serviceIds",
          "type": "multiOptions",
          "typeOptions": {
            "loadOptionsMethod": "getServices"
          },
          "default": [],
          "description": "Returns only the incidents associated with the passed service(s). Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        },
        {
          "displayName": "Since",
          "name": "since",
          "type": "dateTime",
          "default": "",
          "description": "The start of the date range over which you want to search. (the limit on date ranges is 6 months)."
        },
        {
          "displayName": "Sort By",
          "name": "sortBy",
          "type": "string",
          "default": "",
          "placeholder": "created_at:asc,resolved_at:desc",
          "description": "Used to specify both the field you wish to sort the results on (incident_number/created_at/resolved_at/urgency), as well as the direction (asc/desc) of the results. The sort_by field and direction should be separated by a colon. A maximum of two fields can be included, separated by a comma."
        },
        {
          "displayName": "Statuses",
          "name": "statuses",
          "type": "multiOptions",
          "options": [
            {
              "name": "Acknowledged",
              "value": "acknowledged"
            },
            {
              "name": "Resolved",
              "value": "resolved"
            },
            {
              "name": "Triggered",
              "value": "triggered"
            }
          ],
          "default": [],
          "description": "Returns only the incidents associated with the passed service(s)"
        },
        {
          "displayName": "Team IDs",
          "name": "teamIds",
          "type": "string",
          "default": "",
          "description": "Team IDs. Only results related to these teams will be returned. Account must have the teams ability to use this parameter. (multiples IDs can be added separated by comma)"
        },
        {
          "displayName": "Timezone Name or ID",
          "name": "timeZone",
          "type": "options",
          "typeOptions": {
            "loadOptionsMethod": "getTimezones"
          },
          "default": "",
          "description": "Time zone in which dates in the result will be rendered. If not set dates will return UTC. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        },
        {
          "displayName": "Until",
          "name": "until",
          "type": "dateTime",
          "default": "",
          "description": "The end of the date range over which you want to search. (the limit on date ranges is 6 months)."
        },
        {
          "displayName": "Urgencies",
          "name": "urgencies",
          "type": "multiOptions",
          "options": [
            {
              "name": "High",
              "value": "high"
            },
            {
              "name": "Low",
              "value": "low"
            }
          ],
          "default": [],
          "description": "Urgencies of the incidents to be returned. Defaults to all urgencies. Account must have the urgencies ability to do this"
        },
        {
          "displayName": "User IDs",
          "name": "userIds",
          "type": "string",
          "default": "",
          "description": "Returns only the incidents currently assigned to the passed user(s). This expects one or more user IDs (multiple IDs can be added separated by comma)."
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "incident"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Incident ID",
      "name": "incidentId",
      "type": "string",
      "default": "",
      "description": "Unique identifier for the incident",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "incident"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Email",
      "name": "email",
      "type": "string",
      "default": "",
      "description": "The email address of a valid user associated with the account making the request",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "incident"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Update Fields",
      "name": "updateFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Escalation Level",
          "name": "escalationLevel",
          "type": "number",
          "default": 0,
          "typeOptions": {
            "minValue": 0
          },
          "description": "Escalate the incident to this level in the escalation policy"
        },
        {
          "displayName": "Escalation Policy Name or ID",
          "name": "escalationPolicyId",
          "type": "options",
          "typeOptions": {
            "loadOptionsMethod": "getEscalationPolicies"
          },
          "default": "",
          "description": "Delegate this incident to the specified escalation policy. Cannot be specified if an assignee is given. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        },
        {
          "displayName": "Priority Name or ID",
          "name": "priorityId",
          "type": "options",
          "typeOptions": {
            "loadOptionsMethod": "getPriorities"
          },
          "default": "",
          "description": "The incident will be created on this service. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        },
        {
          "displayName": "Resolution",
          "name": "resolution",
          "type": "string",
          "default": "",
          "description": "The resolution for this incident if status is set to resolved"
        },
        {
          "displayName": "Status",
          "name": "status",
          "type": "options",
          "options": [
            {
              "name": "Acknowledged",
              "value": "acknowledged"
            },
            {
              "name": "Resolved",
              "value": "resolved"
            }
          ],
          "default": "",
          "description": "The new status of the incident"
        },
        {
          "displayName": "Title",
          "name": "title",
          "type": "string",
          "default": "",
          "description": "A succinct description of the nature, symptoms, cause, or effect of the incident"
        },
        {
          "displayName": "Urgency",
          "name": "urgency",
          "type": "options",
          "options": [
            {
              "name": "High",
              "value": "high"
            },
            {
              "name": "Low",
              "value": "low"
            }
          ],
          "default": "",
          "description": "The urgency of the incident"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "incident"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Conference Bridge",
      "name": "conferenceBridgeUi",
      "type": "fixedCollection",
      "default": {},
      "options": [
        {
          "displayName": "Conference Bridge",
          "name": "conferenceBridgeValues",
          "values": [
            {
              "displayName": "Conference Number",
              "name": "conferenceNumber",
              "type": "string",
              "default": "",
              "description": "Phone numbers should be formatted like +1 415-555-1212,,,,1234#, where a comma (,) represents a one-second wait and pound (#) completes access code input"
            },
            {
              "displayName": "Conference URL",
              "name": "conferenceUrl",
              "type": "string",
              "default": "",
              "description": "An URL for the conference bridge. This could be a link to a web conference or Slack channel."
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "incident"
          ],
          "operation": [
            "update"
          ]
        }
      },
      "typeOptions": {
        "multipleValues": false
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create a incident note",
          "action": "Create an incident note"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get many incident's notes",
          "action": "Get many incident notes"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "incidentNote"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Incident ID",
      "name": "incidentId",
      "type": "string",
      "default": "",
      "description": "Unique identifier for the incident",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "incidentNote"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Content",
      "name": "content",
      "type": "string",
      "default": "",
      "description": "The note content",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "incidentNote"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Email",
      "name": "email",
      "type": "string",
      "default": "",
      "description": "The email address of a valid user associated with the account making the request",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "incidentNote"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Incident ID",
      "name": "incidentId",
      "type": "string",
      "default": "",
      "description": "Unique identifier for the incident",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "incidentNote"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Return All",
      "name": "returnAll",
      "type": "boolean",
      "default": false,
      "description": "Whether to return all results or only up to a given limit",
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "incidentNote"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 100,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "incidentNote"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 500
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "get",
      "options": [
        {
          "name": "Get",
          "value": "get",
          "description": "Get a log entry",
          "action": "Get a log entry"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get many log entries",
          "action": "Get many log entries"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "logEntry"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Log Entry ID",
      "name": "logEntryId",
      "type": "string",
      "default": "",
      "description": "Unique identifier for the log entry",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "logEntry"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Return All",
      "name": "returnAll",
      "type": "boolean",
      "default": false,
      "description": "Whether to return all results or only up to a given limit",
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "logEntry"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 100,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "logEntry"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 500
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Include",
          "name": "include",
          "type": "multiOptions",
          "options": [
            {
              "name": "Channels",
              "value": "channels"
            },
            {
              "name": "Incidents",
              "value": "incidents"
            },
            {
              "name": "Services",
              "value": "services"
            },
            {
              "name": "Teams",
              "value": "teams"
            }
          ],
          "default": [],
          "description": "Additional details to include"
        },
        {
          "displayName": "Is Overview",
          "name": "isOverview",
          "type": "boolean",
          "default": false,
          "description": "Whether to return a subset of log entries that show only the most important changes to the incident"
        },
        {
          "displayName": "Since",
          "name": "since",
          "type": "dateTime",
          "default": "",
          "description": "The start of the date range over which you want to search. (the limit on date ranges is 6 months)."
        },
        {
          "displayName": "Timezone Name or ID",
          "name": "timeZone",
          "type": "options",
          "typeOptions": {
            "loadOptionsMethod": "getTimezones"
          },
          "default": "",
          "description": "Time zone in which dates in the result will be rendered. If not set dates will return UTC. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        },
        {
          "displayName": "Until",
          "name": "until",
          "type": "dateTime",
          "default": "",
          "description": "The end of the date range over which you want to search. (the limit on date ranges is 6 months)."
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "logEntry"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "get",
      "options": [
        {
          "name": "Get",
          "value": "get",
          "description": "Get a user",
          "action": "Get a user"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "User ID",
      "name": "userId",
      "type": "string",
      "default": "",
      "description": "Unique identifier for the user",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "get"
          ]
        }
      }
    }
  ]

operations:
  [
    {
      "operation": "create",
      "name": "Create",
      "description": "Create an incident"
    },
    {
      "operation": "get",
      "name": "Get",
      "description": "Get an incident"
    },
    {
      "operation": "getAll",
      "name": "Get Many",
      "description": "Get many incidents"
    },
    {
      "operation": "update",
      "name": "Update",
      "description": "Update an incident"
    }
  ]

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


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

updated_at: 2025-07-01 06:53:38
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: PayPal node documentation
  description: Learn how to use the PayPal node in n8n. Follow technical documentation to integrate PayPal node into your workflows.
  contentType: [integration, reference]
  ---

  # PayPal node

  Use the PayPal node to automate work in PayPal, and integrate PayPal with other applications. n8n has built-in support for a wide range of PayPal features, including creating a batch payout and canceling unclaimed payout items. 

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

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

  ## Operations

  * Payout
      * Create a batch payout
      * Show batch payout details
  * Payout Item
      * Cancels an unclaimed payout item
      * Show payout item details

  ## Templates and examples

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

properties_schema:
  [
    {
      "displayName": "Resource",
      "name": "resource",
      "type": "options",
      "default": "payout",
      "options": [
        {
          "name": "Payout",
          "value": "payout"
        },
        {
          "name": "Payout Item",
          "value": "payoutItem"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create a batch payout",
          "action": "Create a payout"
        },
        {
          "name": "Get",
          "value": "get",
          "description": "Show batch payout details",
          "action": "Get a payout"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "payout"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "get",
      "options": [
        {
          "name": "Cancel",
          "value": "cancel",
          "description": "Cancels an unclaimed payout item",
          "action": "Cancel a payout item"
        },
        {
          "name": "Get",
          "value": "get",
          "description": "Show payout item details",
          "action": "Get a payout item"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "payoutItem"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Sender Batch ID",
      "name": "senderBatchId",
      "type": "string",
      "default": "",
      "description": "A sender-specified ID number. Tracks the payout in an accounting system.",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "payout"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "JSON Parameters",
      "name": "jsonParameters",
      "type": "boolean",
      "default": false,
      "displayOptions": {
        "show": {
          "resource": [
            "payout"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Items",
      "name": "itemsUi",
      "type": "fixedCollection",
      "default": {},
      "options": [
        {
          "name": "itemsValues",
          "displayName": "Item",
          "values": [
            {
              "displayName": "Recipient Type",
              "name": "recipientType",
              "type": "options",
              "options": [
                {
                  "name": "Phone",
                  "value": "phone",
                  "description": "The unencrypted phone number"
                },
                {
                  "name": "Email",
                  "value": "email",
                  "description": "The unencrypted email"
                },
                {
                  "name": "PayPal ID",
                  "value": "paypalId",
                  "description": "The encrypted PayPal account number"
                }
              ],
              "default": "email",
              "description": "The ID type that identifies the recipient of the payment"
            },
            {
              "displayName": "Receiver Value",
              "name": "receiverValue",
              "type": "string",
              "required": true,
              "default": "",
              "description": "The receiver of the payment. Corresponds to the recipient_type value in the request. Max length: 127 characters."
            },
            {
              "displayName": "Currency",
              "name": "currency",
              "type": "options",
              "options": [
                {
                  "name": "Australian Dollar",
                  "value": "AUD"
                },
                {
                  "name": "Brazilian Real",
                  "value": "BRL"
                },
                {
                  "name": "Canadian Dollar",
                  "value": "CAD"
                },
                {
                  "name": "Czech Koruna",
                  "value": "CZK"
                },
                {
                  "name": "Danish Krone",
                  "value": "DKK"
                },
                {
                  "name": "Euro",
                  "value": "EUR"
                },
                {
                  "name": "United States Dollar",
                  "value": "USD"
                }
              ],
              "default": "USD"
            },
            {
              "displayName": "Amount",
              "name": "amount",
              "type": "string",
              "required": true,
              "default": "",
              "description": "The value, which might be"
            },
            {
              "displayName": "Note",
              "name": "note",
              "type": "string",
              "default": "",
              "description": "The sender-specified note for notifications. Supports up to 4000 ASCII characters and 1000 non-ASCII characters."
            },
            {
              "displayName": "Sender Item ID",
              "name": "senderItemId",
              "type": "string",
              "default": "",
              "description": "The sender-specified ID number. Tracks the payout in an accounting system."
            },
            {
              "displayName": "Recipient Wallet",
              "name": "recipientWallet",
              "type": "options",
              "options": [
                {
                  "name": "PayPal",
                  "value": "paypal",
                  "description": "PayPal Wallet"
                },
                {
                  "name": "Venmo",
                  "value": "venmo",
                  "description": "Venmo Wallet"
                }
              ],
              "default": "paypal"
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "payout"
          ],
          "operation": [
            "create"
          ],
          "jsonParameters": [
            false
          ]
        }
      },
      "typeOptions": {
        "multipleValues": true
      }
    },
    {
      "displayName": "Items",
      "name": "itemsJson",
      "type": "json",
      "default": "",
      "description": "An array of individual payout items",
      "displayOptions": {
        "show": {
          "resource": [
            "payout"
          ],
          "operation": [
            "create"
          ],
          "jsonParameters": [
            true
          ]
        }
      },
      "typeOptions": {
        "alwaysOpenEditWindow": true
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Email Subject",
          "name": "emailSubject",
          "type": "string",
          "default": "",
          "description": "The subject line for the email that PayPal sends when payment for a payout item completes. The subject line is the same for all recipients. Max length: 255 characters."
        },
        {
          "displayName": "Email Message",
          "name": "emailMessage",
          "type": "string",
          "default": "",
          "description": "The email message that PayPal sends when the payout item completes. The message is the same for all recipients."
        },
        {
          "displayName": "Note",
          "name": "note",
          "type": "string",
          "default": "",
          "description": "The payouts and item-level notes are concatenated in the email. Max length: 1000 characters."
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "payout"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Payout Batch ID",
      "name": "payoutBatchId",
      "type": "string",
      "default": "",
      "description": "The ID of the payout for which to show details",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "payout"
          ],
          "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": [
            "payout"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 100,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "payout"
          ],
          "operation": [
            "get"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "maxValue": 1000,
        "minValue": 1
      }
    },
    {
      "displayName": "Payout Item ID",
      "name": "payoutItemId",
      "type": "string",
      "default": "",
      "description": "The ID of the payout item for which to show details",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "payoutItem"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Payout Item ID",
      "name": "payoutItemId",
      "type": "string",
      "default": "",
      "description": "The ID of the payout item to cancel",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "payoutItem"
          ],
          "operation": [
            "cancel"
          ]
        }
      }
    }
  ]

operations:
  [
    {
      "operation": "create",
      "name": "Create",
      "description": "Create a batch payout"
    },
    {
      "operation": "get",
      "name": "Get",
      "description": "Show batch payout details"
    }
  ]


node_type: nodes-base.payPalTrigger
package_name: n8n-nodes-base
display_name: PayPal Trigger
description: Handle PayPal events via webhooks
category: trigger
development_style: programmatic
version: 1
operations: []
credentials_required:
  [
  {
  "name": "payPalApi",
  "required": true
  }
  ]

updated_at: 2025-07-01 06:53:38
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: PayPal Trigger node documentation
  description: Learn how to use the PayPal Trigger node in n8n. Follow technical documentation to integrate PayPal Trigger node into your workflows.
  contentType: [integration, reference]
  ---

  # PayPal Trigger node

  [PayPal](https://paypal.com){:target=_blank .external-link} is a digital payment service that supports online fund transfers that customers can use when shopping online.

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

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

properties_schema:
  [
    {
      "displayName": "Event Names or IDs",
      "name": "events",
      "type": "multiOptions",
      "default": [],
      "description": "The event to listen to. Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
      "options": [],
      "required": true,
      "typeOptions": {
        "loadOptionsMethod": "getEvents"
      }
    }
  ]


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

updated_at: 2025-07-01 06:53:38
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: Peekalink node documentation
  description: Learn how to use the Peekalink node in n8n. Follow technical documentation to integrate Peekalink node into your workflows.
  contentType: [integration, reference]
  ---

  # Peekalink node

  Use the Peekalink node to automate work in Peekalink, and integrate Peekalink with other applications. n8n supports checking, and reviewing links with Peekalink.

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

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

  ## Operations

  * Check whether preview for a given link is available
  * Return the preview for a link

  ## Templates and examples

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

properties_schema:
  [
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "preview",
      "options": [
        {
          "name": "Is Available",
          "value": "isAvailable",
          "description": "Check whether preview for a given link is available",
          "action": "Check whether the preview for a given link is available"
        },
        {
          "name": "Preview",
          "value": "preview",
          "description": "Return the preview for a link",
          "action": "Return the preview for a link"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "URL",
      "name": "url",
      "type": "string",
      "default": "",
      "required": true
    }
  ]

operations:
  [
    {
      "operation": "isAvailable",
      "name": "Is Available",
      "description": "Check whether preview for a given link is available"
    },
    {
      "operation": "preview",
      "name": "Preview",
      "description": "Return the preview for a link"
    }
  ]


node_type: nodes-base.perplexity
package_name: n8n-nodes-base
display_name: Perplexity
description: Interact with the Perplexity API to generate AI responses with citations
category: transform
development_style: programmatic
version: 1
credentials_required:
  [
  {
  "name": "perplexityApi",
  "required": true
  }
  ]

updated_at: 2025-07-01 06:53:38
properties_schema:
  [
    {
      "displayName": "Resource",
      "name": "resource",
      "type": "hidden",
      "default": "chat",
      "options": [
        {
          "name": "Chat",
          "value": "chat"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "complete",
      "options": [
        {
          "name": "Message a Model",
          "value": "complete",
          "action": "Message a model",
          "description": "Create one or more completions for a given text",
          "routing": {
            "request": {
              "method": "POST",
              "url": "/chat/completions"
            },
            "output": {
              "postReceive": [
                null
              ]
            }
          }
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "chat"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Model",
      "name": "model",
      "type": "options",
      "default": "r1-1776",
      "description": "The model which will generate the completion",
      "options": [
        {
          "name": "R1-1776",
          "value": "r1-1776"
        },
        {
          "name": "Sonar",
          "value": "sonar"
        },
        {
          "name": "Sonar Deep Research",
          "value": "sonar-deep-research"
        },
        {
          "name": "Sonar Pro",
          "value": "sonar-pro"
        },
        {
          "name": "Sonar Reasoning",
          "value": "sonar-reasoning"
        },
        {
          "name": "Sonar Reasoning Pro",
          "value": "sonar-reasoning-pro"
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "chat"
          ],
          "operation": [
            "complete"
          ]
        }
      }
    },
    {
      "displayName": "Messages",
      "name": "messages",
      "type": "fixedCollection",
      "default": {
        "message": [
          {
            "role": "user",
            "content": ""
          }
        ]
      },
      "description": "Any optional system messages must be sent first, followed by alternating user and assistant messages",
      "options": [
        {
          "displayName": "Message",
          "name": "message",
          "values": [
            {
              "displayName": "Text",
              "name": "content",
              "type": "string",
              "default": "",
              "description": "The content of the message to be sent",
              "typeOptions": {
                "rows": 2
              }
            },
            {
              "displayName": "Role",
              "name": "role",
              "required": true,
              "type": "options",
              "options": [
                {
                  "name": "Assistant",
                  "value": "assistant",
                  "description": "Tell the model to adopt a specific tone or personality. Must alternate with user messages."
                },
                {
                  "name": "System",
                  "value": "system",
                  "description": "Set the models behavior or context. Must come before user and assistant messages."
                },
                {
                  "name": "User",
                  "value": "user",
                  "description": "Send a message as a user and get a response from the model"
                }
              ],
              "default": "user",
              "description": "Role in shaping the model's response, it tells the model how it should behave and interact with the user"
            }
          ]
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "chat"
          ],
          "operation": [
            "complete"
          ]
        }
      },
      "typeOptions": {
        "multipleValues": true,
        "sortable": true
      }
    },
    {
      "displayName": "Simplify Output",
      "name": "simplify",
      "type": "boolean",
      "default": false,
      "description": "Whether to return only essential fields (ID, citations, message)",
      "displayOptions": {
        "show": {
          "resource": [
            "chat"
          ],
          "operation": [
            "complete"
          ]
        }
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Frequency Penalty",
          "name": "frequencyPenalty",
          "type": "number",
          "default": 1,
          "typeOptions": {
            "minValue": 1
          },
          "description": "Values greater than 1.0 penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim",
          "routing": {
            "send": {
              "type": "body",
              "property": "frequency_penalty"
            }
          }
        },
        {
          "displayName": "Maximum Number of Tokens",
          "name": "maxTokens",
          "type": "number",
          "default": 1,
          "description": "The maximum number of tokens to generate in the completion. The number of tokens requested plus the number of prompt tokens sent in messages must not exceed the context window token limit of model requested.",
          "routing": {
            "send": {
              "type": "body",
              "property": "max_tokens"
            }
          }
        },
        {
          "displayName": "Output Randomness (Temperature)",
          "name": "temperature",
          "type": "number",
          "default": 0.2,
          "description": "The amount of randomness in the response, valued between 0 inclusive and 2 exclusive. Higher values are more random, and lower values are more deterministic.",
          "typeOptions": {
            "minValue": 0,
            "maxValue": 1.99
          },
          "routing": {
            "send": {
              "type": "body",
              "property": "temperature"
            }
          }
        },
        {
          "displayName": "Top K",
          "name": "topK",
          "type": "number",
          "default": 0,
          "description": "The number of tokens to keep for highest Top K filtering, specified as an integer between 0 and 2048 inclusive. If set to 0, Top K filtering is disabled. We recommend either altering Top K or Top P, but not both.",
          "typeOptions": {
            "minValue": 0,
            "maxValue": 2048
          },
          "routing": {
            "send": {
              "type": "body",
              "property": "top_k"
            }
          }
        },
        {
          "displayName": "Top P",
          "name": "topP",
          "type": "number",
          "default": 0.9,
          "description": "The nucleus sampling threshold, valued between 0 and 1 inclusive. For each subsequent token, the model considers the results of the tokens with Top P probability mass. We recommend either altering Top K or Top P, but not both.",
          "typeOptions": {
            "minValue": 0,
            "maxValue": 1
          },
          "routing": {
            "send": {
              "type": "body",
              "property": "top_p"
            }
          }
        },
        {
          "displayName": "Presence Penalty",
          "name": "presencePenalty",
          "type": "number",
          "default": 0,
          "description": "A value between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the text so far, increasing the model's likelihood to talk about new topics.",
          "typeOptions": {
            "minValue": -2,
            "maxValue": 2
          },
          "routing": {
            "send": {
              "type": "body",
              "property": "presence_penalty"
            }
          }
        },
        {
          "displayName": "Return Images",
          "name": "returnImages",
          "type": "boolean",
          "default": false,
          "description": "Whether or not a request to an online model should return images. Requires Perplexity API usage Tier-2.",
          "routing": {
            "send": {
              "type": "body",
              "property": "return_images"
            }
          }
        },
        {
          "displayName": "Return Related Questions",
          "name": "returnRelatedQuestions",
          "type": "boolean",
          "default": false,
          "description": "Whether or not a request to an online model should return related questions. Requires Perplexity API usage Tier-2.",
          "routing": {
            "send": {
              "type": "body",
              "property": "return_related_questions"
            }
          }
        },
        {
          "displayName": "Search Domain Filter",
          "name": "searchDomainFilter",
          "type": "string",
          "default": "",
          "description": "Limit the citations used by the online model to URLs from the specified domains. For blacklisting, add a <code>-</code> to the beginning of the domain string (e.g., <code>-domain1</code>). Currently limited to 3 domains. Requires Perplexity API usage Tier-3.",
          "placeholder": "e.g. domain1,domain2,-domain3",
          "routing": {
            "send": {
              "type": "body",
              "property": "search_domain_filter",
              "value": "={{ $value.split(\",\").map(domain => domain.trim()) }}"
            }
          }
        },
        {
          "displayName": "Search Recency Filter",
          "name": "searchRecency",
          "type": "options",
          "options": [
            {
              "name": "Day",
              "value": "day"
            },
            {
              "name": "Hour",
              "value": "hour"
            },
            {
              "name": "Month",
              "value": "month"
            },
            {
              "name": "Week",
              "value": "week"
            }
          ],
          "default": "month",
          "description": "Returns search results within the specified time interval",
          "routing": {
            "send": {
              "type": "body",
              "property": "search_recency"
            }
          }
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "chat"
          ],
          "operation": [
            "complete"
          ]
        }
      }
    }
  ]

operations:
  [
    {
      "operation": "complete",
      "name": "Message a Model",
      "description": "Create one or more completions for a given text"
    }
  ]


node_type: nodes-base.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-07-01 06:53:38
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",
      "default": "agent",
      "options": [
        {
          "name": "Agent",
          "value": "agent"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "launch",
      "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"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "agent"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Agent Name or ID",
      "name": "agentId",
      "type": "options",
      "default": "",
      "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "delete"
          ],
          "resource": [
            "agent"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getAgents"
      }
    },
    {
      "displayName": "Agent ID",
      "name": "agentId",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "get"
          ],
          "resource": [
            "agent"
          ]
        }
      }
    },
    {
      "displayName": "Return All",
      "name": "returnAll",
      "type": "boolean",
      "default": false,
      "description": "Whether to return all results or only up to a given limit",
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "agent"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 25,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "agent"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 50
      }
    },
    {
      "displayName": "Agent Name or ID",
      "name": "agentId",
      "type": "options",
      "default": "",
      "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "getOutput"
          ],
          "resource": [
            "agent"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getAgents"
      }
    },
    {
      "displayName": "Resolve Data",
      "name": "resolveData",
      "type": "boolean",
      "default": true,
      "description": "By default the outpout is presented as string. If this option gets activated, it will resolve the data automatically.",
      "displayOptions": {
        "show": {
          "operation": [
            "getOutput"
          ],
          "resource": [
            "agent"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "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"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "agent"
          ],
          "operation": [
            "getOutput"
          ]
        }
      }
    },
    {
      "displayName": "Agent Name or ID",
      "name": "agentId",
      "type": "options",
      "default": "",
      "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "launch"
          ],
          "resource": [
            "agent"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getAgents"
      }
    },
    {
      "displayName": "Resolve Data",
      "name": "resolveData",
      "type": "boolean",
      "default": true,
      "description": "By default the launch just include the container ID. If this option gets activated, it will resolve the data automatically.",
      "displayOptions": {
        "show": {
          "operation": [
            "launch"
          ],
          "resource": [
            "agent"
          ]
        }
      }
    },
    {
      "displayName": "JSON Parameters",
      "name": "jsonParameters",
      "type": "boolean",
      "default": false,
      "displayOptions": {
        "show": {
          "operation": [
            "launch"
          ],
          "resource": [
            "agent"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "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"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "agent"
          ],
          "operation": [
            "launch"
          ]
        }
      }
    }
  ]

operations:
  [
    {
      "operation": "delete",
      "name": "Delete",
      "description": "Delete an agent by ID"
    },
    {
      "operation": "get",
      "name": "Get",
      "description": "Get an agent by ID"
    },
    {
      "operation": "getAll",
      "name": "Get Many",
      "description": "Get many agents of the current user's organization"
    },
    {
      "operation": "getOutput",
      "name": "Get Output",
      "description": "Get the output of the most recent container of an agent"
    },
    {
      "operation": "launch",
      "name": "Launch",
      "description": "Add an agent to the launch queue"
    }
  ]


node_type: nodes-base.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-07-01 06:53:38
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",
      "default": "light",
      "options": [
        {
          "name": "Light",
          "value": "light"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "update",
      "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"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "light"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Light ID",
      "name": "lightId",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "delete"
          ],
          "resource": [
            "light"
          ]
        }
      }
    },
    {
      "displayName": "Return All",
      "name": "returnAll",
      "type": "boolean",
      "default": false,
      "description": "Whether to return all results or only up to a given limit",
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "light"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 100,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "light"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 500
      }
    },
    {
      "displayName": "Light ID",
      "name": "lightId",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "get"
          ],
          "resource": [
            "light"
          ]
        }
      }
    },
    {
      "displayName": "Light Name or ID",
      "name": "lightId",
      "type": "options",
      "default": "",
      "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "update"
          ],
          "resource": [
            "light"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getLights"
      }
    },
    {
      "displayName": "On",
      "name": "on",
      "type": "boolean",
      "default": true,
      "description": "On/Off state of the light",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "update"
          ],
          "resource": [
            "light"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "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"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "light"
          ],
          "operation": [
            "update"
          ]
        }
      }
    }
  ]

operations:
  [
    {
      "operation": "delete",
      "name": "Delete",
      "description": "Delete a light"
    },
    {
      "operation": "get",
      "name": "Get",
      "description": "Retrieve a light"
    },
    {
      "operation": "getAll",
      "name": "Get Many",
      "description": "Retrieve many lights"
    },
    {
      "operation": "update",
      "name": "Update",
      "description": "Update a light"
    }
  ]


node_type: nodes-base.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-07-01 06:53:38
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",
      "default": "apiToken",
      "options": [
        {
          "name": "API Token",
          "value": "apiToken"
        },
        {
          "name": "OAuth2",
          "value": "oAuth2"
        }
      ]
    },
    {
      "displayName": "Resource",
      "name": "resource",
      "type": "options",
      "default": "deal",
      "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"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "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"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "activity"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create a deal",
          "action": "Create a deal"
        },
        {
          "name": "Delete",
          "value": "delete",
          "description": "Delete a deal",
          "action": "Delete a deal"
        },
        {
          "name": "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"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "deal"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "getAll",
      "options": [
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get many activities of a deal",
          "action": "Get many deal activities"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "dealActivity"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "add",
      "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"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "dealProduct"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "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"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "file"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "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"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "lead"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "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"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "note"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "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"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "organization"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "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"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "person"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "getAll",
      "options": [
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get data of many products",
          "action": "Get many products"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "product"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Subject",
      "name": "subject",
      "type": "string",
      "default": "",
      "description": "The subject of the activity to create",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "create"
          ],
          "resource": [
            "activity"
          ]
        }
      }
    },
    {
      "displayName": "Done",
      "name": "done",
      "type": "options",
      "default": "0",
      "description": "Whether the activity is done or not",
      "options": [
        {
          "name": "Not Done",
          "value": "0"
        },
        {
          "name": "Done",
          "value": "1"
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "create"
          ],
          "resource": [
            "activity"
          ]
        }
      }
    },
    {
      "displayName": "Type",
      "name": "type",
      "type": "string",
      "default": "",
      "description": "Type of the activity like \"call\", \"meeting\", etc",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "create"
          ],
          "resource": [
            "activity"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "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/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/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"
                }
              ]
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "create"
          ],
          "resource": [
            "activity"
          ]
        }
      }
    },
    {
      "displayName": "Activity ID",
      "name": "activityId",
      "type": "number",
      "default": 0,
      "description": "ID of the activity to delete",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "delete"
          ],
          "resource": [
            "activity"
          ]
        }
      }
    },
    {
      "displayName": "Activity ID",
      "name": "activityId",
      "type": "number",
      "default": 0,
      "description": "ID of the activity to get",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "get"
          ],
          "resource": [
            "activity"
          ]
        }
      }
    },
    {
      "displayName": "Activity ID",
      "name": "activityId",
      "type": "number",
      "default": 0,
      "description": "ID of the activity to update",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "update"
          ],
          "resource": [
            "activity"
          ]
        }
      }
    },
    {
      "displayName": "Update Fields",
      "name": "updateFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Busy Flag",
          "name": "busy_flag",
          "type": "boolean",
          "default": false,
          "description": "Whether the user is set to busy during the activity"
        },
        {
          "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/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": "Public Description",
          "name": "public_description",
          "type": "string",
          "default": "",
          "description": "Additional details about the activity that is synced to your external calendar"
        },
        {
          "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/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"
                }
              ]
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "update"
          ],
          "resource": [
            "activity"
          ]
        }
      }
    },
    {
      "displayName": "Title",
      "name": "title",
      "type": "string",
      "default": "",
      "description": "The title of the deal to create",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "create"
          ],
          "resource": [
            "deal"
          ]
        }
      }
    },
    {
      "displayName": "Associate With",
      "name": "associateWith",
      "type": "options",
      "default": "organization",
      "description": "Type of entity to link to this deal",
      "options": [
        {
          "name": "Organization",
          "value": "organization"
        },
        {
          "name": "Person",
          "value": "person"
        }
      ],
      "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",
      "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/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/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/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/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."
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "create"
          ],
          "resource": [
            "deal"
          ]
        }
      }
    },
    {
      "displayName": "Deal ID",
      "name": "dealId",
      "type": "number",
      "default": 0,
      "description": "ID of the deal to delete",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "delete"
          ],
          "resource": [
            "deal"
          ]
        }
      }
    },
    {
      "displayName": "Deal ID",
      "name": "dealId",
      "type": "number",
      "default": 0,
      "description": "ID of the deal to duplicate",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "duplicate"
          ],
          "resource": [
            "deal"
          ]
        }
      }
    },
    {
      "displayName": "Deal ID",
      "name": "dealId",
      "type": "number",
      "default": 0,
      "description": "ID of the deal to get",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "get"
          ],
          "resource": [
            "deal"
          ]
        }
      }
    },
    {
      "displayName": "Deal ID",
      "name": "dealId",
      "type": "number",
      "default": 0,
      "description": "ID of the deal to update",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "update"
          ],
          "resource": [
            "deal"
          ]
        }
      }
    },
    {
      "displayName": "Update Fields",
      "name": "updateFields",
      "type": "collection",
      "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/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/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/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/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/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."
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "update"
          ],
          "resource": [
            "deal"
          ]
        }
      }
    },
    {
      "displayName": "Deal Name or ID",
      "name": "dealId",
      "type": "options",
      "default": "",
      "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/expressions/\">expression</a>.",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "add"
          ],
          "resource": [
            "dealProduct"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getDeals"
      }
    },
    {
      "displayName": "Product Name or ID",
      "name": "productId",
      "type": "options",
      "default": "",
      "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/expressions/\">expression</a>.",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "add"
          ],
          "resource": [
            "dealProduct"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getProducts"
      }
    },
    {
      "displayName": "Item Price",
      "name": "item_price",
      "type": "number",
      "default": 0,
      "description": "Price at which to add or update this product in a deal",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "add"
          ],
          "resource": [
            "dealProduct"
          ]
        }
      },
      "typeOptions": {
        "numberPrecision": 2
      }
    },
    {
      "displayName": "Quantity",
      "name": "quantity",
      "type": "number",
      "default": 1,
      "description": "How many items of this product to add/update in a deal",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "add"
          ],
          "resource": [
            "dealProduct"
          ]
        }
      },
      "typeOptions": {
        "minValue": 1
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "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"
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "add"
          ],
          "resource": [
            "dealProduct"
          ]
        }
      }
    },
    {
      "displayName": "Deal Name or ID",
      "name": "dealId",
      "type": "options",
      "default": "",
      "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/expressions/\">expression</a>.",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "update"
          ],
          "resource": [
            "dealProduct"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getDeals"
      }
    },
    {
      "displayName": "Product Attachment Name or ID",
      "name": "productAttachmentId",
      "type": "options",
      "default": "",
      "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/expressions/\">expression</a>.",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "update"
          ],
          "resource": [
            "dealProduct"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getProductsDeal",
        "loadOptionsDependsOn": [
          "dealId"
        ]
      }
    },
    {
      "displayName": "Update Fields",
      "name": "updateFields",
      "type": "collection",
      "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"
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "update"
          ],
          "resource": [
            "dealProduct"
          ]
        }
      }
    },
    {
      "displayName": "Deal Name or ID",
      "name": "dealId",
      "type": "options",
      "default": "",
      "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/expressions/\">expression</a>.",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "remove"
          ],
          "resource": [
            "dealProduct"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getDeals"
      }
    },
    {
      "displayName": "Product Attachment Name or ID",
      "name": "productAttachmentId",
      "type": "options",
      "default": "",
      "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/expressions/\">expression</a>.",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "remove"
          ],
          "resource": [
            "dealProduct"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getProductsDeal",
        "loadOptionsDependsOn": [
          "dealId"
        ]
      }
    },
    {
      "displayName": "Deal Name or ID",
      "name": "dealId",
      "type": "options",
      "default": "",
      "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/expressions/\">expression</a>.",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "dealProduct"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getDeals"
      }
    },
    {
      "displayName": "Term",
      "name": "term",
      "type": "string",
      "default": "",
      "description": "The search term to look for. Minimum 2 characters (or 1 if using exact_match).",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "search"
          ],
          "resource": [
            "deal"
          ]
        }
      }
    },
    {
      "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.",
      "displayOptions": {
        "show": {
          "operation": [
            "search"
          ],
          "resource": [
            "deal"
          ]
        }
      }
    },
    {
      "displayName": "Return All",
      "name": "returnAll",
      "type": "boolean",
      "default": false,
      "description": "Whether to return all results or only up to a given limit",
      "displayOptions": {
        "show": {
          "operation": [
            "search"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 100,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "operation": [
            "search"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 500
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "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\"."
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "search"
          ],
          "resource": [
            "deal"
          ]
        }
      }
    },
    {
      "displayName": "Input Binary Field",
      "name": "binaryPropertyName",
      "type": "string",
      "default": "data",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "create"
          ],
          "resource": [
            "file"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "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/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"
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "create"
          ],
          "resource": [
            "file"
          ]
        }
      }
    },
    {
      "displayName": "File ID",
      "name": "fileId",
      "type": "number",
      "default": 0,
      "description": "ID of the file to delete",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "delete"
          ],
          "resource": [
            "file"
          ]
        }
      }
    },
    {
      "displayName": "File ID",
      "name": "fileId",
      "type": "number",
      "default": 0,
      "description": "ID of the file to download",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "download"
          ],
          "resource": [
            "file"
          ]
        }
      }
    },
    {
      "displayName": "Put Output File in Field",
      "name": "binaryPropertyName",
      "type": "string",
      "default": "data",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "download"
          ],
          "resource": [
            "file"
          ]
        }
      }
    },
    {
      "displayName": "File ID",
      "name": "fileId",
      "type": "number",
      "default": 0,
      "description": "ID of the file to get",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "get"
          ],
          "resource": [
            "file"
          ]
        }
      }
    },
    {
      "displayName": "File ID",
      "name": "fileId",
      "type": "number",
      "default": 0,
      "description": "ID of the file to update",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "update"
          ],
          "resource": [
            "file"
          ]
        }
      }
    },
    {
      "displayName": "Update Fields",
      "name": "updateFields",
      "type": "collection",
      "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"
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "update"
          ],
          "resource": [
            "file"
          ]
        }
      }
    },
    {
      "displayName": "Title",
      "name": "title",
      "type": "string",
      "default": "",
      "description": "Name of the lead to create",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "lead"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Associate With",
      "name": "associateWith",
      "type": "options",
      "default": "organization",
      "description": "Type of entity to link to this lead",
      "options": [
        {
          "name": "Organization",
          "value": "organization"
        },
        {
          "name": "Person",
          "value": "person"
        }
      ],
      "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",
      "default": {},
      "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/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/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"
                    }
                  ]
                }
              ]
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "lead"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Lead ID",
      "name": "leadId",
      "type": "string",
      "default": "",
      "description": "ID of the lead to delete",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "lead"
          ],
          "operation": [
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "Lead ID",
      "name": "leadId",
      "type": "string",
      "default": "",
      "description": "ID of the lead to retrieve",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "lead"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Lead ID",
      "name": "leadId",
      "type": "string",
      "default": "",
      "description": "ID of the lead to update",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "lead"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Update Fields",
      "name": "updateFields",
      "type": "collection",
      "default": {},
      "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/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/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/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"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "lead"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Content",
      "name": "content",
      "type": "string",
      "default": "",
      "description": "The content of the note to create",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "create"
          ],
          "resource": [
            "note"
          ]
        }
      },
      "typeOptions": {
        "rows": 5
      }
    },
    {
      "displayName": "Note ID",
      "name": "noteId",
      "type": "number",
      "default": 0,
      "description": "ID of the note to delete",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "delete"
          ],
          "resource": [
            "note"
          ]
        }
      }
    },
    {
      "displayName": "Note ID",
      "name": "noteId",
      "type": "number",
      "default": 0,
      "description": "ID of the note to get",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "get"
          ],
          "resource": [
            "note"
          ]
        }
      }
    },
    {
      "displayName": "Note ID",
      "name": "noteId",
      "type": "number",
      "default": 0,
      "description": "ID of the note to update",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "update"
          ],
          "resource": [
            "note"
          ]
        }
      }
    },
    {
      "displayName": "Update Fields",
      "name": "updateFields",
      "type": "collection",
      "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/expressions/\">expression</a>."
        },
        {
          "displayName": "Person ID",
          "name": "person_id",
          "type": "number",
          "default": 0,
          "description": "ID of the person this note will be associated with"
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "update"
          ],
          "resource": [
            "note"
          ]
        }
      }
    },
    {
      "displayName": "Name",
      "name": "name",
      "type": "string",
      "default": "",
      "description": "The name of the organization to create",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "create"
          ],
          "resource": [
            "organization"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "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/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."
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "create"
          ],
          "resource": [
            "organization"
          ]
        }
      }
    },
    {
      "displayName": "Organization ID",
      "name": "organizationId",
      "type": "number",
      "default": 0,
      "description": "ID of the organization to delete",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "delete"
          ],
          "resource": [
            "organization"
          ]
        }
      }
    },
    {
      "displayName": "Organization ID",
      "name": "organizationId",
      "type": "number",
      "default": 0,
      "description": "ID of the organization to get",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "get"
          ],
          "resource": [
            "organization"
          ]
        }
      }
    },
    {
      "displayName": "Term",
      "name": "term",
      "type": "string",
      "default": "",
      "description": "The search term to look for. Minimum 2 characters (or 1 if using exact_match).",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "search"
          ],
          "resource": [
            "organization"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "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"
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "search"
          ],
          "resource": [
            "organization"
          ]
        }
      }
    },
    {
      "displayName": "Organization ID",
      "name": "organizationId",
      "type": "number",
      "default": "",
      "description": "The ID of the organization to create",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "update"
          ],
          "resource": [
            "organization"
          ]
        }
      }
    },
    {
      "displayName": "Update Fields",
      "name": "updateFields",
      "type": "collection",
      "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/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."
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "update"
          ],
          "resource": [
            "organization"
          ]
        }
      }
    },
    {
      "displayName": "Name",
      "name": "name",
      "type": "string",
      "default": "",
      "description": "The name of the person to create",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "create"
          ],
          "resource": [
            "person"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "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/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/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/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/expressions/\">expression</a>."
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "create"
          ],
          "resource": [
            "person"
          ]
        }
      }
    },
    {
      "displayName": "Person ID",
      "name": "personId",
      "type": "number",
      "default": 0,
      "description": "ID of the person to delete",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "delete"
          ],
          "resource": [
            "person"
          ]
        }
      }
    },
    {
      "displayName": "Person ID",
      "name": "personId",
      "type": "number",
      "default": 0,
      "description": "ID of the person to get",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "get"
          ],
          "resource": [
            "person"
          ]
        }
      }
    },
    {
      "displayName": "Person ID",
      "name": "personId",
      "type": "number",
      "default": 0,
      "description": "ID of the person to update",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "update"
          ],
          "resource": [
            "person"
          ]
        }
      }
    },
    {
      "displayName": "Update Fields",
      "name": "updateFields",
      "type": "collection",
      "default": {},
      "description": "The fields to update",
      "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/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/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/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/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."
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "update"
          ],
          "resource": [
            "person"
          ]
        }
      }
    },
    {
      "displayName": "Resolve Properties",
      "name": "resolveProperties",
      "type": "boolean",
      "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.",
      "displayOptions": {
        "show": {
          "resource": [
            "activity",
            "deal",
            "organization",
            "person",
            "product"
          ],
          "operation": [
            "get",
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Encode Properties",
      "name": "encodeProperties",
      "type": "boolean",
      "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.",
      "displayOptions": {
        "show": {
          "resource": [
            "activity",
            "deal",
            "organization",
            "person",
            "product"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Return All",
      "name": "returnAll",
      "type": "boolean",
      "default": false,
      "description": "Whether to return all results or only up to a given limit",
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 100,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 500
      }
    },
    {
      "displayName": "Deal Name or ID",
      "name": "dealId",
      "type": "options",
      "default": "",
      "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/expressions/\">expression</a>.",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "dealActivity"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getDeals"
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "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, ..."
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "dealActivity"
          ]
        }
      }
    },
    {
      "displayName": "Filters",
      "name": "filters",
      "type": "collection",
      "default": {},
      "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"
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "lead"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Filters",
      "name": "filters",
      "type": "collection",
      "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/expressions/\">expression</a>."
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "organization"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "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/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": "Sort",
          "name": "sort",
          "type": "string",
          "default": "",
          "description": "The field names and sorting mode separated by a comma (field_name_1 ASC, field_name_2 DESC). Only first-level field keys are supported (no nested keys)."
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "person"
          ]
        }
      }
    },
    {
      "displayName": "Term",
      "name": "term",
      "type": "string",
      "default": "",
      "description": "The search term to look for. Minimum 2 characters (or 1 if using exact_match).",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "search"
          ],
          "resource": [
            "person"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "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"
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "search"
          ],
          "resource": [
            "person"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "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/expressions/\">expression</a>."
        },
        {
          "displayName": "Person ID",
          "name": "person_id",
          "type": "number",
          "default": 0,
          "description": "ID of the person this note will be associated with"
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "create",
            "getAll"
          ],
          "resource": [
            "note"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "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/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/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/expressions/\">expression</a>."
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "activity"
          ]
        }
      }
    },
    {
      "displayName": "Filters",
      "name": "filters",
      "type": "collection",
      "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/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/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/expressions/\">expression</a>."
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "deal"
          ]
        }
      }
    }
  ]

operations:
  [
    {
      "operation": "create",
      "name": "Create",
      "description": "Create an activity"
    },
    {
      "operation": "delete",
      "name": "Delete",
      "description": "Delete an activity"
    },
    {
      "operation": "get",
      "name": "Get",
      "description": "Get data of an activity"
    },
    {
      "operation": "getAll",
      "name": "Get Many",
      "description": "Get data of many activities"
    },
    {
      "operation": "update",
      "name": "Update",
      "description": "Update an activity"
    }
  ]

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"
          ]
        }
      }
    }
  ]


