# nodes

node_type: nodes-base.clickUpTrigger
package_name: n8n-nodes-base
display_name: ClickUp Trigger
description: Handle ClickUp events via webhooks (Beta)
category: trigger
development_style: programmatic
version: 1
operations: []
outputs:
  [
  "main"
  ]

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

  # ClickUp Trigger node

  [ClickUp](https://clickup.com/){:target=_blank .external-link} is a cloud-based collaboration and project management tool suitable for businesses of all sizes and industries. Features include communication and collaboration tools, task assignments and statuses, alerts and a task toolbar.

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

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

properties_schema:
  [
    {
      "displayName": "Authentication",
      "name": "authentication",
      "type": "options",
      "default": "accessToken",
      "options": [
        {
          "name": "Access Token",
          "value": "accessToken"
        },
        {
          "name": "OAuth2",
          "value": "oAuth2"
        }
      ]
    },
    {
      "displayName": "Team Name or ID",
      "name": "team",
      "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,
      "typeOptions": {
        "loadOptionsMethod": "getTeams"
      }
    },
    {
      "displayName": "Events",
      "name": "events",
      "type": "multiOptions",
      "default": [],
      "options": [
        {
          "name": "*",
          "value": "*"
        },
        {
          "name": "folder.created",
          "value": "folderCreated"
        },
        {
          "name": "folder.deleted",
          "value": "folderDeleted"
        },
        {
          "name": "folder.updated",
          "value": "folderUpdated"
        },
        {
          "name": "goal.created",
          "value": "goalCreated"
        },
        {
          "name": "goal.deleted",
          "value": "goalDeleted"
        },
        {
          "name": "goal.updated",
          "value": "goalUpdated"
        },
        {
          "name": "keyResult.created",
          "value": "keyResultCreated"
        },
        {
          "name": "keyResult.deleted",
          "value": "keyResultDelete"
        },
        {
          "name": "keyResult.updated",
          "value": "keyResultUpdated"
        },
        {
          "name": "list.created",
          "value": "listCreated"
        },
        {
          "name": "list.deleted",
          "value": "listDeleted"
        },
        {
          "name": "list.updated",
          "value": "listUpdated"
        },
        {
          "name": "space.created",
          "value": "spaceCreated"
        },
        {
          "name": "space.deleted",
          "value": "spaceDeleted"
        },
        {
          "name": "space.updated",
          "value": "spaceUpdated"
        },
        {
          "name": "task.assignee.updated",
          "value": "taskAssigneeUpdated"
        },
        {
          "name": "task.comment.posted",
          "value": "taskCommentPosted"
        },
        {
          "name": "task.comment.updated",
          "value": "taskCommentUpdated"
        },
        {
          "name": "task.created",
          "value": "taskCreated"
        },
        {
          "name": "task.deleted",
          "value": "taskDeleted"
        },
        {
          "name": "task.dueDate.updated",
          "value": "taskDueDateUpdated"
        },
        {
          "name": "task.moved",
          "value": "taskMoved"
        },
        {
          "name": "task.status.updated",
          "value": "taskStatusUpdated"
        },
        {
          "name": "task.tag.updated",
          "value": "taskTagUpdated"
        },
        {
          "name": "task.timeEstimate.updated",
          "value": "taskTimeEstimateUpdated"
        },
        {
          "name": "task.timeTracked.updated",
          "value": "taskTimeTrackedUpdated"
        },
        {
          "name": "task.updated",
          "value": "taskUpdated"
        }
      ],
      "required": true
    },
    {
      "displayName": "Filters",
      "name": "filters",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Folder ID",
          "name": "folderId",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "List ID",
          "name": "listId",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Space ID",
          "name": "spaceId",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Task ID",
          "name": "taskId",
          "type": "string",
          "default": ""
        }
      ]
    }
  ]

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


node_type: nodes-base.clockify
package_name: n8n-nodes-base
display_name: Clockify
description: Consume Clockify REST API
category: transform
development_style: programmatic
version: 1
credentials_required:
  [
  {
  "name": "clockifyApi",
  "required": true
  }
  ]

outputs:
  [
  "main"
  ]

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

  # Clockify node

  Use the Clockify node to automate work in Clockify, and integrate Clockify with other applications. n8n has built-in support for a wide range of Clockify features, including creating, updating, getting, and deleting tasks, time entries, projects, and tags.

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

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

  ## Operations

  * Project
      * Create a project
      * Delete a project
      * Get a project
      * Get all projects
      * Update a project
  * Tag
      * Create a tag
      * Delete a tag
      * Get all tags
      * Update a tag
  * Task
      * Create a task
      * Delete a task
      * Get a task
      * Get all tasks
      * Update a task
  * Time Entry
      * Create a time entry
      * Delete a time entry
      * Get time entry
      * Update a time entry

  ## Templates and examples

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

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

properties_schema:
  [
    {
      "displayName": "Resource",
      "name": "resource",
      "type": "options",
      "default": "project",
      "options": [
        {
          "name": "Client",
          "value": "client"
        },
        {
          "name": "Project",
          "value": "project"
        },
        {
          "name": "Tag",
          "value": "tag"
        },
        {
          "name": "Task",
          "value": "task"
        },
        {
          "name": "Time Entry",
          "value": "timeEntry"
        },
        {
          "name": "User",
          "value": "user"
        },
        {
          "name": "Workspace",
          "value": "workspace"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create a client",
          "action": "Create a client"
        },
        {
          "name": "Delete",
          "value": "delete",
          "description": "Delete a client",
          "action": "Delete a client"
        },
        {
          "name": "Get",
          "value": "get",
          "description": "Get a client",
          "action": "Get a client"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get many clients",
          "action": "Get many clients"
        },
        {
          "name": "Update",
          "value": "update",
          "description": "Update a client",
          "action": "Update a client"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "client"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create a project",
          "action": "Create a project"
        },
        {
          "name": "Delete",
          "value": "delete",
          "description": "Delete a project",
          "action": "Delete a project"
        },
        {
          "name": "Get",
          "value": "get",
          "description": "Get a project",
          "action": "Get a project"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get many projects",
          "action": "Get many projects"
        },
        {
          "name": "Update",
          "value": "update",
          "description": "Update a project",
          "action": "Update a project"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "project"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create a tag",
          "action": "Create a tag"
        },
        {
          "name": "Delete",
          "value": "delete",
          "description": "Delete a tag",
          "action": "Delete a tag"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get many tags",
          "action": "Get many tags"
        },
        {
          "name": "Update",
          "value": "update",
          "description": "Update a tag",
          "action": "Update a tag"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "tag"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create a task",
          "action": "Create a task"
        },
        {
          "name": "Delete",
          "value": "delete",
          "description": "Delete a task",
          "action": "Delete a task"
        },
        {
          "name": "Get",
          "value": "get",
          "description": "Get a task",
          "action": "Get a task"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get many tasks",
          "action": "Get many tasks"
        },
        {
          "name": "Update",
          "value": "update",
          "description": "Update a task",
          "action": "Update a task"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "task"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create a time entry",
          "action": "Create a time entry"
        },
        {
          "name": "Delete",
          "value": "delete",
          "description": "Delete a time entry",
          "action": "Delete a time entry"
        },
        {
          "name": "Get",
          "value": "get",
          "description": "Get time entrie",
          "action": "Get a time entry"
        },
        {
          "name": "Update",
          "value": "update",
          "description": "Update a time entry",
          "action": "Update a time entry"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "timeEntry"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "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": "Operation",
      "name": "operation",
      "type": "options",
      "default": "getAll",
      "options": [
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get many workspaces",
          "action": "Get many workspaces"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "workspace"
          ]
        }
      },
      "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": [
            "workspace"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 100,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "workspace"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 500
      }
    },
    {
      "displayName": "Workspace Name or ID",
      "name": "workspaceId",
      "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": {
        "hide": {
          "resource": [
            "workspace"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "listWorkspaces"
      }
    },
    {
      "displayName": "Client Name",
      "name": "name",
      "type": "string",
      "default": "",
      "description": "Name of client being created",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "client"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Client ID",
      "name": "clientId",
      "type": "string",
      "default": "",
      "displayOptions": {
        "show": {
          "resource": [
            "client"
          ],
          "operation": [
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "Client ID",
      "name": "clientId",
      "type": "string",
      "default": "",
      "displayOptions": {
        "show": {
          "resource": [
            "client"
          ],
          "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": [
            "client"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 100,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "client"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 500
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Archived",
          "name": "archived",
          "type": "boolean",
          "default": false
        },
        {
          "displayName": "Name",
          "name": "name",
          "type": "string",
          "default": "",
          "description": "If provided, clients will be filtered by name"
        },
        {
          "displayName": "Sort Order",
          "name": "sort-order",
          "type": "options",
          "options": [
            {
              "name": "Ascending",
              "value": "ASCENDING"
            },
            {
              "name": "Descending",
              "value": "DESCENDING"
            }
          ],
          "default": ""
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "client"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Client ID",
      "name": "clientId",
      "type": "string",
      "default": "",
      "displayOptions": {
        "show": {
          "resource": [
            "client"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Name",
      "name": "name",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "client"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Update Fields",
      "name": "updateFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Address",
          "name": "address",
          "type": "string",
          "default": "",
          "description": "Address of client being created/updated"
        },
        {
          "displayName": "Archived",
          "name": "archived",
          "type": "boolean",
          "default": false
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "update"
          ],
          "resource": [
            "client"
          ]
        }
      }
    },
    {
      "displayName": "Project Name",
      "name": "name",
      "type": "string",
      "default": "",
      "description": "Name of project being created",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "project"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Billable",
          "name": "billable",
          "type": "boolean",
          "default": true
        },
        {
          "displayName": "Color",
          "name": "color",
          "type": "color",
          "default": "#0000FF"
        },
        {
          "displayName": "Client Name or ID",
          "name": "clientId",
          "type": "options",
          "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
          "typeOptions": {
            "loadOptionsDependsOn": [
              "workspaceId"
            ],
            "loadOptionsMethod": "loadClientsForWorkspace"
          },
          "default": ""
        },
        {
          "displayName": "Estimate",
          "name": "estimateUi",
          "placeholder": "Add Estimate",
          "type": "fixedCollection",
          "default": {},
          "typeOptions": {
            "multipleValues": false
          },
          "options": [
            {
              "displayName": "Estimate",
              "name": "estimateValues",
              "values": [
                {
                  "displayName": "Estimate",
                  "name": "estimate",
                  "type": "number",
                  "default": 0
                },
                {
                  "displayName": "Type",
                  "name": "type",
                  "type": "options",
                  "options": [
                    {
                      "name": "Auto",
                      "value": "AUTO"
                    },
                    {
                      "name": "Manual",
                      "value": "MANUAL"
                    }
                  ],
                  "default": "AUTO"
                }
              ]
            }
          ]
        },
        {
          "displayName": "Is Public",
          "name": "isPublic",
          "type": "boolean",
          "default": true
        },
        {
          "displayName": "Note",
          "name": "note",
          "type": "string",
          "default": "",
          "description": "Note about the project"
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "create"
          ],
          "resource": [
            "project"
          ]
        }
      }
    },
    {
      "displayName": "Project ID",
      "name": "projectId",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "project"
          ],
          "operation": [
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "Project ID",
      "name": "projectId",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "project"
          ],
          "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": [
            "project"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 100,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "project"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 500
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Archived",
          "name": "archived",
          "type": "boolean",
          "default": true
        },
        {
          "displayName": "Billable",
          "name": "billable",
          "type": "boolean",
          "default": true
        },
        {
          "displayName": "Client Names or IDs",
          "name": "clients",
          "type": "multiOptions",
          "description": "Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
          "typeOptions": {
            "loadOptionsDependsOn": [
              "workspaceId"
            ],
            "loadOptionsMethod": "loadClientsForWorkspace"
          },
          "default": []
        },
        {
          "displayName": "Contains Client",
          "name": "contains-client",
          "type": "boolean",
          "default": false,
          "description": "Whether to return only projects having a client"
        },
        {
          "displayName": "Client Status",
          "name": "client-status",
          "type": "options",
          "options": [
            {
              "name": "Active",
              "value": "ACTIVE"
            },
            {
              "name": "Archived",
              "value": "ARCHIVED"
            }
          ],
          "default": "",
          "description": "If provided, projects will be filtered by whether they have a client"
        },
        {
          "displayName": "Contains User",
          "name": "contains-user",
          "type": "boolean",
          "default": false,
          "description": "Whether to return only projects having users"
        },
        {
          "displayName": "Is Template",
          "name": "is-template",
          "type": "boolean",
          "default": false,
          "description": "Whether to return only projects as templates"
        },
        {
          "displayName": "Name",
          "name": "name",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Sort Column",
          "name": "sort-column",
          "type": "options",
          "options": [
            {
              "name": "Name",
              "value": "NAME"
            },
            {
              "name": "Client Name",
              "value": "CLIENT_NAME"
            },
            {
              "name": "Duration",
              "value": "DURATION"
            }
          ],
          "default": ""
        },
        {
          "displayName": "Sort Order",
          "name": "sort-order",
          "type": "options",
          "options": [
            {
              "name": "Ascending",
              "value": "ASCENDING"
            },
            {
              "name": "Descending",
              "value": "DESCENDING"
            }
          ],
          "default": ""
        },
        {
          "displayName": "User Name or ID",
          "name": "users",
          "type": "options",
          "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
          "typeOptions": {
            "loadOptionsDependsOn": [
              "workspaceId"
            ],
            "loadOptionsMethod": "loadUsersForWorkspace"
          },
          "default": ""
        },
        {
          "displayName": "User Status",
          "name": "user-status",
          "type": "options",
          "options": [
            {
              "name": "Active",
              "value": "ACTIVE"
            },
            {
              "name": "Archived",
              "value": "ARCHIVED"
            }
          ],
          "default": "",
          "description": "If provided, projects will be filtered by whether they have a client"
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "project"
          ]
        }
      }
    },
    {
      "displayName": "Project ID",
      "name": "projectId",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "project"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Update Fields",
      "name": "updateFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Billable",
          "name": "billable",
          "type": "boolean",
          "default": true
        },
        {
          "displayName": "Color",
          "name": "color",
          "type": "color",
          "default": "#0000FF"
        },
        {
          "displayName": "Client Name or ID",
          "name": "clientId",
          "type": "options",
          "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
          "typeOptions": {
            "loadOptionsDependsOn": [
              "workspaceId"
            ],
            "loadOptionsMethod": "loadClientsForWorkspace"
          },
          "default": ""
        },
        {
          "displayName": "Estimate",
          "name": "estimateUi",
          "placeholder": "Add Estimate",
          "type": "fixedCollection",
          "default": {},
          "typeOptions": {
            "multipleValues": false
          },
          "options": [
            {
              "displayName": "Estimate",
              "name": "estimateValues",
              "values": [
                {
                  "displayName": "Estimate",
                  "name": "estimate",
                  "type": "number",
                  "default": 0
                },
                {
                  "displayName": "Type",
                  "name": "type",
                  "type": "options",
                  "options": [
                    {
                      "name": "Auto",
                      "value": "AUTO"
                    },
                    {
                      "name": "Manual",
                      "value": "MANUAL"
                    }
                  ],
                  "default": "AUTO"
                }
              ]
            }
          ]
        },
        {
          "displayName": "Is Public",
          "name": "isPublic",
          "type": "boolean",
          "default": false
        },
        {
          "displayName": "Name",
          "name": "name",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Note",
          "name": "note",
          "type": "string",
          "default": "",
          "description": "Note about the project"
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "update"
          ],
          "resource": [
            "project"
          ]
        }
      }
    },
    {
      "displayName": "Name",
      "name": "name",
      "type": "string",
      "default": "",
      "description": "Name of tag being created",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "tag"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Tag ID",
      "name": "tagId",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "tag"
          ],
          "operation": [
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "Return All",
      "name": "returnAll",
      "type": "boolean",
      "default": false,
      "description": "Whether to return all results or only up to a given limit",
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "tag"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 100,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "tag"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 500
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Archived",
          "name": "archived",
          "type": "boolean",
          "default": true
        },
        {
          "displayName": "Name",
          "name": "name",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Sort Column",
          "name": "sort-column",
          "type": "options",
          "options": [
            {
              "name": "Name",
              "value": "NAME"
            }
          ],
          "default": ""
        },
        {
          "displayName": "Sort Order",
          "name": "sort-order",
          "type": "options",
          "options": [
            {
              "name": "Ascending",
              "value": "ASCENDING"
            },
            {
              "name": "Descending",
              "value": "DESCENDING"
            }
          ],
          "default": ""
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "tag"
          ]
        }
      }
    },
    {
      "displayName": "Tag ID",
      "name": "tagId",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "tag"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Update Fields",
      "name": "updateFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Archived",
          "name": "archived",
          "type": "boolean",
          "default": false
        },
        {
          "displayName": "Name",
          "name": "name",
          "type": "string",
          "default": ""
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "update"
          ],
          "resource": [
            "tag"
          ]
        }
      }
    },
    {
      "displayName": "Project Name or ID",
      "name": "projectId",
      "type": "options",
      "default": "",
      "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "task"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsDependsOn": [
          "workspaceId"
        ],
        "loadOptionsMethod": "loadProjectsForWorkspace"
      }
    },
    {
      "displayName": "Task Name",
      "name": "name",
      "type": "string",
      "default": "",
      "description": "Name of task to create",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "task"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Assignee Names or IDs",
          "name": "assigneeIds",
          "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": "loadUsersForWorkspace"
          }
        },
        {
          "displayName": "Estimate",
          "name": "estimate",
          "type": "string",
          "default": "",
          "placeholder": "2:30",
          "description": "Estimate time the task will take, e.x: 2:30 (2 hours and 30 minutes)"
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "create"
          ],
          "resource": [
            "task"
          ]
        }
      }
    },
    {
      "displayName": "Task ID",
      "name": "taskId",
      "type": "string",
      "default": "",
      "description": "ID of task to delete",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "task"
          ],
          "operation": [
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "Task ID",
      "name": "taskId",
      "type": "string",
      "default": "",
      "description": "ID of task to get",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "task"
          ],
          "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": [
            "task"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 100,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "task"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 500
      }
    },
    {
      "displayName": "Filters",
      "name": "filters",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Is Active",
          "name": "is-active",
          "type": "boolean",
          "default": false
        },
        {
          "displayName": "Name",
          "name": "name",
          "type": "string",
          "default": "",
          "description": "Text to match in the task name"
        },
        {
          "displayName": "Sort Column",
          "name": "sort-column",
          "type": "options",
          "options": [
            {
              "name": "Name",
              "value": "NAME"
            }
          ],
          "default": "NAME"
        },
        {
          "displayName": "Sort Order",
          "name": "sort-order",
          "type": "options",
          "options": [
            {
              "name": "Ascending",
              "value": "ASCENDING"
            },
            {
              "name": "Descending",
              "value": "DESCENDING"
            }
          ],
          "default": "ASCENDING"
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "task"
          ]
        }
      }
    },
    {
      "displayName": "Task ID",
      "name": "taskId",
      "type": "string",
      "default": "",
      "description": "ID of task to update",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "task"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Update Fields",
      "name": "updateFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Assignee Names or IDs",
          "name": "assigneeIds",
          "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": "loadUsersForWorkspace"
          }
        },
        {
          "displayName": "Estimate",
          "name": "estimate",
          "type": "string",
          "default": "",
          "placeholder": "2:30",
          "description": "Estimate time the task will take, e.x: 2:30 (2 hours and 30 minutes)"
        },
        {
          "displayName": "Name",
          "name": "name",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Status",
          "name": "status",
          "type": "options",
          "options": [
            {
              "name": "Active",
              "value": "ACTIVE"
            },
            {
              "name": "Done",
              "value": "DONE"
            }
          ],
          "default": "ACTIVE"
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "update"
          ],
          "resource": [
            "task"
          ]
        }
      }
    },
    {
      "displayName": "Return All",
      "name": "returnAll",
      "type": "boolean",
      "default": false,
      "description": "Whether to return all results or only up to a given limit",
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "user"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 100,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "user"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 500
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Email",
          "name": "email",
          "type": "string",
          "placeholder": "name@email.com",
          "default": "",
          "description": "If provided, you'll get a filtered list of users that contain the provided string in their email address"
        },
        {
          "displayName": "Name",
          "name": "name",
          "type": "string",
          "default": "",
          "description": "If provided, you'll get a filtered list of users that contain the provided string in their name"
        },
        {
          "displayName": "Status",
          "name": "status",
          "type": "options",
          "options": [
            {
              "name": "Active",
              "value": "ACTIVE"
            },
            {
              "name": "Inactive",
              "value": "INACTIVE"
            },
            {
              "name": "Pending",
              "value": "PENDING"
            },
            {
              "name": "Declined",
              "value": "DECLINED"
            }
          ],
          "default": "",
          "description": "If provided, you'll get a filtered list of users with the corresponding status"
        },
        {
          "displayName": "Sort Column",
          "name": "sort-column",
          "type": "options",
          "options": [
            {
              "name": "Email",
              "value": "EMAIL"
            },
            {
              "name": "Name",
              "value": "NAME"
            },
            {
              "name": "Hourly Rate",
              "value": "HOURLYRATE"
            }
          ],
          "default": ""
        },
        {
          "displayName": "Sort Order",
          "name": "sort-order",
          "type": "options",
          "options": [
            {
              "name": "Ascending",
              "value": "ASCENDING"
            },
            {
              "name": "Descending",
              "value": "DESCENDING"
            }
          ],
          "default": ""
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Start",
      "name": "start",
      "type": "dateTime",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "timeEntry"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Billable",
          "name": "billable",
          "type": "boolean",
          "default": false
        },
        {
          "displayName": "Custom Fields",
          "name": "customFieldsUi",
          "placeholder": "Add Custom Field",
          "type": "fixedCollection",
          "typeOptions": {
            "multipleValues": true
          },
          "description": "Filter by custom fields",
          "default": {},
          "options": [
            {
              "name": "customFieldsValues",
              "displayName": "Custom Field",
              "values": [
                {
                  "displayName": "Field Name or ID",
                  "name": "customFieldId",
                  "type": "options",
                  "typeOptions": {
                    "loadOptionsDependsOn": [
                      "workspaceId"
                    ],
                    "loadOptionsMethod": "loadCustomFieldsForWorkspace"
                  },
                  "default": "",
                  "description": "The ID of the field to add custom field to. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
                },
                {
                  "displayName": "Value",
                  "name": "value",
                  "type": "string",
                  "default": "",
                  "description": "The value to set on custom field"
                }
              ]
            }
          ]
        },
        {
          "displayName": "Description",
          "name": "description",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "End",
          "name": "end",
          "type": "dateTime",
          "default": ""
        },
        {
          "displayName": "Project Name or ID",
          "name": "projectId",
          "type": "options",
          "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
          "typeOptions": {
            "loadOptionsDependsOn": [
              "workspaceId"
            ],
            "loadOptionsMethod": "loadProjectsForWorkspace"
          },
          "default": ""
        },
        {
          "displayName": "Tag Names or IDs",
          "name": "tagIds",
          "type": "multiOptions",
          "description": "Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
          "typeOptions": {
            "loadOptionsDependsOn": [
              "workspaceId"
            ],
            "loadOptionsMethod": "loadTagsForWorkspace"
          },
          "default": []
        },
        {
          "displayName": "Task ID",
          "name": "taskId",
          "type": "string",
          "default": ""
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "create"
          ],
          "resource": [
            "timeEntry"
          ]
        }
      }
    },
    {
      "displayName": "Time Entry ID",
      "name": "timeEntryId",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "timeEntry"
          ],
          "operation": [
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "Time Entry ID",
      "name": "timeEntryId",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "timeEntry"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Consider Duration Format",
          "name": "consider-duration-format",
          "type": "boolean",
          "default": false,
          "description": "Whether to return the time entry's duration rounded to minutes or seconds based on duration format (hh:mm or hh:mm:ss) from workspace settings"
        },
        {
          "displayName": "Hydrated",
          "name": "hydrated",
          "type": "boolean",
          "default": false,
          "description": "Whether to return the time entry's project, task and tags in full and not just their IDs"
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "get"
          ],
          "resource": [
            "timeEntry"
          ]
        }
      }
    },
    {
      "displayName": "Time Entry ID",
      "name": "timeEntryId",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "timeEntry"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Update Fields",
      "name": "updateFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Billable",
          "name": "billable",
          "type": "boolean",
          "default": false
        },
        {
          "displayName": "Custom Fields",
          "name": "customFieldsUi",
          "placeholder": "Add Custom Field",
          "type": "fixedCollection",
          "typeOptions": {
            "multipleValues": true
          },
          "description": "Filter by custom fields",
          "default": {},
          "options": [
            {
              "name": "customFieldsValues",
              "displayName": "Custom Field",
              "values": [
                {
                  "displayName": "Field Name or ID",
                  "name": "customFieldId",
                  "type": "options",
                  "typeOptions": {
                    "loadOptionsDependsOn": [
                      "workspaceId"
                    ],
                    "loadOptionsMethod": "loadCustomFieldsForWorkspace"
                  },
                  "default": "",
                  "description": "The ID of the field to add custom field to. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
                },
                {
                  "displayName": "Value",
                  "name": "value",
                  "type": "string",
                  "default": "",
                  "description": "The value to set on custom field"
                }
              ]
            }
          ]
        },
        {
          "displayName": "Description",
          "name": "description",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "End",
          "name": "end",
          "type": "dateTime",
          "default": ""
        },
        {
          "displayName": "Project Name or ID",
          "name": "projectId",
          "type": "options",
          "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
          "typeOptions": {
            "loadOptionsDependsOn": [
              "workspaceId"
            ],
            "loadOptionsMethod": "loadProjectsForWorkspace"
          },
          "default": ""
        },
        {
          "displayName": "Start",
          "name": "start",
          "type": "dateTime",
          "default": ""
        },
        {
          "displayName": "Tag Names or IDs",
          "name": "tagIds",
          "type": "multiOptions",
          "description": "Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
          "typeOptions": {
            "loadOptionsDependsOn": [
              "workspaceId"
            ],
            "loadOptionsMethod": "loadTagsForWorkspace"
          },
          "default": []
        },
        {
          "displayName": "Task ID",
          "name": "taskId",
          "type": "string",
          "default": ""
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "update"
          ],
          "resource": [
            "timeEntry"
          ]
        }
      }
    }
  ]

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


node_type: nodes-base.clockifyTrigger
package_name: n8n-nodes-base
display_name: Clockify Trigger
description: Listens to Clockify events
category: trigger
development_style: programmatic
version: 1
operations: []
credentials_required:
  [
  {
  "name": "clockifyApi",
  "required": true
  }
  ]

outputs:
  [
  "main"
  ]

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

  # Clockify Trigger node

  [Clockify](https://clockify.me/){:target=_blank .external-link} is a free time tracker and timesheet app for tracking work hours across projects.

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

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

  This node uses the workflow timezone setting to specify the range of time entries starting time. Configure the timezone in your [Workflow Settings](/workflows/settings.md) if you want this trigger node to retrieve the right time entries.

properties_schema:
  [
    {
      "displayName": "Workspace Name or ID",
      "name": "workspaceId",
      "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,
      "typeOptions": {
        "loadOptionsMethod": "listWorkspaces"
      }
    },
    {
      "displayName": "Trigger",
      "name": "watchField",
      "type": "options",
      "default": 0,
      "options": [
        {
          "name": "New Time Entry",
          "value": 0
        }
      ],
      "required": true
    }
  ]


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

outputs:
  [
  "main"
  ]

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

  # Cockpit node

  Use the Cockpit node to automate work in Cockpit, and integrate Cockpit with other applications. n8n has built-in support for a wide range of Cockpit features, including creating a collection entry, storing data from a form submission, and getting singletons.

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

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

  ## Operations

  * Collection
      * Create a collection entry
      * Get all collection entries
      * Update a collection entry
  * Form
      * Store data from a form submission
  * Singleton
      * Get a singleton

  ## Templates and examples

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

properties_schema:
  [
    {
      "displayName": "Resource",
      "name": "resource",
      "type": "options",
      "default": "collection",
      "options": [
        {
          "name": "Collection",
          "value": "collection"
        },
        {
          "name": "Form",
          "value": "form"
        },
        {
          "name": "Singleton",
          "value": "singleton"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "getAll",
      "options": [
        {
          "name": "Create an Entry",
          "value": "create",
          "description": "Create a collection entry",
          "action": "Create a collection entry"
        },
        {
          "name": "Get Many Entries",
          "value": "getAll",
          "description": "Get many collection entries",
          "action": "Get many collection entries"
        },
        {
          "name": "Update an Entry",
          "value": "update",
          "description": "Update a collection entry",
          "action": "Update a collection entry"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "collection"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Collection Name or ID",
      "name": "collection",
      "type": "options",
      "default": "",
      "description": "Name of the collection to operate on. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "collection"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getCollections"
      }
    },
    {
      "displayName": "Return All",
      "name": "returnAll",
      "type": "boolean",
      "default": false,
      "description": "Whether to return all results or only up to a given limit",
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "collection"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 100,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "collection"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 500
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Fields",
          "name": "fields",
          "type": "string",
          "default": "",
          "placeholder": "_id,name",
          "description": "Comma-separated list of fields to get"
        },
        {
          "displayName": "Filter Query",
          "name": "filter",
          "type": "json",
          "default": "",
          "typeOptions": {
            "alwaysOpenEditWindow": true
          },
          "placeholder": "{\"name\": \"Jim\"}",
          "description": "Filter query in <a href=\"https://jeroen.github.io/mongolite/query-data.html\">Mongolite format</a>"
        },
        {
          "displayName": "Language",
          "name": "language",
          "type": "string",
          "default": "",
          "description": "Return normalized language fields"
        },
        {
          "displayName": "Populate",
          "name": "populate",
          "type": "boolean",
          "default": true,
          "description": "Whether to resolve linked collection items"
        },
        {
          "displayName": "RAW Data",
          "name": "rawData",
          "type": "boolean",
          "default": false,
          "description": "Whether to return the data exactly in the way it got received from the API"
        },
        {
          "displayName": "Skip",
          "name": "skip",
          "type": "number",
          "default": "",
          "description": "Skip number of entries"
        },
        {
          "displayName": "Sort Query",
          "name": "sort",
          "type": "json",
          "default": "",
          "placeholder": "{\"price\": -1}",
          "description": "Sort query in <a href=\"https://jeroen.github.io/mongolite/query-data.html\">Mongolite format</a>"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "collection"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Entry ID",
      "name": "id",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "collection"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "JSON Data Fields",
      "name": "jsonDataFields",
      "type": "boolean",
      "default": false,
      "description": "Whether new entry fields should be set via the value-key pair UI or JSON",
      "displayOptions": {
        "show": {
          "resource": [
            "collection"
          ],
          "operation": [
            "create",
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Entry Data",
      "name": "dataFieldsJson",
      "type": "json",
      "default": "",
      "description": "Entry data to send as JSON",
      "displayOptions": {
        "show": {
          "jsonDataFields": [
            true
          ],
          "resource": [
            "collection"
          ],
          "operation": [
            "create",
            "update"
          ]
        }
      },
      "typeOptions": {
        "alwaysOpenEditWindow": true
      }
    },
    {
      "displayName": "Entry Data",
      "name": "dataFieldsUi",
      "type": "fixedCollection",
      "default": {},
      "description": "Entry data to send",
      "options": [
        {
          "displayName": "Field",
          "name": "field",
          "values": [
            {
              "displayName": "Name",
              "name": "name",
              "type": "string",
              "default": "",
              "description": "Name of the field"
            },
            {
              "displayName": "Value",
              "name": "value",
              "type": "string",
              "default": "",
              "description": "Value of the field"
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "jsonDataFields": [
            false
          ],
          "resource": [
            "collection"
          ],
          "operation": [
            "create",
            "update"
          ]
        }
      },
      "typeOptions": {
        "multipleValues": true
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "submit",
      "options": [
        {
          "name": "Submit a Form",
          "value": "submit",
          "description": "Store data from a form submission",
          "action": "Submit a form"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "form"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Form",
      "name": "form",
      "type": "string",
      "default": "",
      "description": "Name of the form to operate on",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "form"
          ]
        }
      }
    },
    {
      "displayName": "JSON Data Fields",
      "name": "jsonDataFields",
      "type": "boolean",
      "default": false,
      "description": "Whether form fields should be set via the value-key pair UI or JSON",
      "displayOptions": {
        "show": {
          "resource": [
            "form"
          ],
          "operation": [
            "submit"
          ]
        }
      }
    },
    {
      "displayName": "Form Data",
      "name": "dataFieldsJson",
      "type": "json",
      "default": "",
      "description": "Form data to send as JSON",
      "displayOptions": {
        "show": {
          "jsonDataFields": [
            true
          ],
          "resource": [
            "form"
          ],
          "operation": [
            "submit"
          ]
        }
      },
      "typeOptions": {
        "alwaysOpenEditWindow": true
      }
    },
    {
      "displayName": "Form Data",
      "name": "dataFieldsUi",
      "type": "fixedCollection",
      "default": {},
      "description": "Form data to send",
      "options": [
        {
          "displayName": "Field",
          "name": "field",
          "values": [
            {
              "displayName": "Name",
              "name": "name",
              "type": "string",
              "default": "",
              "description": "Name of the field"
            },
            {
              "displayName": "Value",
              "name": "value",
              "type": "string",
              "default": "",
              "description": "Value of the field"
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "jsonDataFields": [
            false
          ],
          "resource": [
            "form"
          ],
          "operation": [
            "submit"
          ]
        }
      },
      "typeOptions": {
        "multipleValues": true
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "get",
      "options": [
        {
          "name": "Get",
          "value": "get",
          "description": "Get a singleton",
          "action": "Get a singleton"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "singleton"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Singleton Name or ID",
      "name": "singleton",
      "type": "options",
      "default": "",
      "description": "Name of the singleton to operate on. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "singleton"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getSingletons"
      }
    }
  ]

operations:
  [
    {
      "operation": "create",
      "name": "Create an Entry",
      "description": "Create a collection entry"
    },
    {
      "operation": "getAll",
      "name": "Get Many Entries",
      "description": "Get many collection entries"
    },
    {
      "operation": "update",
      "name": "Update an Entry",
      "description": "Update a collection entry"
    }
  ]


node_type: nodes-base.coda
package_name: n8n-nodes-base
display_name: Coda
description: Consume Coda API
category: output
development_style: programmatic
version: 1.1
credentials_required:
  [
  {
  "name": "codaApi",
  "required": true
  }
  ]

outputs:
  [
  "main"
  ]

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

  # Coda node

  Use the Coda node to automate work in Coda, and integrate Coda with other applications. n8n has built-in support for a wide range of Coda features, including creating, getting, and deleting controls, formulas, tables, and views.

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

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

  ## Operations

  * Control
      * Get a control
      * Get all controls
  * Formula
      * Get a formula
      * Get all formulas
  * Table
      * Create/Insert a row
      * Delete one or multiple rows
      * Get all columns
      * Get all the rows
      * Get a column
      * Get a row
      * Pushes a button
  * View
      * Delete view row
      * Get a view
      * Get all views
      * Get all views columns
      * Get all views rows
      * Update row
      * Push view button

  ## Templates and examples

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

properties_schema:
  [
    {
      "displayName": "Resource",
      "name": "resource",
      "type": "options",
      "default": "table",
      "options": [
        {
          "name": "Control",
          "value": "control",
          "description": "Controls provide a user-friendly way to input a value that can affect other parts of the doc"
        },
        {
          "name": "Formula",
          "value": "formula",
          "description": "Formulas can be great for performing one-off computations"
        },
        {
          "name": "Table",
          "value": "table",
          "description": "Access data of tables in documents"
        },
        {
          "name": "View",
          "value": "view",
          "description": "Access data of views in documents"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "createRow",
      "options": [
        {
          "name": "Create Row",
          "value": "createRow",
          "description": "Create/Insert a row",
          "action": "Create a row"
        },
        {
          "name": "Delete Row",
          "value": "deleteRow",
          "description": "Delete one or multiple rows",
          "action": "Delete a row"
        },
        {
          "name": "Get All Columns",
          "value": "getAllColumns",
          "description": "Get all columns in a table",
          "action": "Get all columns"
        },
        {
          "name": "Get All Rows",
          "value": "getAllRows",
          "description": "Get all rows in a table",
          "action": "Get all rows"
        },
        {
          "name": "Get Column",
          "value": "getColumn",
          "description": "Get a column",
          "action": "Get a column"
        },
        {
          "name": "Get Row",
          "value": "getRow",
          "description": "Get a row",
          "action": "Get a row"
        },
        {
          "name": "Push Button",
          "value": "pushButton",
          "description": "Pushes a button",
          "action": "Push a button"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "table"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Doc Name or ID",
      "name": "docId",
      "type": "options",
      "default": "",
      "description": "ID of the doc. 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": [
            "table"
          ],
          "operation": [
            "createRow"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getDocs"
      }
    },
    {
      "displayName": "Table Name or ID",
      "name": "tableId",
      "type": "options",
      "default": "",
      "description": "The table to create the row in. 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": [
            "table"
          ],
          "operation": [
            "createRow"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsDependsOn": [
          "docId"
        ],
        "loadOptionsMethod": "getTables"
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Disable Parsing",
          "name": "disableParsing",
          "type": "boolean",
          "default": false,
          "description": "Whether the API will not attempt to parse the data in any way"
        },
        {
          "displayName": "Key Columns",
          "name": "keyColumns",
          "type": "string",
          "default": "",
          "description": "Optional column IDs, URLs, or names (fragile and discouraged), specifying columns to be used as upsert keys. If more than one separate by a comma (,)."
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "table"
          ],
          "operation": [
            "createRow"
          ]
        }
      }
    },
    {
      "displayName": "Doc Name or ID",
      "name": "docId",
      "type": "options",
      "default": "",
      "description": "ID of the doc. 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": [
            "table"
          ],
          "operation": [
            "getRow"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getDocs"
      }
    },
    {
      "displayName": "Table Name or ID",
      "name": "tableId",
      "type": "options",
      "default": "",
      "description": "The table to get the row from. 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": [
            "table"
          ],
          "operation": [
            "getRow"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsDependsOn": [
          "docId"
        ],
        "loadOptionsMethod": "getTables"
      }
    },
    {
      "displayName": "Row ID",
      "name": "rowId",
      "type": "string",
      "default": "",
      "description": "ID or name of the row. Names are discouraged because they're easily prone to being changed by users. If you're using a name, be sure to URI-encode it. If there are multiple rows with the same value in the identifying column, an arbitrary one will be selected",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "table"
          ],
          "operation": [
            "getRow"
          ]
        }
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "RAW Data",
          "name": "rawData",
          "type": "boolean",
          "default": false,
          "description": "Whether to return the data exactly in the way it got received from the API"
        },
        {
          "displayName": "Use Column Names",
          "name": "useColumnNames",
          "type": "boolean",
          "default": false,
          "description": "Whether to use column names instead of column IDs in the returned output. This is generally discouraged as it is fragile. If columns are renamed, code using original names may throw errors."
        },
        {
          "displayName": "ValueFormat",
          "name": "valueFormat",
          "type": "options",
          "default": "",
          "options": [
            {
              "name": "Simple",
              "value": "simple"
            },
            {
              "name": "Simple With Arrays",
              "value": "simpleWithArrays"
            },
            {
              "name": "Rich",
              "value": "rich"
            }
          ],
          "description": "The format that cell values are returned as"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "table"
          ],
          "operation": [
            "getRow"
          ]
        }
      }
    },
    {
      "displayName": "Doc Name or ID",
      "name": "docId",
      "type": "options",
      "default": "",
      "description": "ID of the doc. 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": [
            "table"
          ],
          "operation": [
            "getAllRows"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getDocs"
      }
    },
    {
      "displayName": "Table Name or ID",
      "name": "tableId",
      "type": "options",
      "default": "",
      "description": "The table to get the rows from. 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": [
            "table"
          ],
          "operation": [
            "getAllRows"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsDependsOn": [
          "docId"
        ],
        "loadOptionsMethod": "getTables"
      }
    },
    {
      "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": [
            "table"
          ],
          "operation": [
            "getAllRows"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 50,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "table"
          ],
          "operation": [
            "getAllRows"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 100
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Query",
          "name": "query",
          "type": "string",
          "default": "",
          "description": "Query used to filter returned rows, specified as &lt;column_id_or_name&gt;:&lt;value&gt;. If you'd like to use a column name instead of an ID, you must quote it (e.g., \"My Column\":123). Also note that value is a JSON value; if you'd like to use a string, you must surround it in quotes (e.g., \"groceries\")."
        },
        {
          "displayName": "RAW Data",
          "name": "rawData",
          "type": "boolean",
          "default": false,
          "description": "Whether to return the data exactly in the way it got received from the API"
        },
        {
          "displayName": "Sort By",
          "name": "sortBy",
          "type": "options",
          "default": "",
          "options": [
            {
              "name": "Created At",
              "value": "createdAt"
            },
            {
              "name": "Natural",
              "value": "natural"
            }
          ],
          "description": "Specifies the sort order of the rows returned. If left unspecified, rows are returned by creation time ascending."
        },
        {
          "displayName": "Use Column Names",
          "name": "useColumnNames",
          "type": "boolean",
          "default": false,
          "description": "Whether to use column names instead of column IDs in the returned output. This is generally discouraged as it is fragile. If columns are renamed, code using original names may throw errors."
        },
        {
          "displayName": "ValueFormat",
          "name": "valueFormat",
          "type": "options",
          "default": "",
          "options": [
            {
              "name": "Simple",
              "value": "simple"
            },
            {
              "name": "Simple With Arrays",
              "value": "simpleWithArrays"
            },
            {
              "name": "Rich",
              "value": "rich"
            }
          ],
          "description": "The format that cell values are returned as"
        },
        {
          "displayName": "Visible Only",
          "name": "visibleOnly",
          "type": "boolean",
          "default": false,
          "description": "Whether to return only visible rows and columns for the table"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "table"
          ],
          "operation": [
            "getAllRows"
          ]
        }
      }
    },
    {
      "displayName": "Doc Name or ID",
      "name": "docId",
      "type": "options",
      "default": "",
      "description": "ID of the doc. 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": [
            "table"
          ],
          "operation": [
            "deleteRow"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getDocs"
      }
    },
    {
      "displayName": "Table Name or ID",
      "name": "tableId",
      "type": "options",
      "default": "",
      "description": "The table to delete the row in. 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": [
            "table"
          ],
          "operation": [
            "deleteRow"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsDependsOn": [
          "docId"
        ],
        "loadOptionsMethod": "getTables"
      }
    },
    {
      "displayName": "Row ID",
      "name": "rowId",
      "type": "string",
      "default": "",
      "description": "Row IDs to delete",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "table"
          ],
          "operation": [
            "deleteRow"
          ]
        }
      }
    },
    {
      "displayName": "Doc Name or ID",
      "name": "docId",
      "type": "options",
      "default": "",
      "description": "ID of the doc. 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": [
            "table"
          ],
          "operation": [
            "pushButton"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getDocs"
      }
    },
    {
      "displayName": "Table Name or ID",
      "name": "tableId",
      "type": "options",
      "default": "",
      "description": "The table to get the row from. 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": [
            "table"
          ],
          "operation": [
            "pushButton"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsDependsOn": [
          "docId"
        ],
        "loadOptionsMethod": "getTables"
      }
    },
    {
      "displayName": "Row ID",
      "name": "rowId",
      "type": "string",
      "default": "",
      "description": "ID or name of the row. Names are discouraged because they're easily prone to being changed by users. If you're using a name, be sure to URI-encode it. If there are multiple rows with the same value in the identifying column, an arbitrary one will be selected",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "table"
          ],
          "operation": [
            "pushButton"
          ]
        }
      }
    },
    {
      "displayName": "Column Name or ID",
      "name": "columnId",
      "type": "options",
      "default": "",
      "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "table"
          ],
          "operation": [
            "pushButton"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getColumns",
        "loadOptionsDependsOn": [
          "docId",
          "tableId"
        ]
      }
    },
    {
      "displayName": "Doc Name or ID",
      "name": "docId",
      "type": "options",
      "default": "",
      "description": "ID of the doc. 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": [
            "table"
          ],
          "operation": [
            "getColumn"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getDocs"
      }
    },
    {
      "displayName": "Table Name or ID",
      "name": "tableId",
      "type": "options",
      "default": "",
      "description": "The table to get the row from. 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": [
            "table"
          ],
          "operation": [
            "getColumn"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsDependsOn": [
          "docId"
        ],
        "loadOptionsMethod": "getTables"
      }
    },
    {
      "displayName": "Column ID",
      "name": "columnId",
      "type": "string",
      "default": "",
      "description": "The table to get the row from",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "table"
          ],
          "operation": [
            "getColumn"
          ]
        }
      }
    },
    {
      "displayName": "Doc Name or ID",
      "name": "docId",
      "type": "options",
      "default": "",
      "description": "ID of the doc. 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": [
            "table"
          ],
          "operation": [
            "getAllColumns"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getDocs"
      }
    },
    {
      "displayName": "Table Name or ID",
      "name": "tableId",
      "type": "options",
      "default": "",
      "description": "The table to get the row from. 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": [
            "table"
          ],
          "operation": [
            "getAllColumns"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsDependsOn": [
          "docId"
        ],
        "loadOptionsMethod": "getTables"
      }
    },
    {
      "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": [
            "table"
          ],
          "operation": [
            "getAllColumns"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 50,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "table"
          ],
          "operation": [
            "getAllColumns"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 100
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "get",
      "options": [
        {
          "name": "Get",
          "value": "get",
          "description": "Get a formula",
          "action": "Get a formula"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get many formulas",
          "action": "Get many formulas"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "formula"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Doc Name or ID",
      "name": "docId",
      "type": "options",
      "default": "",
      "description": "ID of the doc. 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": [
            "formula"
          ],
          "operation": [
            "get"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getDocs"
      }
    },
    {
      "displayName": "Formula ID",
      "name": "formulaId",
      "type": "string",
      "default": "",
      "description": "The formula to get the row from",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "formula"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Doc Name or ID",
      "name": "docId",
      "type": "options",
      "default": "",
      "description": "ID of the doc. 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": [
            "formula"
          ],
          "operation": [
            "getAll"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getDocs"
      }
    },
    {
      "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": [
            "formula"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 50,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "formula"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 100
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "get",
      "options": [
        {
          "name": "Get",
          "value": "get",
          "description": "Get a control",
          "action": "Get a control"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get many controls",
          "action": "Get many controls"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "control"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Doc Name or ID",
      "name": "docId",
      "type": "options",
      "default": "",
      "description": "ID of the doc. 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": [
            "control"
          ],
          "operation": [
            "get"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getDocs"
      }
    },
    {
      "displayName": "Control ID",
      "name": "controlId",
      "type": "string",
      "default": "",
      "description": "The control to get the row from",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "control"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Doc Name or ID",
      "name": "docId",
      "type": "options",
      "default": "",
      "description": "ID of the doc. 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": [
            "control"
          ],
          "operation": [
            "getAll"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getDocs"
      }
    },
    {
      "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": [
            "control"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 50,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "control"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 100
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "get",
      "options": [
        {
          "name": "Delete Row",
          "value": "deleteViewRow",
          "description": "Delete view row",
          "action": "Delete a view row"
        },
        {
          "name": "Get",
          "value": "get",
          "description": "Get a view",
          "action": "Get a view"
        },
        {
          "name": "Get Columns",
          "value": "getAllViewColumns",
          "description": "Get all views columns",
          "action": "Get all view columns"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get many views",
          "action": "Get many views"
        },
        {
          "name": "Get Rows",
          "value": "getAllViewRows",
          "description": "Get all views rows",
          "action": "Get a view row"
        },
        {
          "name": "Push Button",
          "value": "pushViewButton",
          "description": "Push view button",
          "action": "Push a view button"
        },
        {
          "name": "Update Row",
          "value": "updateViewRow",
          "action": "Update a view row"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "view"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Doc Name or ID",
      "name": "docId",
      "type": "options",
      "default": "",
      "description": "ID of the doc. 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": [
            "view"
          ],
          "operation": [
            "get"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getDocs"
      }
    },
    {
      "displayName": "View ID",
      "name": "viewId",
      "type": "string",
      "default": "",
      "description": "The view to get the row from",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "view"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Doc Name or ID",
      "name": "docId",
      "type": "options",
      "default": "",
      "description": "ID of the doc. 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": [
            "view"
          ],
          "operation": [
            "getAll"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getDocs"
      }
    },
    {
      "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": [
            "view"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 50,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "view"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 100
      }
    },
    {
      "displayName": "Doc Name or ID",
      "name": "docId",
      "type": "options",
      "default": "",
      "description": "ID of the doc. 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": [
            "view"
          ],
          "operation": [
            "getAllViewRows"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getDocs"
      }
    },
    {
      "displayName": "View Name or ID",
      "name": "viewId",
      "type": "options",
      "default": "",
      "description": "The table to get the rows from. 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": [
            "view"
          ],
          "operation": [
            "getAllViewRows"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsDependsOn": [
          "docId"
        ],
        "loadOptionsMethod": "getViews"
      }
    },
    {
      "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": [
            "view"
          ],
          "operation": [
            "getAllViewRows"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 50,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "view"
          ],
          "operation": [
            "getAllViewRows"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 100
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Query",
          "name": "query",
          "type": "string",
          "default": "",
          "description": "Query used to filter returned rows, specified as &lt;column_id_or_name&gt;:&lt;value&gt;. If you'd like to use a column name instead of an ID, you must quote it (e.g., \"My Column\":123). Also note that value is a JSON value; if you'd like to use a string, you must surround it in quotes (e.g., \"groceries\")."
        },
        {
          "displayName": "Use Column Names",
          "name": "useColumnNames",
          "type": "boolean",
          "default": false,
          "description": "Whether to use column names instead of column IDs in the returned output. This is generally discouraged as it is fragile. If columns are renamed, code using original names may throw errors."
        },
        {
          "displayName": "ValueFormat",
          "name": "valueFormat",
          "type": "options",
          "default": "",
          "options": [
            {
              "name": "Simple",
              "value": "simple"
            },
            {
              "name": "Simple With Arrays",
              "value": "simpleWithArrays"
            },
            {
              "name": "Rich",
              "value": "rich"
            }
          ],
          "description": "The format that cell values are returned as"
        },
        {
          "displayName": "RAW Data",
          "name": "rawData",
          "type": "boolean",
          "default": false,
          "description": "Whether to return the data exactly in the way it got received from the API"
        },
        {
          "displayName": "Sort By",
          "name": "sortBy",
          "type": "options",
          "default": "",
          "options": [
            {
              "name": "Created At",
              "value": "createdAt"
            },
            {
              "name": "Natural",
              "value": "natural"
            }
          ],
          "description": "Specifies the sort order of the rows returned. If left unspecified, rows are returned by creation time ascending."
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "view"
          ],
          "operation": [
            "getAllViewRows"
          ]
        }
      }
    },
    {
      "displayName": "Doc Name or ID",
      "name": "docId",
      "type": "options",
      "default": "",
      "description": "ID of the doc. 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": [
            "view"
          ],
          "operation": [
            "getAllViewColumns"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getDocs"
      }
    },
    {
      "displayName": "View Name or ID",
      "name": "viewId",
      "type": "options",
      "default": "",
      "description": "The table to get the rows from. 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": [
            "view"
          ],
          "operation": [
            "getAllViewColumns"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsDependsOn": [
          "docId"
        ],
        "loadOptionsMethod": "getViews"
      }
    },
    {
      "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": [
            "view"
          ],
          "operation": [
            "getAllViewColumns"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 50,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "view"
          ],
          "operation": [
            "getAllViewColumns"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 100
      }
    },
    {
      "displayName": "Doc Name or ID",
      "name": "docId",
      "type": "options",
      "default": "",
      "description": "ID of the doc. 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": [
            "view"
          ],
          "operation": [
            "deleteViewRow"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getDocs"
      }
    },
    {
      "displayName": "View Name or ID",
      "name": "viewId",
      "type": "options",
      "default": "",
      "description": "The view to get the row from. 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": [
            "view"
          ],
          "operation": [
            "deleteViewRow"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getViews",
        "loadOptionsDependsOn": [
          "docId"
        ]
      }
    },
    {
      "displayName": "Row Name or ID",
      "name": "rowId",
      "type": "options",
      "default": "",
      "description": "The view to get the row from. 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": [
            "view"
          ],
          "operation": [
            "deleteViewRow"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getViewRows",
        "loadOptionsDependsOn": [
          "viewId"
        ]
      }
    },
    {
      "displayName": "Doc Name or ID",
      "name": "docId",
      "type": "options",
      "default": "",
      "description": "ID of the doc. 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": [
            "view"
          ],
          "operation": [
            "pushViewButton"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getDocs"
      }
    },
    {
      "displayName": "View Name or ID",
      "name": "viewId",
      "type": "options",
      "default": "",
      "description": "The view to get the row from. 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": [
            "view"
          ],
          "operation": [
            "pushViewButton"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getViews",
        "loadOptionsDependsOn": [
          "docId"
        ]
      }
    },
    {
      "displayName": "Row Name or ID",
      "name": "rowId",
      "type": "options",
      "default": "",
      "description": "The view to get the row from. 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": [
            "view"
          ],
          "operation": [
            "pushViewButton"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getViewRows",
        "loadOptionsDependsOn": [
          "viewId"
        ]
      }
    },
    {
      "displayName": "Column Name or ID",
      "name": "columnId",
      "type": "options",
      "default": "",
      "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "view"
          ],
          "operation": [
            "pushViewButton"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getViewColumns",
        "loadOptionsDependsOn": [
          "docId",
          "viewId"
        ]
      }
    },
    {
      "displayName": "Doc Name or ID",
      "name": "docId",
      "type": "options",
      "default": "",
      "description": "ID of the doc. 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": [
            "view"
          ],
          "operation": [
            "updateViewRow"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getDocs"
      }
    },
    {
      "displayName": "View Name or ID",
      "name": "viewId",
      "type": "options",
      "default": "",
      "description": "The view to get the row from. 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": [
            "view"
          ],
          "operation": [
            "updateViewRow"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getViews",
        "loadOptionsDependsOn": [
          "docId"
        ]
      }
    },
    {
      "displayName": "Row Name or ID",
      "name": "rowId",
      "type": "options",
      "default": "",
      "description": "The view to get the row from. 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": [
            "view"
          ],
          "operation": [
            "updateViewRow"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getViewRows",
        "loadOptionsDependsOn": [
          "viewId"
        ]
      }
    },
    {
      "displayName": "Key Name",
      "name": "keyName",
      "type": "string",
      "default": "columns",
      "description": "The view to get the row from",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "view"
          ],
          "operation": [
            "updateViewRow"
          ]
        }
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Disable Parsing",
          "name": "disableParsing",
          "type": "boolean",
          "default": false,
          "description": "Whether the API will not attempt to parse the data in any way"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "view"
          ],
          "operation": [
            "updateViewRow"
          ]
        }
      }
    }
  ]

operations:
  [
    {
      "operation": "createRow",
      "name": "Create Row",
      "description": "Create/Insert a row"
    },
    {
      "operation": "deleteRow",
      "name": "Delete Row",
      "description": "Delete one or multiple rows"
    },
    {
      "operation": "getAllColumns",
      "name": "Get All Columns",
      "description": "Get all columns in a table"
    },
    {
      "operation": "getAllRows",
      "name": "Get All Rows",
      "description": "Get all rows in a table"
    },
    {
      "operation": "getColumn",
      "name": "Get Column",
      "description": "Get a column"
    },
    {
      "operation": "getRow",
      "name": "Get Row",
      "description": "Get a row"
    },
    {
      "operation": "pushButton",
      "name": "Push Button",
      "description": "Pushes a button"
    }
  ]


node_type: nodes-base.code
package_name: n8n-nodes-base
display_name: Code
description: Run custom JavaScript or Python code
category: transform
development_style: programmatic
version: 2
operations: []
credentials_required: []
outputs:
  [
  "main"
  ]

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

  # LangChain Code node

  Use the LangChain Code node to import LangChain. This means if there is functionality you need that n8n hasn't created a node for, you can still use it. By configuring the LangChain Code node connectors you can use it as a normal node, root node or sub-node.

  On this page, you'll find the node parameters, guidance on configuring the node, and links to more resources.

  /// note | Not available on Cloud
  This node is only available on self-hosted n8n.
  ///

  ## Node parameters

  ### Add Code

  Add your custom code. Choose either **Execute** or **Supply Data** mode. You can only use one mode.

  Unlike the [Code node](/integrations/builtin/core-nodes/n8n-nodes-base.code/index.md), the LangChain Code node doesn't support Python.

  * **Execute**: use the LangChain Code node like n8n's own Code node. This takes input data from the workflow, processes it, and returns it as the node output. This mode requires a main input and output. You must create these connections in **Inputs** and **Outputs**.
  * **Supply Data**: use the LangChain Code node as a sub-node, sending data to a root node. This uses an output other than main.

  By default, you can't load built-in or external modules in this node. Self-hosted users can [enable built-in and external modules](/hosting/configuration/configuration-methods.md).

  ### Inputs

  Choose the input types. 

  The main input is the normal connector found in all n8n workflows. If you have a main input and output set in the node, **Execute** code is required.

  ### Outputs

  Choose the output types. 

  The main output is the normal connector found in all n8n workflows. If you have a main input and output set in the node, **Execute** code is required.

  ## Node inputs and outputs configuration

  By configuring the LangChain Code node connectors (inputs and outputs) you can use it as an app node, root node or sub-node.

  ![Screenshot of a workflow with four LangChain nodes, configured as different node types](/_images/integrations/builtin/cluster-nodes/langchaincode/create-node-types.png)

  | Node type | Inputs | Outputs | Code mode |
  | --------- | ------ | ------- | --------- |
  | App node. Similar to the [Code node](/integrations/builtin/core-nodes/n8n-nodes-base.code/index.md). | Main | Main | Execute |
  | Root node | Main; at least one other type | Main | Execute |
  | Sub-node | - | A type other than main. Must match the input type you want to connect to. | Supply Data |
  | Sub-node with sub-nodes | A type other than main |A type other than main. Must match the input type you want to connect to. | Supply Data |

  ## Built-in methods

  n8n provides these methods to make it easier to perform common tasks in the LangChain Code node.

  --8<-- "_snippets/integrations/builtin/cluster-nodes/langchain-root-nodes/langchaincode/builtin-methods.md"

  ## Templates and examples

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

  ## Related resources

  --8<-- "_snippets/integrations/builtin/cluster-nodes/langchain-overview-link.md"
  --8<-- "_glossary/ai-glossary.md"

properties_schema:
  [
    {
      "displayName": "Mode",
      "name": "mode",
      "type": "options",
      "default": "runOnceForAllItems",
      "options": [
        {
          "name": "Run Once for All Items",
          "value": "runOnceForAllItems",
          "description": "Run this code only once, no matter how many input items there are"
        },
        {
          "name": "Run Once for Each Item",
          "value": "runOnceForEachItem",
          "description": "Run this code as many times as there are input items"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "Language",
      "name": "language",
      "type": "options",
      "default": "javaScript",
      "options": [
        {
          "name": "JavaScript",
          "value": "javaScript",
          "action": "Code in JavaScript"
        },
        {
          "name": "Python (Beta)",
          "value": "python",
          "action": "Code in Python (Beta)"
        },
        {
          "name": "Python (Native) (Beta)",
          "value": "pythonNative",
          "action": "Code in Python (Native) (Beta)"
        }
      ],
      "displayOptions": {
        "show": {
          "@version": [
            2
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Language",
      "name": "language",
      "type": "hidden",
      "default": "javaScript",
      "displayOptions": {
        "show": {
          "@version": [
            1
          ]
        }
      }
    },
    {
      "displayName": "JavaScript",
      "name": "jsCode",
      "type": "string",
      "default": "",
      "description": "JavaScript code to execute.<br><br>Tip: You can use luxon vars like <code>$today</code> for dates and <code>$jmespath</code> for querying JSON structures. <a href=\"https://docs.n8n.io/nodes/n8n-nodes-base.function\">Learn more</a>.",
      "displayOptions": {
        "show": {
          "@version": [
            1
          ],
          "mode": [
            "runOnceForAllItems"
          ]
        }
      },
      "typeOptions": {
        "editor": "codeNodeEditor",
        "editorLanguage": "javaScript"
      },
      "noDataExpression": true
    },
    {
      "displayName": "JavaScript",
      "name": "jsCode",
      "type": "string",
      "default": "",
      "description": "JavaScript code to execute.<br><br>Tip: You can use luxon vars like <code>$today</code> for dates and <code>$jmespath</code> for querying JSON structures. <a href=\"https://docs.n8n.io/nodes/n8n-nodes-base.function\">Learn more</a>.",
      "displayOptions": {
        "show": {
          "@version": [
            1
          ],
          "mode": [
            "runOnceForEachItem"
          ]
        }
      },
      "typeOptions": {
        "editor": "codeNodeEditor",
        "editorLanguage": "javaScript"
      },
      "noDataExpression": true
    },
    {
      "displayName": "JavaScript",
      "name": "jsCode",
      "type": "string",
      "default": "",
      "description": "JavaScript code to execute.<br><br>Tip: You can use luxon vars like <code>$today</code> for dates and <code>$jmespath</code> for querying JSON structures. <a href=\"https://docs.n8n.io/nodes/n8n-nodes-base.function\">Learn more</a>.",
      "displayOptions": {
        "show": {
          "@version": [
            2
          ],
          "language": [
            "javaScript"
          ],
          "mode": [
            "runOnceForAllItems"
          ]
        }
      },
      "typeOptions": {
        "editor": "codeNodeEditor",
        "editorLanguage": "javaScript"
      },
      "noDataExpression": true
    },
    {
      "displayName": "JavaScript",
      "name": "jsCode",
      "type": "string",
      "default": "",
      "description": "JavaScript code to execute.<br><br>Tip: You can use luxon vars like <code>$today</code> for dates and <code>$jmespath</code> for querying JSON structures. <a href=\"https://docs.n8n.io/nodes/n8n-nodes-base.function\">Learn more</a>.",
      "displayOptions": {
        "show": {
          "@version": [
            2
          ],
          "language": [
            "javaScript"
          ],
          "mode": [
            "runOnceForEachItem"
          ]
        }
      },
      "typeOptions": {
        "editor": "codeNodeEditor",
        "editorLanguage": "javaScript"
      },
      "noDataExpression": true
    },
    {
      "displayName": "Type <code>$</code> for a list of <a target=\"_blank\" href=\"https://docs.n8n.io/code-examples/methods-variables-reference/\">special vars/methods</a>. Debug by using <code>console.log()</code> statements and viewing their output in the browser console.",
      "name": "notice",
      "type": "notice",
      "default": "",
      "displayOptions": {
        "show": {
          "language": [
            "javaScript"
          ]
        }
      }
    },
    {
      "displayName": "Python",
      "name": "pythonCode",
      "type": "string",
      "default": "",
      "description": "Python code to execute.<br><br>Tip: You can use built-in methods and variables like <code>_today</code> for dates and <code>_jmespath</code> for querying JSON structures. <a href=\"https://docs.n8n.io/code/builtin/\">Learn more</a>.",
      "displayOptions": {
        "show": {
          "language": [
            "python",
            "pythonNative"
          ],
          "mode": [
            "runOnceForAllItems"
          ]
        }
      },
      "typeOptions": {
        "editor": "codeNodeEditor",
        "editorLanguage": "python"
      },
      "noDataExpression": true
    },
    {
      "displayName": "Python",
      "name": "pythonCode",
      "type": "string",
      "default": "",
      "description": "Python code to execute.<br><br>Tip: You can use built-in methods and variables like <code>_today</code> for dates and <code>_jmespath</code> for querying JSON structures. <a href=\"https://docs.n8n.io/code/builtin/\">Learn more</a>.",
      "displayOptions": {
        "show": {
          "language": [
            "python",
            "pythonNative"
          ],
          "mode": [
            "runOnceForEachItem"
          ]
        }
      },
      "typeOptions": {
        "editor": "codeNodeEditor",
        "editorLanguage": "python"
      },
      "noDataExpression": true
    },
    {
      "displayName": "Debug by using <code>print()</code> statements and viewing their output in the browser console.",
      "name": "notice",
      "type": "notice",
      "default": "",
      "displayOptions": {
        "show": {
          "language": [
            "python"
          ]
        }
      }
    },
    {
      "displayName": "Debug by using <code>print()</code> statements and viewing their output in the browser console.<br><br>The native Python option does not support <code>_</code> syntax and helpers, except for <code>_items</code> in all-items mode and <code>_item</code> in per-item mode.",
      "name": "notice",
      "type": "notice",
      "default": "",
      "displayOptions": {
        "show": {
          "language": [
            "pythonNative"
          ]
        }
      }
    }
  ]


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

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

  # CoinGecko node

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

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

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

  ## Operations

  * Coin
      * Get a candlestick open-high-low-close chart for the selected currency
      * Get current data for a coin
      * Get all coins
      * Get historical data (name, price, market, stats) at a given date for a coin
      * Get prices and market related data for all trading pairs that match the selected currency
      * Get historical market data include price, market cap, and 24h volume (granularity auto)
      * Get the current price of any cryptocurrencies in any other supported currencies that you need
      * Get coin tickers
  * Event
      * Get all events

  ## Templates and examples

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

properties_schema:
  [
    {
      "displayName": "Resource",
      "name": "resource",
      "type": "options",
      "default": "coin",
      "options": [
        {
          "name": "Coin",
          "value": "coin"
        },
        {
          "name": "Event",
          "value": "event"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "getAll",
      "options": [
        {
          "name": "Candlestick",
          "value": "candlestick",
          "description": "Get a candlestick open-high-low-close chart for the selected currency",
          "action": "Get a candlestick for a coin"
        },
        {
          "name": "Get",
          "value": "get",
          "description": "Get current data for a coin",
          "action": "Get a coin"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get many coins",
          "action": "Get many coins"
        },
        {
          "name": "History",
          "value": "history",
          "description": "Get historical data (name, price, market, stats) at a given date for a coin",
          "action": "Get history for a coin"
        },
        {
          "name": "Market",
          "value": "market",
          "description": "Get prices and market related data for all trading pairs that match the selected currency",
          "action": "Get market prices for a coin"
        },
        {
          "name": "Market Chart",
          "value": "marketChart",
          "description": "Get historical market data include price, market cap, and 24h volume (granularity auto)",
          "action": "Get market chart for a coin"
        },
        {
          "name": "Price",
          "value": "price",
          "description": "Get the current price of any cryptocurrencies in any other supported currencies that you need",
          "action": "Get the price for a coin"
        },
        {
          "name": "Ticker",
          "value": "ticker",
          "description": "Get coin tickers",
          "action": "Get the ticker for a coin"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "coin"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Search By",
      "name": "searchBy",
      "type": "options",
      "default": "coinId",
      "description": "Search by coin ID or contract address",
      "options": [
        {
          "name": "Coin ID",
          "value": "coinId"
        },
        {
          "name": "Contract Address",
          "value": "contractAddress"
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "get",
            "marketChart",
            "price"
          ],
          "resource": [
            "coin"
          ]
        }
      }
    },
    {
      "displayName": "Coin Name or ID",
      "name": "coinId",
      "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": [
            "get"
          ],
          "resource": [
            "coin"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getCoins"
      }
    },
    {
      "displayName": "Base Currency Name or ID",
      "name": "baseCurrency",
      "type": "options",
      "default": "",
      "description": "The first currency in the pair. For BTC:ETH this is BTC. 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": [
            "candlestick"
          ],
          "resource": [
            "coin"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getCoins"
      }
    },
    {
      "displayName": "Base Currency Name or ID",
      "name": "baseCurrency",
      "type": "options",
      "default": "",
      "description": "The first currency in the pair. For BTC:ETH this is BTC. 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": [
            "market"
          ],
          "resource": [
            "coin"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getCurrencies"
      }
    },
    {
      "displayName": "Coin Name or ID",
      "name": "coinId",
      "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": [
            "ticker",
            "history"
          ],
          "resource": [
            "coin"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getCoins"
      }
    },
    {
      "displayName": "Base Currency Names or IDs",
      "name": "baseCurrencies",
      "type": "multiOptions",
      "default": [],
      "description": "The first currency in the pair. For BTC:ETH this is BTC. Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "price"
          ],
          "resource": [
            "coin"
          ],
          "searchBy": [
            "coinId"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getCoins"
      }
    },
    {
      "displayName": "Platform ID",
      "name": "platformId",
      "type": "options",
      "default": "ethereum",
      "description": "The ID of the platform issuing tokens",
      "options": [
        {
          "name": "Ethereum",
          "value": "ethereum"
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "get",
            "marketChart",
            "price"
          ],
          "resource": [
            "coin"
          ],
          "searchBy": [
            "contractAddress"
          ]
        }
      }
    },
    {
      "displayName": "Contract Address",
      "name": "contractAddress",
      "type": "string",
      "default": "",
      "description": "Token's contract address",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "get",
            "marketChart"
          ],
          "resource": [
            "coin"
          ],
          "searchBy": [
            "contractAddress"
          ]
        }
      }
    },
    {
      "displayName": "Contract Addresses",
      "name": "contractAddresses",
      "type": "string",
      "default": "",
      "description": "The contract address of tokens, comma-separated",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "price"
          ],
          "resource": [
            "coin"
          ],
          "searchBy": [
            "contractAddress"
          ]
        }
      }
    },
    {
      "displayName": "Base Currency Name or ID",
      "name": "baseCurrency",
      "type": "options",
      "default": "",
      "description": "The first currency in the pair. For BTC:ETH this is BTC. 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": [
            "marketChart"
          ],
          "resource": [
            "coin"
          ],
          "searchBy": [
            "coinId"
          ]
        },
        "hide": {
          "searchBy": [
            "contractAddress"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getCoins"
      }
    },
    {
      "displayName": "Quote Currency Name or ID",
      "name": "quoteCurrency",
      "type": "options",
      "default": "",
      "description": "The second currency in the pair. For BTC:ETH this is ETH. 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": [
            "candlestick",
            "marketChart"
          ],
          "resource": [
            "coin"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getCurrencies"
      }
    },
    {
      "displayName": "Quote Currency Names or IDs",
      "name": "quoteCurrencies",
      "type": "multiOptions",
      "default": [],
      "description": "The second currency in the pair. For BTC:ETH this is ETH. Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "price"
          ],
          "resource": [
            "coin"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getCurrencies"
      }
    },
    {
      "displayName": "Range (Days)",
      "name": "days",
      "type": "options",
      "default": "",
      "description": "Return data for this many days in the past from now",
      "options": [
        {
          "name": "1",
          "value": "1"
        },
        {
          "name": "7",
          "value": "7"
        },
        {
          "name": "14",
          "value": "14"
        },
        {
          "name": "30",
          "value": "30"
        },
        {
          "name": "90",
          "value": "90"
        },
        {
          "name": "180",
          "value": "180"
        },
        {
          "name": "365",
          "value": "365"
        },
        {
          "name": "Max",
          "value": "max"
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "marketChart",
            "candlestick"
          ],
          "resource": [
            "coin"
          ]
        }
      }
    },
    {
      "displayName": "Date",
      "name": "date",
      "type": "dateTime",
      "default": "",
      "description": "The date of data snapshot",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "history"
          ],
          "resource": [
            "coin"
          ]
        }
      }
    },
    {
      "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",
            "market",
            "ticker"
          ],
          "resource": [
            "coin"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 100,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "operation": [
            "getAll",
            "market",
            "ticker"
          ],
          "resource": [
            "coin"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 500
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Coin IDs",
          "name": "ids",
          "type": "string",
          "placeholder": "bitcoin",
          "default": "",
          "description": "Filter results by comma-separated list of coin ID"
        },
        {
          "displayName": "Category",
          "name": "category",
          "type": "options",
          "options": [
            {
              "name": "Decentralized Finance Defi",
              "value": "decentralized_finance_defi"
            }
          ],
          "default": "decentralized_finance_defi",
          "description": "Filter by coin category"
        },
        {
          "displayName": "Order",
          "name": "order",
          "type": "options",
          "options": [
            {
              "name": "Gecko Asc",
              "value": "gecko_asc"
            },
            {
              "name": "Gecko Desc",
              "value": "gecko_desc"
            },
            {
              "name": "ID Asc",
              "value": "id_asc"
            },
            {
              "name": "ID Desc",
              "value": "id_desc"
            },
            {
              "name": "Market Cap Asc",
              "value": "market_cap_asc"
            },
            {
              "name": "Market Cap Desc",
              "value": "market_cap_desc"
            },
            {
              "name": "Volume Asc",
              "value": "volume_asc"
            },
            {
              "name": "Volume Desc",
              "value": "volume_desc"
            }
          ],
          "default": "",
          "description": "Sort results by field"
        },
        {
          "displayName": "Sparkline",
          "name": "sparkline",
          "type": "boolean",
          "default": false,
          "description": "Whether to include sparkline 7 days data"
        },
        {
          "displayName": "Price Change Percentage",
          "name": "price_change_percentage",
          "type": "multiOptions",
          "options": [
            {
              "name": "1h",
              "value": "1h"
            },
            {
              "name": "24h",
              "value": "24h"
            },
            {
              "name": "7d",
              "value": "7d"
            },
            {
              "name": "14d",
              "value": "14d"
            },
            {
              "name": "30d",
              "value": "30d"
            },
            {
              "name": "200d",
              "value": "200d"
            },
            {
              "name": "1y",
              "value": "1y"
            }
          ],
          "default": [],
          "description": "Include price change percentage for specified times"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "coin"
          ],
          "operation": [
            "market"
          ]
        }
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Include 24hr Change",
          "name": "include_24hr_change",
          "type": "boolean",
          "default": false
        },
        {
          "displayName": "Include 24hr Vol",
          "name": "include_24hr_vol",
          "type": "boolean",
          "default": false
        },
        {
          "displayName": "Include Last Updated At",
          "name": "include_last_updated_at",
          "type": "boolean",
          "default": false
        },
        {
          "displayName": "Include Market Cap",
          "name": "include_market_cap",
          "type": "boolean",
          "default": false
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "coin"
          ],
          "operation": [
            "price"
          ]
        }
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Exchange Names or IDs",
          "name": "exchange_ids",
          "type": "multiOptions",
          "typeOptions": {
            "loadOptionsMethod": "getExchanges"
          },
          "default": [],
          "description": "Filter results by exchange IDs. Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        },
        {
          "displayName": "Include Exchange Logo",
          "name": "include_exchange_logo",
          "type": "boolean",
          "default": false
        },
        {
          "displayName": "Order",
          "name": "order",
          "type": "options",
          "options": [
            {
              "name": "Trust Score Desc",
              "value": "trust_score_desc"
            },
            {
              "name": "Trust Score Asc",
              "value": "trust_score_asc"
            },
            {
              "name": "Volume Desc",
              "value": "volume_desc"
            }
          ],
          "default": "trust_score_desc",
          "description": "Sorts results by the selected rule"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "coin"
          ],
          "operation": [
            "ticker"
          ]
        }
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Localization",
          "name": "localization",
          "type": "boolean",
          "default": true,
          "description": "Whether to exclude localized languages in response"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "coin"
          ],
          "operation": [
            "history"
          ]
        }
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Community Data",
          "name": "community_data",
          "type": "boolean",
          "default": false,
          "description": "Whether to include community data"
        },
        {
          "displayName": "Developer Data",
          "name": "developer_data",
          "type": "boolean",
          "default": false,
          "description": "Whether to include developer data"
        },
        {
          "displayName": "Localization",
          "name": "localization",
          "type": "boolean",
          "default": false,
          "description": "Whether to include all localized languages in response"
        },
        {
          "displayName": "Market Data",
          "name": "market_data",
          "type": "boolean",
          "default": false,
          "description": "Whether to include market data"
        },
        {
          "displayName": "Sparkline",
          "name": "sparkline",
          "type": "boolean",
          "default": false,
          "description": "Whether to include sparkline 7 days data (eg. true, false)."
        },
        {
          "displayName": "Tickers",
          "name": "tickers",
          "type": "boolean",
          "default": false,
          "description": "Whether to include tickers data"
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "get"
          ],
          "resource": [
            "coin"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "getAll",
      "options": [
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get many events",
          "action": "Get many events"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "event"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Return All",
      "name": "returnAll",
      "type": "boolean",
      "default": false,
      "description": "Whether to return all results or only up to a given limit",
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "event"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 100,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "event"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 500
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Country Code",
          "name": "country_code",
          "type": "options",
          "typeOptions": {
            "loadOptionsMethod": "getEventCountryCodes"
          },
          "default": "",
          "description": "Country code of event. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        },
        {
          "displayName": "From Date",
          "name": "from_date",
          "type": "dateTime",
          "default": "",
          "description": "Lists events after this date"
        },
        {
          "displayName": "To Date",
          "name": "to_date",
          "type": "dateTime",
          "default": "",
          "description": "Lists events before this date"
        },
        {
          "displayName": "Type Name or ID",
          "name": "type",
          "type": "options",
          "typeOptions": {
            "loadOptionsMethod": "getEventTypes"
          },
          "default": "",
          "description": "Type of event. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        },
        {
          "displayName": "Upcoming Events Only",
          "name": "upcoming_events_only",
          "type": "boolean",
          "default": true,
          "description": "Whether to list only upcoming events"
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "event"
          ]
        }
      }
    }
  ]

operations:
  [
    {
      "operation": "candlestick",
      "name": "Candlestick",
      "description": "Get a candlestick open-high-low-close chart for the selected currency"
    },
    {
      "operation": "get",
      "name": "Get",
      "description": "Get current data for a coin"
    },
    {
      "operation": "getAll",
      "name": "Get Many",
      "description": "Get many coins"
    },
    {
      "operation": "history",
      "name": "History",
      "description": "Get historical data (name, price, market, stats) at a given date for a coin"
    },
    {
      "operation": "market",
      "name": "Market",
      "description": "Get prices and market related data for all trading pairs that match the selected currency"
    },
    {
      "operation": "marketChart",
      "name": "Market Chart",
      "description": "Get historical market data include price, market cap, and 24h volume (granularity auto)"
    },
    {
      "operation": "price",
      "name": "Price",
      "description": "Get the current price of any cryptocurrencies in any other supported currencies that you need"
    },
    {
      "operation": "ticker",
      "name": "Ticker",
      "description": "Get coin tickers"
    }
  ]


node_type: nodes-base.compareDatasets
package_name: n8n-nodes-base
display_name: Compare Datasets
description: Compare two inputs for changes
category: transform
development_style: programmatic
version: 2.3
operations: []
credentials_required: []
outputs:
  [
  "main",
  "main",
  "main",
  "main"
  ]

output_names:
  [
  "In A only",
  "Same",
  "Different",
  "In B only"
  ]

updated_at: 2025-11-03 20:57:26
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: Compare Datasets
  description: Documentation for the Compare Datasets node in n8n, a workflow automation platform. Includes guidance on usage, and links to examples.
  contentType: [integration, reference]
  priority: high
  ---

  # Compare Datasets

  The Compare Datasets node helps you compare data from two input streams.

  ## Node parameters

  1. Decide which fields to compare. In **Input A Field**, enter the name of the field you want to use from input stream A. In **Input B Field**, enter the name of the field you want to use from input stream B. 
  2. **Optional**: You can compare by multiple fields. Select **Add Fields to Match** to set up more comparisons.
  3. Choose how to handle differences between the datasets. In **When There Are Differences**, select one of the following:
  	* **Use Input A Version** to treat input stream A as the source of truth.
  	* **Use Input B Version** to treat input stream B as the source of truth.
  	* **Use a Mix of Versions** to use different inputs for different fields.
  		* Use **Prefer** to select either **Input A Version** or **Input B Version** as the main source of truth.
  		* Enter input fields that are exceptions to **For Everything Except** to pull from the other input source. To add multiple input fields, enter a comma-separated list.
  	* **Include Both Versions** to include both input streams in the output, which may make the structure more complex.
  4. Decide whether to use **Fuzzy Compare**. When turned on, the comparison will tolerate small type differences when comparing fields. For example, the number 3 and the string `3` are treated as the same with **Fuzzy Compare** turned on, but wouldn't be treated the same with it turned off.

  ## Understand item comparison

  Item comparison is a two stage process:

  1. n8n checks if the values of the fields you selected to compare match across both inputs.
  2. If the fields to compare match, n8n then compares all fields within the items, to determine if the items are the same or different.

  ## Node options

  Use the node **Options** to refine your comparison or tweak comparison behavior.

  ### Fields to Skip Comparing

  Enter field names that you want to ignore in the comparison.

  For example, if you compare the two datasets below using `person.language` as the **Fields to Match**, n8n returns them as different. If you add `person.name` to **Fields to Skip Comparing**, n8n returns them as matching.

  ```json
  	// Input 1
  	[
  		{
  			"person":
  			{
  				"name":	"Stefan",
  				"language":	"de"
  			}
  		},
  		{
  			"person":
  			{
  				"name":	"Jim",
  				"language":	"en"
  			}
  		},
  		{
  			"person":
  			{
  				"name":	"Hans",
  				"language":	"de"
  			}
  		}
  	]
  	// Input 2
  		[
  		{
  			"person":
  			{
  				"name":	"Sara",
  				"language":	"de"
  			}
  		},
  		{
  			"person":
  			{
  				"name":	"Jane",
  				"language":	"en"
  			}
  		},
  		{
  			"person":
  			{
  				"name":	"Harriet",
  				"language":	"de"
  			}
  		}
  	]
  ```

  ### Disable Dot Notation

  Whether to disallow referencing child fields using `parent.child` in the field name (turned on) or allow it (turned off, default).

  ### Multiple Matches

  Choose how to handle duplicate data. The default is **Include All Matches**. You can choose **Include First Match Only**.

  For example, given these two datasets:
  ```json
  	// Input 1
  	[
  		{
  			"fruit": {
  				"type": "apple",
  				"color": "red"
  			}
  		},
  				{
  			"fruit": {
  				"type": "apple",
  				"color": "red"
  			}
  		},
  				{
  			"fruit": {
  				"type": "banana",
  				"color": "yellow"
  			}
  		}
  	]
  	// Input 2
  	[
  		{
  			"fruit": {
  				"type": "apple",
  				"color": "red"
  			}
  		},
  				{
  			"fruit": {
  				"type": "apple",
  				"color": "red"
  			}
  		},
  				{
  			"fruit": {
  				"type": "banana",
  				"color": "yellow"
  			}
  		}
  	]
  ```

  n8n returns three items in the **Same Branch** tab. The data is the same in both branches.

  If you select **Include First Match Only**, n8n returns two items, in the **Same Branch** tab. The data is the same in both branches, but n8n only returns the first occurrence of the matching "apple" items.


  ## Understand the output

  There are four output options:

  * **In A only Branch**: Contains data that occurs only in the first input.
  * **Same Branch**: Contains data that's the same in both inputs.
  * **Different Branch**: Contains data that's different between inputs.
  * **In B only Branch**: Contains data that occurs only in the second output.

  ## Templates and examples

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

properties_schema:
  [
    {
      "displayName": "Items from different branches are paired together when the fields below match. If paired, the rest of the fields are compared to determine whether the items are the same or different",
      "name": "infoBox",
      "type": "notice",
      "default": ""
    },
    {
      "displayName": "Fields to Match",
      "name": "mergeByFields",
      "type": "fixedCollection",
      "default": {
        "values": [
          {
            "field1": "",
            "field2": ""
          }
        ]
      },
      "options": [
        {
          "displayName": "Values",
          "name": "values",
          "values": [
            {
              "displayName": "Input A Field",
              "name": "field1",
              "type": "string",
              "default": "",
              "placeholder": "e.g. id",
              "hint": " Enter the field name as text",
              "requiresDataPath": "single"
            },
            {
              "displayName": "Input B Field",
              "name": "field2",
              "type": "string",
              "default": "",
              "placeholder": "e.g. id",
              "hint": " Enter the field name as text",
              "requiresDataPath": "single"
            }
          ]
        }
      ],
      "typeOptions": {
        "multipleValues": true
      }
    },
    {
      "displayName": "When There Are Differences",
      "name": "resolve",
      "type": "options",
      "default": "preferInput2",
      "options": [
        {
          "name": "Use Input A Version",
          "value": "preferInput1"
        },
        {
          "name": "Use Input B Version",
          "value": "preferInput2"
        },
        {
          "name": "Use a Mix of Versions",
          "value": "mix",
          "description": "Output uses different inputs for different fields"
        },
        {
          "name": "Include Both Versions",
          "value": "includeBoth",
          "description": "Output contains all data (but structure more complex)"
        }
      ],
      "displayOptions": {
        "show": {
          "@version": [
            1,
            2
          ]
        }
      }
    },
    {
      "displayName": "When There Are Differences",
      "name": "resolve",
      "type": "options",
      "default": "includeBoth",
      "options": [
        {
          "name": "Use Input A Version",
          "value": "preferInput1"
        },
        {
          "name": "Use Input B Version",
          "value": "preferInput2"
        },
        {
          "name": "Use a Mix of Versions",
          "value": "mix",
          "description": "Output uses different inputs for different fields"
        },
        {
          "name": "Include Both Versions",
          "value": "includeBoth",
          "description": "Output contains all data (but structure more complex)"
        }
      ],
      "displayOptions": {
        "hide": {
          "@version": [
            1,
            2
          ]
        }
      }
    },
    {
      "displayName": "Fuzzy Compare",
      "name": "fuzzyCompare",
      "type": "boolean",
      "default": false,
      "description": "Whether to tolerate small type differences when comparing fields. E.g. the number 3 and the string '3' are treated as the same.",
      "displayOptions": {
        "hide": {
          "@version": [
            1
          ]
        }
      }
    },
    {
      "displayName": "Prefer",
      "name": "preferWhenMix",
      "type": "options",
      "default": "input1",
      "options": [
        {
          "name": "Input A Version",
          "value": "input1"
        },
        {
          "name": "Input B Version",
          "value": "input2"
        }
      ],
      "displayOptions": {
        "show": {
          "resolve": [
            "mix"
          ]
        }
      }
    },
    {
      "displayName": "For Everything Except",
      "name": "exceptWhenMix",
      "type": "string",
      "default": "",
      "displayOptions": {
        "show": {
          "resolve": [
            "mix"
          ]
        }
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Fields to Skip Comparing",
          "name": "skipFields",
          "type": "string",
          "default": "",
          "placeholder": "e.g. updated_at, updated_by",
          "hint": "Enter the field names as text, separated by commas",
          "description": "Fields that shouldn't be included when checking whether two items are the same",
          "requiresDataPath": "multiple"
        },
        {
          "displayName": "Fuzzy Compare",
          "name": "fuzzyCompare",
          "type": "boolean",
          "default": false,
          "description": "Whether to tolerate small type differences when comparing fields. E.g. the number 3 and the string '3' are treated as the same.",
          "displayOptions": {
            "show": {
              "@version": [
                1
              ]
            }
          }
        },
        {
          "displayName": "Disable Dot Notation",
          "name": "disableDotNotation",
          "type": "boolean",
          "default": false,
          "description": "Whether to disallow referencing child fields using `parent.child` in the field name"
        },
        {
          "displayName": "Multiple Matches",
          "name": "multipleMatches",
          "type": "options",
          "default": "first",
          "options": [
            {
              "name": "Include First Match Only",
              "value": "first",
              "description": "Only ever output a single item per match"
            },
            {
              "name": "Include All Matches",
              "value": "all",
              "description": "Output multiple items if there are multiple matches"
            }
          ]
        }
      ]
    }
  ]


node_type: nodes-base.compression
package_name: n8n-nodes-base
display_name: Compression
description: Compress and decompress files
category: transform
development_style: programmatic
version: 1.1
credentials_required: []
outputs:
  [
  "main"
  ]

updated_at: 2025-11-03 20:57:26
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: Compression
  description: Documentation for the Compression node in n8n, a workflow automation platform. Includes guidance on usage, and links to examples.
  contentType: [integration, reference]
  priority: medium
  ---

  # Compression

  Use the Compression node to compress and decompress files. Supports Zip and Gzip formats.

  ## Node parameters

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

  The node parameters depend on which **Operation** you select. Choose to:

  * **Compress**: Create a compressed file from your input data.
  * **Decompress**: Decompress an existing compressed file.

  Refer to the sections below for parameters specific to each **Operation**.

  ### Compress

  - **Input Binary Field(s)**: Enter the name of the fields in the input data that contain the binary files you want to compress. To compress more than one file, use a comma-separated list.
  - **Output Format**: Choose whether to format the compressed output as **Zip** or **Gzip**.
  - **File Name**: Enter the name of the zip file the node creates.
  - **Put Output File in Field**: Enter the name of the field in the output data to contain the file.

  ### Decompress

  - **Put Output File in Field**: Enter the name of the fields in the input data that contain the binary files you want to decompress. To decompress more than one file, use a comma-separated list.
  - **Output Prefix**: Enter a prefix to add to the output file name.

  ## Templates and examples

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

properties_schema:
  [
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "decompress",
      "options": [
        {
          "name": "Compress",
          "value": "compress",
          "action": "Compress file(s)",
          "description": "Compress files into a zip or gzip archive"
        },
        {
          "name": "Decompress",
          "value": "decompress",
          "action": "Decompress file(s)",
          "description": "Decompress zip or gzip archives"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "Input Binary Field(s)",
      "name": "binaryPropertyName",
      "type": "string",
      "default": "data",
      "description": "To process more than one file, use a comma-separated list of the binary fields names",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "compress"
          ]
        }
      }
    },
    {
      "displayName": "Input Binary Field(s)",
      "name": "binaryPropertyName",
      "type": "string",
      "default": "data",
      "description": "To process more than one file, use a comma-separated list of the binary fields names",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "decompress"
          ]
        }
      }
    },
    {
      "displayName": "Output Format",
      "name": "outputFormat",
      "type": "options",
      "default": "",
      "description": "Format of the output",
      "options": [
        {
          "name": "Gzip",
          "value": "gzip"
        },
        {
          "name": "Zip",
          "value": "zip"
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "compress"
          ],
          "@version": [
            1
          ]
        }
      }
    },
    {
      "displayName": "Output Format",
      "name": "outputFormat",
      "type": "options",
      "default": "zip",
      "description": "Format of the output",
      "options": [
        {
          "name": "Gzip",
          "value": "gzip"
        },
        {
          "name": "Zip",
          "value": "zip"
        }
      ],
      "displayOptions": {
        "show": {
          "operation": [
            "compress"
          ]
        },
        "hide": {
          "@version": [
            1
          ]
        }
      }
    },
    {
      "displayName": "File Name",
      "name": "fileName",
      "type": "string",
      "default": "",
      "description": "Name of the output file",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "compress"
          ],
          "outputFormat": [
            "zip"
          ]
        }
      }
    },
    {
      "displayName": "Put Output File in Field",
      "name": "binaryPropertyOutput",
      "type": "string",
      "default": "data",
      "displayOptions": {
        "show": {
          "outputFormat": [
            "zip"
          ],
          "operation": [
            "compress"
          ]
        }
      }
    },
    {
      "displayName": "File Name",
      "name": "fileName",
      "type": "string",
      "default": "",
      "description": "Name of the output file",
      "displayOptions": {
        "show": {
          "operation": [
            "compress"
          ],
          "outputFormat": [
            "gzip"
          ]
        },
        "hide": {
          "@version": [
            1
          ]
        }
      }
    },
    {
      "displayName": "Put Output File in Field",
      "name": "binaryPropertyOutput",
      "type": "string",
      "default": "data",
      "displayOptions": {
        "show": {
          "outputFormat": [
            "gzip"
          ],
          "operation": [
            "compress"
          ]
        },
        "hide": {
          "@version": [
            1
          ]
        }
      }
    },
    {
      "displayName": "Output File Prefix",
      "name": "outputPrefix",
      "type": "string",
      "default": "data",
      "description": "Prefix to add to the gzip file",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "compress"
          ],
          "outputFormat": [
            "gzip"
          ],
          "@version": [
            1
          ]
        }
      }
    },
    {
      "displayName": "Output Prefix",
      "name": "outputPrefix",
      "type": "string",
      "default": "file_",
      "description": "Prefix to add to the decompressed files",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "decompress"
          ]
        }
      }
    }
  ]

operations:
  [
    {
      "operation": "compress",
      "name": "Compress",
      "description": "Compress files into a zip or gzip archive"
    },
    {
      "operation": "decompress",
      "name": "Decompress",
      "description": "Decompress zip or gzip archives"
    }
  ]


node_type: nodes-base.contentful
package_name: n8n-nodes-base
display_name: Contentful
description: Consume Contentful API
category: input
development_style: programmatic
version: 1
operations:
  [
  {
  "operation": "get",
  "name": "Get"
  }
  ]

credentials_required:
  [
  {
  "name": "contentfulApi",
  "required": true
  }
  ]

outputs:
  [
  "main"
  ]

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

  # Contentful node

  Use the Contentful node to automate work in Contentful, and integrate Contentful with other applications. n8n has built-in support for a wide range of Contentful features, including getting assets, content types, entries, locales, and space.

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

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

  ## Operations

  * Asset
      * Get
      * Get All
  * Content Type
      * Get
  * Entry
      * Get
      * Get All
  * Locale
      * Get All
  * Space
      * Get

  ## Templates and examples

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

properties_schema:
  [
    {
      "displayName": "Source",
      "name": "source",
      "type": "options",
      "default": "deliveryApi",
      "description": "Pick where your data comes from, delivery or preview API",
      "options": [
        {
          "name": "Delivery API",
          "value": "deliveryApi"
        },
        {
          "name": "Preview API",
          "value": "previewApi"
        }
      ]
    },
    {
      "displayName": "Resource",
      "name": "resource",
      "type": "options",
      "default": "entry",
      "options": [
        {
          "name": "Asset",
          "value": "asset"
        },
        {
          "name": "Content Type",
          "value": "contentType"
        },
        {
          "name": "Entry",
          "value": "entry"
        },
        {
          "name": "Locale",
          "value": "locale"
        },
        {
          "name": "Space",
          "value": "space"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "get",
      "options": [
        {
          "name": "Get",
          "value": "get"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "space"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "get",
      "options": [
        {
          "name": "Get",
          "value": "get"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "contentType"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "get",
      "options": [
        {
          "name": "Get",
          "value": "get"
        },
        {
          "name": "Get Many",
          "value": "getAll"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "entry"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "getAll",
      "options": [
        {
          "name": "Get",
          "value": "get"
        },
        {
          "name": "Get Many",
          "value": "getAll"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "asset"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "getAll",
      "options": [
        {
          "name": "Get Many",
          "value": "getAll"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "locale"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Environment ID",
      "name": "environmentId",
      "type": "string",
      "default": "master",
      "description": "The ID for the Contentful environment (e.g. master, staging, etc.). Depending on your plan, you might not have environments. In that case use \"master\".",
      "displayOptions": {
        "show": {
          "resource": [
            "contentType"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Content Type ID",
      "name": "contentTypeId",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "contentType"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "RAW Data",
          "name": "rawData",
          "type": "boolean",
          "default": false,
          "description": "Whether the data should be returned RAW instead of parsed"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "contentType"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Environment ID",
      "name": "environmentId",
      "type": "string",
      "default": "master",
      "description": "The ID for the Contentful environment (e.g. master, staging, etc.). Depending on your plan, you might not have environments. In that case use \"master\".",
      "displayOptions": {
        "show": {
          "resource": [
            "entry"
          ],
          "operation": [
            "get",
            "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": [
            "entry"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 100,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "entry"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 500
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Content Type ID",
          "name": "content_type",
          "type": "string",
          "default": "",
          "description": "To search for entries with a specific content type"
        },
        {
          "displayName": "Equal",
          "name": "equal",
          "type": "string",
          "default": "",
          "placeholder": "fields.title=n8n",
          "description": "Search for all data that matches the condition: {attribute}={value}. Attribute can use dot notation."
        },
        {
          "displayName": "Exclude",
          "name": "exclude",
          "type": "string",
          "default": "",
          "placeholder": "fields.tags[nin]=accessories,flowers",
          "description": "Search for all data that matches the condition: {attribute}[nin]={value}. Attribute can use dot notation."
        },
        {
          "displayName": "Exist",
          "name": "exist",
          "type": "string",
          "default": "",
          "placeholder": "fields.tags[exists]=true",
          "description": "Search for all data that matches the condition: {attribute}[exists]={value}. Attribute can use dot notation."
        },
        {
          "displayName": "Fields",
          "name": "select",
          "type": "string",
          "placeholder": "fields.title",
          "default": "",
          "description": "The select operator allows you to choose what fields to return from an entity. You can choose multiple values by combining comma-separated operators."
        },
        {
          "displayName": "Include",
          "name": "include",
          "type": "string",
          "default": "",
          "placeholder": "fields.tags[in]=accessories,flowers",
          "description": "Search for all data that matches the condition: {attribute}[in]={value}. Attribute can use dot notation."
        },
        {
          "displayName": "Not Equal",
          "name": "notEqual",
          "type": "string",
          "default": "",
          "placeholder": "fields.title[ne]=n8n",
          "description": "Search for all data that matches the condition: {attribute}[ne]={value}. Attribute can use dot notation."
        },
        {
          "displayName": "Order",
          "name": "order",
          "type": "string",
          "default": "",
          "placeholder": "sys.createdAt",
          "description": "You can order items in the response by specifying the order search parameter. You can use sys properties (such as sys.createdAt) or field values (such as fields.myCustomDateField) for ordering."
        },
        {
          "displayName": "Query",
          "name": "query",
          "type": "string",
          "default": "",
          "description": "Full-text search is case insensitive and might return more results than expected. A query will only take values with more than 1 character."
        },
        {
          "displayName": "RAW Data",
          "name": "rawData",
          "type": "boolean",
          "default": false,
          "description": "Whether the data should be returned RAW instead of parsed"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "entry"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Entry ID",
      "name": "entryId",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "entry"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "RAW Data",
          "name": "rawData",
          "type": "boolean",
          "default": false,
          "description": "Whether the data should be returned RAW instead of parsed"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "entry"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Environment ID",
      "name": "environmentId",
      "type": "string",
      "default": "master",
      "description": "The ID for the Contentful environment (e.g. master, staging, etc.). Depending on your plan, you might not have environments. In that case use \"master\".",
      "displayOptions": {
        "show": {
          "resource": [
            "asset"
          ],
          "operation": [
            "get",
            "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": [
            "asset"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 100,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "asset"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 500
      }
    },
    {
      "displayName": "Asset ID",
      "name": "assetId",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "asset"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Equal",
          "name": "equal",
          "type": "string",
          "default": "",
          "placeholder": "fields.title=n8n",
          "description": "Search for all data that matches the condition: {attribute}={value}. Attribute can use dot notation."
        },
        {
          "displayName": "Exclude",
          "name": "exclude",
          "type": "string",
          "default": "",
          "placeholder": "fields.tags[nin]=accessories,flowers",
          "description": "Search for all data that matches the condition: {attribute}[nin]={value}. Attribute can use dot notation."
        },
        {
          "displayName": "Exist",
          "name": "exist",
          "type": "string",
          "default": "",
          "placeholder": "fields.tags[exists]=true",
          "description": "Search for all data that matches the condition: {attribute}[exists]={value}. Attribute can use dot notation."
        },
        {
          "displayName": "Fields",
          "name": "select",
          "type": "string",
          "placeholder": "fields.title",
          "default": "",
          "description": "The select operator allows you to choose what fields to return from an entity. You can choose multiple values by combining comma-separated operators."
        },
        {
          "displayName": "Include",
          "name": "include",
          "type": "string",
          "default": "",
          "placeholder": "fields.tags[in]=accessories,flowers",
          "description": "Search for all data that matches the condition: {attribute}[in]={value}. Attribute can use dot notation."
        },
        {
          "displayName": "Not Equal",
          "name": "notEqual",
          "type": "string",
          "default": "",
          "placeholder": "fields.title[ne]=n8n",
          "description": "Search for all data that matches the condition: {attribute}[ne]={value}. Attribute can use dot notation."
        },
        {
          "displayName": "Order",
          "name": "order",
          "type": "string",
          "default": "",
          "placeholder": "sys.createdAt",
          "description": "You can order items in the response by specifying the order search parameter. You can use sys properties (such as sys.createdAt) or field values (such as fields.myCustomDateField) for ordering."
        },
        {
          "displayName": "Query",
          "name": "query",
          "type": "string",
          "default": "",
          "description": "Full-text search is case insensitive and might return more results than expected. A query will only take values with more than 1 character."
        },
        {
          "displayName": "RAW Data",
          "name": "rawData",
          "type": "boolean",
          "default": false,
          "description": "Whether the data should be returned RAW instead of parsed"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "asset"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Environment ID",
      "name": "environmentId",
      "type": "string",
      "default": "master",
      "description": "The ID for the Contentful environment (e.g. master, staging, etc.). Depending on your plan, you might not have environments. In that case use \"master\".",
      "displayOptions": {
        "show": {
          "resource": [
            "locale"
          ],
          "operation": [
            "get",
            "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": [
            "locale"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 100,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "locale"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 500
      }
    }
  ]


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

outputs:
  [
  "main"
  ]

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

  # ConvertKit node

  Use the ConvertKit node to automate work in ConvertKit, and integrate ConvertKit with other applications. n8n has built-in support for a wide range of ConvertKit features, including creating and deleting custom fields, getting tags, and adding subscribers.

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

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

  ## Operations

  * Custom Field
      * Create a field
      * Delete a field
      * Get all fields
      * Update a field
  * Form
      * Add a subscriber
      * Get all forms
      * List subscriptions to a form including subscriber data
  * Sequence
      * Add a subscriber
      * Get all sequences
      * Get all subscriptions to a sequence including subscriber data
  * Tag
      * Create a tag
      * Get all tags
  * Tag Subscriber
      * Add a tag to a subscriber
      * List subscriptions to a tag including subscriber data
      * Delete a tag from a subscriber

  ## Templates and examples

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

properties_schema:
  [
    {
      "displayName": "Resource",
      "name": "resource",
      "type": "options",
      "default": "form",
      "options": [
        {
          "name": "Custom Field",
          "value": "customField"
        },
        {
          "name": "Form",
          "value": "form"
        },
        {
          "name": "Sequence",
          "value": "sequence"
        },
        {
          "name": "Tag",
          "value": "tag"
        },
        {
          "name": "Tag Subscriber",
          "value": "tagSubscriber"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "update",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create a field",
          "action": "Create a custom field"
        },
        {
          "name": "Delete",
          "value": "delete",
          "description": "Delete a field",
          "action": "Delete a custom field"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get many fields",
          "action": "Get many custom fields"
        },
        {
          "name": "Update",
          "value": "update",
          "description": "Update a field",
          "action": "Update a custom field"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "customField"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Field ID",
      "name": "id",
      "type": "string",
      "default": "",
      "description": "The ID of your custom field",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "customField"
          ],
          "operation": [
            "update",
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "Label",
      "name": "label",
      "type": "string",
      "default": "",
      "description": "The label of the custom field",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "customField"
          ],
          "operation": [
            "update",
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Return All",
      "name": "returnAll",
      "type": "boolean",
      "default": false,
      "description": "Whether to return all results or only up to a given limit",
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "customField"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 100,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "customField"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 500
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "addSubscriber",
      "description": "The operations to perform",
      "options": [
        {
          "name": "Add Subscriber",
          "value": "addSubscriber",
          "description": "Add a subscriber",
          "action": "Add a subscriber"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get many forms",
          "action": "Get many forms"
        },
        {
          "name": "Get Subscriptions",
          "value": "getSubscriptions",
          "description": "List subscriptions to a form including subscriber data",
          "action": "Get all subscriptions"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "form"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Form Name or ID",
      "name": "id",
      "type": "options",
      "default": "",
      "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "form"
          ],
          "operation": [
            "addSubscriber",
            "getSubscriptions"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getForms"
      }
    },
    {
      "displayName": "Email",
      "name": "email",
      "type": "string",
      "default": "",
      "description": "The subscriber's email address",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "form"
          ],
          "operation": [
            "addSubscriber"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Custom Fields",
          "name": "fieldsUi",
          "placeholder": "Add Custom Field",
          "description": "Object of key/value pairs for custom fields (the custom field must exist before you can use it here)",
          "type": "fixedCollection",
          "typeOptions": {
            "multipleValues": true
          },
          "default": {},
          "options": [
            {
              "name": "fieldsValues",
              "displayName": "Custom Field",
              "values": [
                {
                  "displayName": "Field Key",
                  "name": "key",
                  "type": "string",
                  "default": "",
                  "placeholder": "last_name",
                  "description": "The field's key"
                },
                {
                  "displayName": "Field Value",
                  "name": "value",
                  "type": "string",
                  "default": "",
                  "placeholder": "Doe",
                  "description": "Value of the field"
                }
              ]
            }
          ]
        },
        {
          "displayName": "First Name",
          "name": "firstName",
          "type": "string",
          "default": "",
          "description": "The subscriber's first name"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "form"
          ],
          "operation": [
            "addSubscriber"
          ]
        }
      }
    },
    {
      "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",
            "getSubscriptions"
          ],
          "resource": [
            "form"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 100,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "operation": [
            "getAll",
            "getSubscriptions"
          ],
          "resource": [
            "form"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 500
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "description": "Receive only active subscribers or cancelled subscribers",
      "options": [
        {
          "displayName": "Subscriber State",
          "name": "subscriberState",
          "type": "options",
          "options": [
            {
              "name": "Active",
              "value": "active"
            },
            {
              "name": "Cancelled",
              "value": "cancelled"
            }
          ],
          "default": "active"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "form"
          ],
          "operation": [
            "getSubscriptions"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "addSubscriber",
      "description": "The operations to perform",
      "options": [
        {
          "name": "Add Subscriber",
          "value": "addSubscriber",
          "description": "Add a subscriber",
          "action": "Add a subscriber"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get many sequences",
          "action": "Get many sequences"
        },
        {
          "name": "Get Subscriptions",
          "value": "getSubscriptions",
          "description": "Get all subscriptions to a sequence including subscriber data",
          "action": "Get all subscriptions to a sequence"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "sequence"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Sequence Name or ID",
      "name": "id",
      "type": "options",
      "default": "",
      "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "sequence"
          ],
          "operation": [
            "addSubscriber",
            "getSubscriptions"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getSequences"
      }
    },
    {
      "displayName": "Email",
      "name": "email",
      "type": "string",
      "default": "",
      "description": "The subscriber's email address",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "sequence"
          ],
          "operation": [
            "addSubscriber"
          ]
        }
      }
    },
    {
      "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",
            "getSubscriptions"
          ],
          "resource": [
            "sequence"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 100,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "operation": [
            "getAll",
            "getSubscriptions"
          ],
          "resource": [
            "sequence"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 500
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Custom Fields",
          "name": "fieldsUi",
          "placeholder": "Add Custom Field",
          "description": "Object of key/value pairs for custom fields (the custom field must exist before you can use it here)",
          "type": "fixedCollection",
          "typeOptions": {
            "multipleValues": true
          },
          "default": {},
          "options": [
            {
              "name": "fieldsValues",
              "displayName": "Custom Field",
              "values": [
                {
                  "displayName": "Field Key",
                  "name": "key",
                  "type": "string",
                  "default": "",
                  "placeholder": "last_name",
                  "description": "The field's key"
                },
                {
                  "displayName": "Field Value",
                  "name": "value",
                  "type": "string",
                  "default": "",
                  "placeholder": "Doe",
                  "description": "Value of the field"
                }
              ]
            }
          ]
        },
        {
          "displayName": "First Name",
          "name": "firstName",
          "type": "string",
          "default": "",
          "description": "The subscriber's first name"
        },
        {
          "displayName": "Tag Names or IDs",
          "name": "tags",
          "type": "multiOptions",
          "typeOptions": {
            "loadOptionsMethod": "getTags"
          },
          "default": [],
          "description": "Tags. Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "sequence"
          ],
          "operation": [
            "addSubscriber"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "description": "Receive only active subscribers or cancelled subscribers",
      "options": [
        {
          "displayName": "Subscriber State",
          "name": "subscriberState",
          "type": "options",
          "options": [
            {
              "name": "Active",
              "value": "active"
            },
            {
              "name": "Cancelled",
              "value": "cancelled"
            }
          ],
          "default": "active"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "sequence"
          ],
          "operation": [
            "getSubscriptions"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create a tag",
          "action": "Create a tag"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get many tags",
          "action": "Get many tags"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "tag"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Name",
      "name": "name",
      "type": "string",
      "default": "",
      "description": "Tag name, multiple can be added separated by comma",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "tag"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Return All",
      "name": "returnAll",
      "type": "boolean",
      "default": false,
      "description": "Whether to return all results or only up to a given limit",
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "tag"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 100,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "tag"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 500
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Add",
          "value": "add",
          "description": "Add a tag to a subscriber",
          "action": "Add a tag to a subscriber"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "List subscriptions to a tag including subscriber data",
          "action": "Get many tag subscriptions"
        },
        {
          "name": "Delete",
          "value": "delete",
          "description": "Delete a tag from a subscriber",
          "action": "Delete a tag from a subscriber"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "tagSubscriber"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Tag Name or ID",
      "name": "tagId",
      "type": "options",
      "default": "",
      "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "tagSubscriber"
          ],
          "operation": [
            "add",
            "getAll",
            "delete"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getTags"
      }
    },
    {
      "displayName": "Email",
      "name": "email",
      "type": "string",
      "default": "",
      "description": "Subscriber email address",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "tagSubscriber"
          ],
          "operation": [
            "add",
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Custom Fields",
          "name": "fields",
          "placeholder": "Add Custom Field",
          "description": "Object of key/value pairs for custom fields (the custom field must exist before you can use it here)",
          "type": "fixedCollection",
          "typeOptions": {
            "multipleValues": true
          },
          "default": {},
          "options": [
            {
              "name": "field",
              "displayName": "Custom Field",
              "values": [
                {
                  "displayName": "Field Key",
                  "name": "key",
                  "type": "string",
                  "default": "",
                  "placeholder": "last_name",
                  "description": "The field's key"
                },
                {
                  "displayName": "Field Value",
                  "name": "value",
                  "type": "string",
                  "default": "",
                  "placeholder": "Doe",
                  "description": "Value of the field"
                }
              ]
            }
          ]
        },
        {
          "displayName": "First Name",
          "name": "firstName",
          "type": "string",
          "default": "",
          "description": "Subscriber first name"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "tagSubscriber"
          ],
          "operation": [
            "add"
          ]
        }
      }
    },
    {
      "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": [
            "tagSubscriber"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 100,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "tagSubscriber"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 500
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "description": "Receive only active subscribers or cancelled subscribers",
      "options": [
        {
          "displayName": "Subscriber State",
          "name": "subscriberState",
          "type": "options",
          "options": [
            {
              "name": "Active",
              "value": "active"
            },
            {
              "name": "Cancelled",
              "value": "cancelled"
            }
          ],
          "default": "active"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "tagSubscriber"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    }
  ]

operations:
  [
    {
      "operation": "create",
      "name": "Create",
      "description": "Create a field"
    },
    {
      "operation": "delete",
      "name": "Delete",
      "description": "Delete a field"
    },
    {
      "operation": "getAll",
      "name": "Get Many",
      "description": "Get many fields"
    },
    {
      "operation": "update",
      "name": "Update",
      "description": "Update a field"
    }
  ]


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

outputs:
  [
  "main"
  ]

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

  # ConvertKit Trigger node

  [ConvertKit](https://www.convertkit.com/){:target=_blank .external-link} is a fully featured email marketing platform. Use ConvertKit to build an email list, send email broadcasts, automate sequences, create segments, and build landing pages.

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

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

properties_schema:
  [
    {
      "displayName": "Event",
      "name": "event",
      "type": "options",
      "default": "",
      "description": "The events that can trigger the webhook and whether they are enabled",
      "options": [
        {
          "name": "Form Subscribe",
          "value": "formSubscribe"
        },
        {
          "name": "Link Click",
          "value": "linkClick"
        },
        {
          "name": "Product Purchase",
          "value": "productPurchase"
        },
        {
          "name": "Purchase Created",
          "value": "purchaseCreate"
        },
        {
          "name": "Sequence Complete",
          "value": "courseComplete"
        },
        {
          "name": "Sequence Subscribe",
          "value": "courseSubscribe"
        },
        {
          "name": "Subscriber Activated",
          "value": "subscriberActivate"
        },
        {
          "name": "Subscriber Unsubscribe",
          "value": "subscriberUnsubscribe"
        },
        {
          "name": "Tag Add",
          "value": "tagAdd"
        },
        {
          "name": "Tag Remove",
          "value": "tagRemove"
        }
      ],
      "required": true
    },
    {
      "displayName": "Form Name or ID",
      "name": "formId",
      "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": {
          "event": [
            "formSubscribe"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getForms"
      }
    },
    {
      "displayName": "Sequence Name or ID",
      "name": "courseId",
      "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": {
          "event": [
            "courseSubscribe",
            "courseComplete"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getSequences"
      }
    },
    {
      "displayName": "Initiating Link",
      "name": "link",
      "type": "string",
      "default": "",
      "description": "The URL of the initiating link",
      "required": true,
      "displayOptions": {
        "show": {
          "event": [
            "linkClick"
          ]
        }
      }
    },
    {
      "displayName": "Product ID",
      "name": "productId",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "event": [
            "productPurchase"
          ]
        }
      }
    },
    {
      "displayName": "Tag Name or ID",
      "name": "tagId",
      "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": {
          "event": [
            "tagAdd",
            "tagRemove"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getTags"
      }
    }
  ]


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

outputs:
  [
  "main"
  ]

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

  # Copper node

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

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

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

  ## Operations

  * Company
      * Create
      * Delete
      * Get
      * Get All
      * Update
  * Customer Source
      * Get All
  * Lead
      * Create
      * Delete
      * Get
      * Get All
      * Update
  * Opportunity
      * Create
      * Delete
      * Get
      * Get All
      * Update
  * Person
      * Create
      * Delete
      * Get
      * Get All
      * Update
  * Project
      * Create
      * Delete
      * Get
      * Get All
      * Update
  * Task
      * Create
      * Delete
      * Get
      * Get All
      * Update
  * User
      * Get All

  ## Templates and examples

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

properties_schema:
  [
    {
      "displayName": "Resource",
      "name": "resource",
      "type": "options",
      "default": "company",
      "options": [
        {
          "name": "Company",
          "value": "company"
        },
        {
          "name": "Customer Source",
          "value": "customerSource"
        },
        {
          "name": "Lead",
          "value": "lead"
        },
        {
          "name": "Opportunity",
          "value": "opportunity"
        },
        {
          "name": "Person",
          "value": "person"
        },
        {
          "name": "Project",
          "value": "project"
        },
        {
          "name": "Task",
          "value": "task"
        },
        {
          "name": "User",
          "value": "user"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "action": "Create a company"
        },
        {
          "name": "Delete",
          "value": "delete",
          "action": "Delete a company"
        },
        {
          "name": "Get",
          "value": "get",
          "action": "Get a company"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "action": "Get many companies"
        },
        {
          "name": "Update",
          "value": "update",
          "action": "Update a company"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "company"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Name",
      "name": "name",
      "type": "string",
      "default": "",
      "description": "Name of the company to create",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "company"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Address",
          "name": "address",
          "placeholder": "Add Address Fields",
          "type": "fixedCollection",
          "default": {},
          "options": [
            {
              "displayName": "Address Fields",
              "name": "addressFields",
              "values": [
                {
                  "displayName": "Street",
                  "name": "street",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "City",
                  "name": "city",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "State",
                  "name": "state",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Postal Code",
                  "name": "postal_code",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Country",
                  "name": "country",
                  "type": "string",
                  "default": "",
                  "description": "ISO 3166 alpha-2 country code"
                }
              ]
            }
          ]
        },
        {
          "displayName": "Details",
          "name": "details",
          "type": "string",
          "default": "",
          "description": "Description of the company to create"
        },
        {
          "displayName": "Email Domain",
          "name": "email_domain",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Phone Numbers",
          "name": "phone_numbers",
          "placeholder": "Add Phone Number",
          "type": "fixedCollection",
          "typeOptions": {
            "multipleValues": true
          },
          "default": {},
          "options": [
            {
              "displayName": "Phone Fields",
              "name": "phoneFields",
              "values": [
                {
                  "displayName": "Number",
                  "name": "number",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Category",
                  "name": "category",
                  "type": "string",
                  "default": ""
                }
              ]
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "company"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Company ID",
      "name": "companyId",
      "type": "string",
      "default": "",
      "description": "ID of the company to delete",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "company"
          ],
          "operation": [
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "Company ID",
      "name": "companyId",
      "type": "string",
      "default": "",
      "description": "ID of the company to retrieve",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "company"
          ],
          "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": [
            "company"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 5,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "company"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 1000
      }
    },
    {
      "displayName": "Filters",
      "name": "filterFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Country",
          "name": "country",
          "type": "options",
          "options": [
            {
              "name": "Afghanistan",
              "value": "AF"
            },
            {
              "name": "Åland Islands",
              "value": "AX"
            },
            {
              "name": "Albania",
              "value": "AL"
            },
            {
              "name": "Algeria",
              "value": "DZ"
            },
            {
              "name": "American Samoa",
              "value": "AS"
            },
            {
              "name": "Andorra",
              "value": "AD"
            },
            {
              "name": "Angola",
              "value": "AO"
            },
            {
              "name": "Anguilla",
              "value": "AI"
            },
            {
              "name": "Antarctica",
              "value": "AQ"
            },
            {
              "name": "Antigua and Barbuda",
              "value": "AG"
            },
            {
              "name": "Argentina",
              "value": "AR"
            },
            {
              "name": "Armenia",
              "value": "AM"
            },
            {
              "name": "Aruba",
              "value": "AW"
            },
            {
              "name": "Australia",
              "value": "AU"
            },
            {
              "name": "Austria",
              "value": "AT"
            },
            {
              "name": "Azerbaijan",
              "value": "AZ"
            },
            {
              "name": "Bahamas (the)",
              "value": "BS"
            },
            {
              "name": "Bahrain",
              "value": "BH"
            },
            {
              "name": "Bangladesh",
              "value": "BD"
            },
            {
              "name": "Barbados",
              "value": "BB"
            },
            {
              "name": "Belarus",
              "value": "BY"
            },
            {
              "name": "Belgium",
              "value": "BE"
            },
            {
              "name": "Belize",
              "value": "BZ"
            },
            {
              "name": "Benin",
              "value": "BJ"
            },
            {
              "name": "Bermuda",
              "value": "BM"
            },
            {
              "name": "Bhutan",
              "value": "BT"
            },
            {
              "name": "Bolivia (Plurinational State of)",
              "value": "BO"
            },
            {
              "name": "Bonaire, Sint Eustatius and Saba",
              "value": "BQ"
            },
            {
              "name": "Bosnia and Herzegovina",
              "value": "BA"
            },
            {
              "name": "Botswana",
              "value": "BW"
            },
            {
              "name": "Bouvet Island",
              "value": "BV"
            },
            {
              "name": "Brazil",
              "value": "BR"
            },
            {
              "name": "British Indian Ocean Territory (the)",
              "value": "IO"
            },
            {
              "name": "Brunei Darussalam",
              "value": "BN"
            },
            {
              "name": "Bulgaria",
              "value": "BG"
            },
            {
              "name": "Burkina Faso",
              "value": "BF"
            },
            {
              "name": "Burundi",
              "value": "BI"
            },
            {
              "name": "Cabo Verde",
              "value": "CV"
            },
            {
              "name": "Cambodia",
              "value": "KH"
            },
            {
              "name": "Cameroon",
              "value": "CM"
            },
            {
              "name": "Canada",
              "value": "CA"
            },
            {
              "name": "Cayman Islands (the)",
              "value": "KY"
            },
            {
              "name": "Central African Republic (the)",
              "value": "CF"
            },
            {
              "name": "Chad",
              "value": "TD"
            },
            {
              "name": "Chile",
              "value": "CL"
            },
            {
              "name": "China",
              "value": "CN"
            },
            {
              "name": "Christmas Island",
              "value": "CX"
            },
            {
              "name": "Cocos (Keeling) Islands (the)",
              "value": "CC"
            },
            {
              "name": "Colombia",
              "value": "CO"
            },
            {
              "name": "Comoros (the)",
              "value": "KM"
            },
            {
              "name": "Congo (the Democratic Republic of the)",
              "value": "CD"
            },
            {
              "name": "Congo (the)",
              "value": "CG"
            },
            {
              "name": "Cook Islands (the)",
              "value": "CK"
            },
            {
              "name": "Costa Rica",
              "value": "CR"
            },
            {
              "name": "Côte d'Ivoire",
              "value": "CI"
            },
            {
              "name": "Croatia",
              "value": "HR"
            },
            {
              "name": "Cuba",
              "value": "CU"
            },
            {
              "name": "Curaçao",
              "value": "CW"
            },
            {
              "name": "Cyprus",
              "value": "CY"
            },
            {
              "name": "Czechia",
              "value": "CZ"
            },
            {
              "name": "Denmark",
              "value": "DK"
            },
            {
              "name": "Djibouti",
              "value": "DJ"
            },
            {
              "name": "Dominica",
              "value": "DM"
            },
            {
              "name": "Dominican Republic (the)",
              "value": "DO"
            },
            {
              "name": "Ecuador",
              "value": "EC"
            },
            {
              "name": "Egypt",
              "value": "EG"
            },
            {
              "name": "El Salvador",
              "value": "SV"
            },
            {
              "name": "Equatorial Guinea",
              "value": "GQ"
            },
            {
              "name": "Eritrea",
              "value": "ER"
            },
            {
              "name": "Estonia",
              "value": "EE"
            },
            {
              "name": "Ethiopia",
              "value": "ET"
            },
            {
              "name": "Falkland Islands (the) [Malvinas]",
              "value": "FK"
            },
            {
              "name": "Faroe Islands (the)",
              "value": "FO"
            },
            {
              "name": "Fiji",
              "value": "FJ"
            },
            {
              "name": "Finland",
              "value": "FI"
            },
            {
              "name": "France",
              "value": "FR"
            },
            {
              "name": "French Guiana",
              "value": "GF"
            },
            {
              "name": "French Polynesia",
              "value": "PF"
            },
            {
              "name": "French Southern Territories (the)",
              "value": "TF"
            },
            {
              "name": "Gabon",
              "value": "GA"
            },
            {
              "name": "Gambia (the)",
              "value": "GM"
            },
            {
              "name": "Georgia",
              "value": "GE"
            },
            {
              "name": "Germany",
              "value": "DE"
            },
            {
              "name": "Ghana",
              "value": "GH"
            },
            {
              "name": "Gibraltar",
              "value": "GI"
            },
            {
              "name": "Greece",
              "value": "GR"
            },
            {
              "name": "Greenland",
              "value": "GL"
            },
            {
              "name": "Grenada",
              "value": "GD"
            },
            {
              "name": "Guadeloupe",
              "value": "GP"
            },
            {
              "name": "Guam",
              "value": "GU"
            },
            {
              "name": "Guatemala",
              "value": "GT"
            },
            {
              "name": "Guernsey",
              "value": "GG"
            },
            {
              "name": "Guinea",
              "value": "GN"
            },
            {
              "name": "Guinea-Bissau",
              "value": "GW"
            },
            {
              "name": "Guyana",
              "value": "GY"
            },
            {
              "name": "Haiti",
              "value": "HT"
            },
            {
              "name": "Heard Island and McDonald Islands",
              "value": "HM"
            },
            {
              "name": "Holy See (the)",
              "value": "VA"
            },
            {
              "name": "Honduras",
              "value": "HN"
            },
            {
              "name": "Hong Kong",
              "value": "HK"
            },
            {
              "name": "Hungary",
              "value": "HU"
            },
            {
              "name": "Iceland",
              "value": "IS"
            },
            {
              "name": "India",
              "value": "IN"
            },
            {
              "name": "Indonesia",
              "value": "ID"
            },
            {
              "name": "Iran (Islamic Republic of)",
              "value": "IR"
            },
            {
              "name": "Iraq",
              "value": "IQ"
            },
            {
              "name": "Ireland",
              "value": "IE"
            },
            {
              "name": "Isle of Man",
              "value": "IM"
            },
            {
              "name": "Israel",
              "value": "IL"
            },
            {
              "name": "Italy",
              "value": "IT"
            },
            {
              "name": "Jamaica",
              "value": "JM"
            },
            {
              "name": "Japan",
              "value": "JP"
            },
            {
              "name": "Jersey",
              "value": "JE"
            },
            {
              "name": "Jordan",
              "value": "JO"
            },
            {
              "name": "Kazakhstan",
              "value": "KZ"
            },
            {
              "name": "Kenya",
              "value": "KE"
            },
            {
              "name": "Kiribati",
              "value": "KI"
            },
            {
              "name": "Korea (the Democratic People's Republic of)",
              "value": "KP"
            },
            {
              "name": "Korea (the Republic of)",
              "value": "KR"
            },
            {
              "name": "Kuwait",
              "value": "KW"
            },
            {
              "name": "Kyrgyzstan",
              "value": "KG"
            },
            {
              "name": "Lao People's Democratic Republic (the)",
              "value": "LA"
            },
            {
              "name": "Latvia",
              "value": "LV"
            },
            {
              "name": "Lebanon",
              "value": "LB"
            },
            {
              "name": "Lesotho",
              "value": "LS"
            },
            {
              "name": "Liberia",
              "value": "LR"
            },
            {
              "name": "Libya",
              "value": "LY"
            },
            {
              "name": "Liechtenstein",
              "value": "LI"
            },
            {
              "name": "Lithuania",
              "value": "LT"
            },
            {
              "name": "Luxembourg",
              "value": "LU"
            },
            {
              "name": "Macao",
              "value": "MO"
            },
            {
              "name": "Macedonia (the former Yugoslav Republic of)",
              "value": "MK"
            },
            {
              "name": "Madagascar",
              "value": "MG"
            },
            {
              "name": "Malawi",
              "value": "MW"
            },
            {
              "name": "Malaysia",
              "value": "MY"
            },
            {
              "name": "Maldives",
              "value": "MV"
            },
            {
              "name": "Mali",
              "value": "ML"
            },
            {
              "name": "Malta",
              "value": "MT"
            },
            {
              "name": "Marshall Islands (the)",
              "value": "MH"
            },
            {
              "name": "Martinique",
              "value": "MQ"
            },
            {
              "name": "Mauritania",
              "value": "MR"
            },
            {
              "name": "Mauritius",
              "value": "MU"
            },
            {
              "name": "Mayotte",
              "value": "YT"
            },
            {
              "name": "Mexico",
              "value": "MX"
            },
            {
              "name": "Micronesia (Federated States of)",
              "value": "FM"
            },
            {
              "name": "Moldova (the Republic of)",
              "value": "MD"
            },
            {
              "name": "Monaco",
              "value": "MC"
            },
            {
              "name": "Mongolia",
              "value": "MN"
            },
            {
              "name": "Montenegro",
              "value": "ME"
            },
            {
              "name": "Montserrat",
              "value": "MS"
            },
            {
              "name": "Morocco",
              "value": "MA"
            },
            {
              "name": "Mozambique",
              "value": "MZ"
            },
            {
              "name": "Myanmar",
              "value": "MM"
            },
            {
              "name": "Namibia",
              "value": "NA"
            },
            {
              "name": "Nauru",
              "value": "NR"
            },
            {
              "name": "Nepal",
              "value": "NP"
            },
            {
              "name": "Netherlands (the)",
              "value": "NL"
            },
            {
              "name": "New Caledonia",
              "value": "NC"
            },
            {
              "name": "New Zealand",
              "value": "NZ"
            },
            {
              "name": "Nicaragua",
              "value": "NI"
            },
            {
              "name": "Niger (the)",
              "value": "NE"
            },
            {
              "name": "Nigeria",
              "value": "NG"
            },
            {
              "name": "Niue",
              "value": "NU"
            },
            {
              "name": "Norfolk Island",
              "value": "NF"
            },
            {
              "name": "Northern Mariana Islands (the)",
              "value": "MP"
            },
            {
              "name": "Norway",
              "value": "NO"
            },
            {
              "name": "Oman",
              "value": "OM"
            },
            {
              "name": "Pakistan",
              "value": "PK"
            },
            {
              "name": "Palau",
              "value": "PW"
            },
            {
              "name": "Palestine, State of",
              "value": "PS"
            },
            {
              "name": "Panama",
              "value": "PA"
            },
            {
              "name": "Papua New Guinea",
              "value": "PG"
            },
            {
              "name": "Paraguay",
              "value": "PY"
            },
            {
              "name": "Peru",
              "value": "PE"
            },
            {
              "name": "Philippines (the)",
              "value": "PH"
            },
            {
              "name": "Pitcairn",
              "value": "PN"
            },
            {
              "name": "Poland",
              "value": "PL"
            },
            {
              "name": "Portugal",
              "value": "PT"
            },
            {
              "name": "Puerto Rico",
              "value": "PR"
            },
            {
              "name": "Qatar",
              "value": "QA"
            },
            {
              "name": "Réunion",
              "value": "RE"
            },
            {
              "name": "Romania",
              "value": "RO"
            },
            {
              "name": "Russian Federation (the)",
              "value": "RU"
            },
            {
              "name": "Rwanda",
              "value": "RW"
            },
            {
              "name": "Saint Barthélemy",
              "value": "BL"
            },
            {
              "name": "Saint Helena, Ascension and Tristan da Cunha",
              "value": "SH"
            },
            {
              "name": "Saint Kitts and Nevis",
              "value": "KN"
            },
            {
              "name": "Saint Lucia",
              "value": "LC"
            },
            {
              "name": "Saint Martin (French part)",
              "value": "MF"
            },
            {
              "name": "Saint Pierre and Miquelon",
              "value": "PM"
            },
            {
              "name": "Saint Vincent and the Grenadines",
              "value": "VC"
            },
            {
              "name": "Samoa",
              "value": "WS"
            },
            {
              "name": "San Marino",
              "value": "SM"
            },
            {
              "name": "Sao Tome and Principe",
              "value": "ST"
            },
            {
              "name": "Saudi Arabia",
              "value": "SA"
            },
            {
              "name": "Senegal",
              "value": "SN"
            },
            {
              "name": "Serbia",
              "value": "RS"
            },
            {
              "name": "Seychelles",
              "value": "SC"
            },
            {
              "name": "Sierra Leone",
              "value": "SL"
            },
            {
              "name": "Singapore",
              "value": "SG"
            },
            {
              "name": "Sint Maarten (Dutch part)",
              "value": "SX"
            },
            {
              "name": "Slovakia",
              "value": "SK"
            },
            {
              "name": "Slovenia",
              "value": "SI"
            },
            {
              "name": "Solomon Islands",
              "value": "SB"
            },
            {
              "name": "Somalia",
              "value": "SO"
            },
            {
              "name": "South Africa",
              "value": "ZA"
            },
            {
              "name": "South Georgia and the South Sandwich Islands",
              "value": "GS"
            },
            {
              "name": "South Sudan",
              "value": "SS"
            },
            {
              "name": "Spain",
              "value": "ES"
            },
            {
              "name": "Sri Lanka",
              "value": "LK"
            },
            {
              "name": "Sudan (the)",
              "value": "SD"
            },
            {
              "name": "Suriname",
              "value": "SR"
            },
            {
              "name": "Svalbard and Jan Mayen",
              "value": "SJ"
            },
            {
              "name": "Swaziland",
              "value": "SZ"
            },
            {
              "name": "Sweden",
              "value": "SE"
            },
            {
              "name": "Switzerland",
              "value": "CH"
            },
            {
              "name": "Syrian Arab Republic",
              "value": "SY"
            },
            {
              "name": "Taiwan (Province of China)",
              "value": "TW"
            },
            {
              "name": "Tajikistan",
              "value": "TJ"
            },
            {
              "name": "Tanzania, United Republic of",
              "value": "TZ"
            },
            {
              "name": "Thailand",
              "value": "TH"
            },
            {
              "name": "Timor-Leste",
              "value": "TL"
            },
            {
              "name": "Togo",
              "value": "TG"
            },
            {
              "name": "Tokelau",
              "value": "TK"
            },
            {
              "name": "Tonga",
              "value": "TO"
            },
            {
              "name": "Trinidad and Tobago",
              "value": "TT"
            },
            {
              "name": "Tunisia",
              "value": "TN"
            },
            {
              "name": "Turkey",
              "value": "TR"
            },
            {
              "name": "Turkmenistan",
              "value": "TM"
            },
            {
              "name": "Turks and Caicos Islands (the)",
              "value": "TC"
            },
            {
              "name": "Tuvalu",
              "value": "TV"
            },
            {
              "name": "Uganda",
              "value": "UG"
            },
            {
              "name": "Ukraine",
              "value": "UA"
            },
            {
              "name": "United Arab Emirates (the)",
              "value": "AE"
            },
            {
              "name": "United Kingdom of Great Britain and Northern Ireland (the)",
              "value": "GB"
            },
            {
              "name": "United States Minor Outlying Islands (the)",
              "value": "UM"
            },
            {
              "name": "United States of America (the)",
              "value": "US"
            },
            {
              "name": "Uruguay",
              "value": "UY"
            },
            {
              "name": "Uzbekistan",
              "value": "UZ"
            },
            {
              "name": "Vanuatu",
              "value": "VU"
            },
            {
              "name": "Venezuela (Bolivarian Republic of)",
              "value": "VE"
            },
            {
              "name": "Viet Nam",
              "value": "VN"
            },
            {
              "name": "Virgin Islands (British)",
              "value": "VG"
            },
            {
              "name": "Virgin Islands (U.S.)",
              "value": "VI"
            },
            {
              "name": "Wallis and Futuna",
              "value": "WF"
            },
            {
              "name": "Western Sahara*",
              "value": "EH"
            },
            {
              "name": "Yemen",
              "value": "YE"
            },
            {
              "name": "Zambia",
              "value": "ZM"
            },
            {
              "name": "Zimbabwe",
              "value": "ZW"
            }
          ],
          "default": "",
          "description": "Country of the company to filter by"
        },
        {
          "displayName": "Name",
          "name": "name",
          "type": "string",
          "default": "",
          "description": "Name of the company to filter by"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "company"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Company ID",
      "name": "companyId",
      "type": "string",
      "default": "",
      "description": "ID of the company to update",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "company"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Update Fields",
      "name": "updateFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Address",
          "name": "address",
          "placeholder": "Add Address Fields",
          "type": "fixedCollection",
          "default": {},
          "options": [
            {
              "displayName": "Address Fields",
              "name": "addressFields",
              "values": [
                {
                  "displayName": "Street",
                  "name": "street",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "City",
                  "name": "city",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "State",
                  "name": "state",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Postal Code",
                  "name": "postal_code",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Country",
                  "name": "country",
                  "type": "string",
                  "default": "",
                  "description": "ISO 3166 alpha-2 country code"
                }
              ]
            }
          ]
        },
        {
          "displayName": "Details",
          "name": "details",
          "type": "string",
          "default": "",
          "description": "Description to set for the company"
        },
        {
          "displayName": "Name",
          "name": "name",
          "type": "string",
          "default": "",
          "description": "Name to set for the company"
        },
        {
          "displayName": "Phone Numbers",
          "name": "phone_numbers",
          "placeholder": "Add Phone Number",
          "type": "fixedCollection",
          "typeOptions": {
            "multipleValues": true
          },
          "default": {},
          "options": [
            {
              "displayName": "Phone Fields",
              "name": "phoneFields",
              "values": [
                {
                  "displayName": "Number",
                  "name": "number",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Category",
                  "name": "category",
                  "type": "string",
                  "default": ""
                }
              ]
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "company"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "getAll",
      "options": [
        {
          "name": "Get Many",
          "value": "getAll",
          "action": "Get many customer sources"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "customerSource"
          ]
        }
      },
      "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": [
            "customerSource"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 5,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "customerSource"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 1000
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "action": "Create a lead"
        },
        {
          "name": "Delete",
          "value": "delete",
          "action": "Delete a lead"
        },
        {
          "name": "Get",
          "value": "get",
          "action": "Get a lead"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "action": "Get many leads"
        },
        {
          "name": "Update",
          "value": "update",
          "action": "Update a lead"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "lead"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Name",
      "name": "name",
      "type": "string",
      "default": "",
      "description": "Name of the lead to create",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "lead"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Address",
          "name": "address",
          "placeholder": "Add Address Fields",
          "type": "fixedCollection",
          "default": {},
          "options": [
            {
              "displayName": "Address Fields",
              "name": "addressFields",
              "values": [
                {
                  "displayName": "Street",
                  "name": "street",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "City",
                  "name": "city",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "State",
                  "name": "state",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Postal Code",
                  "name": "postal_code",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Country",
                  "name": "country",
                  "type": "string",
                  "default": "",
                  "description": "ISO 3166 alpha-2 country code"
                }
              ]
            }
          ]
        },
        {
          "displayName": "Email",
          "name": "email",
          "placeholder": "Add Email",
          "type": "fixedCollection",
          "default": {},
          "options": [
            {
              "displayName": "Email Fields",
              "name": "emailFields",
              "values": [
                {
                  "displayName": "Email",
                  "name": "email",
                  "type": "string",
                  "placeholder": "name@email.com",
                  "default": ""
                },
                {
                  "displayName": "Category",
                  "name": "category",
                  "type": "string",
                  "default": ""
                }
              ]
            }
          ]
        },
        {
          "displayName": "Phone Numbers",
          "name": "phone_numbers",
          "placeholder": "Add Phone Number",
          "type": "fixedCollection",
          "typeOptions": {
            "multipleValues": true
          },
          "default": {},
          "options": [
            {
              "displayName": "Phone Fields",
              "name": "phoneFields",
              "values": [
                {
                  "displayName": "Number",
                  "name": "number",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Category",
                  "name": "category",
                  "type": "string",
                  "default": ""
                }
              ]
            }
          ]
        }
      ],
      "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": "Return All",
      "name": "returnAll",
      "type": "boolean",
      "default": false,
      "description": "Whether to return all results or only up to a given limit",
      "displayOptions": {
        "show": {
          "resource": [
            "lead"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 5,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "lead"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 1000
      }
    },
    {
      "displayName": "Filters",
      "name": "filterFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Country",
          "name": "country",
          "type": "string",
          "default": "",
          "description": "Name of the country to filter by"
        },
        {
          "displayName": "Name",
          "name": "name",
          "type": "string",
          "default": "",
          "description": "Name of the lead to filter by"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "lead"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "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": "Address",
          "name": "address",
          "placeholder": "Add Address Fields",
          "type": "fixedCollection",
          "default": {},
          "options": [
            {
              "displayName": "Address Fields",
              "name": "addressFields",
              "values": [
                {
                  "displayName": "Street",
                  "name": "street",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "City",
                  "name": "city",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "State",
                  "name": "state",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Postal Code",
                  "name": "postal_code",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Country",
                  "name": "country",
                  "type": "string",
                  "default": "",
                  "description": "ISO 3166 alpha-2 country code"
                }
              ]
            }
          ]
        },
        {
          "displayName": "Details",
          "name": "details",
          "type": "string",
          "default": "",
          "description": "Description to set for the lead"
        },
        {
          "displayName": "Email",
          "name": "email",
          "placeholder": "Add Email",
          "type": "fixedCollection",
          "default": {},
          "options": [
            {
              "displayName": "Email Fields",
              "name": "emailFields",
              "values": [
                {
                  "displayName": "Email",
                  "name": "email",
                  "type": "string",
                  "placeholder": "name@email.com",
                  "default": ""
                },
                {
                  "displayName": "Category",
                  "name": "category",
                  "type": "string",
                  "default": ""
                }
              ]
            }
          ]
        },
        {
          "displayName": "Name",
          "name": "name",
          "type": "string",
          "default": "",
          "description": "Name to set for the lead"
        },
        {
          "displayName": "Phone Numbers",
          "name": "phone_numbers",
          "placeholder": "Add Phone Number",
          "type": "fixedCollection",
          "typeOptions": {
            "multipleValues": true
          },
          "default": {},
          "options": [
            {
              "displayName": "Phone Fields",
              "name": "phoneFields",
              "values": [
                {
                  "displayName": "Number",
                  "name": "number",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Category",
                  "name": "category",
                  "type": "string",
                  "default": ""
                }
              ]
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "lead"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "action": "Create an opportunity"
        },
        {
          "name": "Delete",
          "value": "delete",
          "action": "Delete an opportunity"
        },
        {
          "name": "Get",
          "value": "get",
          "action": "Get an opportunity"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "action": "Get many opportunities"
        },
        {
          "name": "Update",
          "value": "update",
          "action": "Update an opportunity"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "opportunity"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Name",
      "name": "name",
      "type": "string",
      "default": "",
      "description": "Name of the opportunity to create",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "opportunity"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Customer Source ID",
      "name": "customerSourceId",
      "type": "string",
      "default": "",
      "description": "ID of the customer source that generated this opportunity",
      "displayOptions": {
        "show": {
          "resource": [
            "opportunity"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Primary Contact ID",
      "name": "primaryContactId",
      "type": "string",
      "default": "",
      "description": "ID of the primary company associated with this opportunity",
      "displayOptions": {
        "show": {
          "resource": [
            "opportunity"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Opportunity ID",
      "name": "opportunityId",
      "type": "string",
      "default": "",
      "description": "ID of the opportunity to delete",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "opportunity"
          ],
          "operation": [
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "Opportunity ID",
      "name": "opportunityId",
      "type": "string",
      "default": "",
      "description": "ID of the opportunity to retrieve",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "opportunity"
          ],
          "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": [
            "opportunity"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 5,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "opportunity"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 1000
      }
    },
    {
      "displayName": "Filters",
      "name": "filterFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Company IDs",
          "name": "company_ids",
          "type": "string",
          "default": "",
          "description": "Comma-separated IDs of the primary companies to filter by"
        },
        {
          "displayName": "Customer Source IDs",
          "name": "customer_source_ids",
          "type": "string",
          "default": "",
          "description": "Comma-separated IDs of the customer sources to filter by"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "opportunity"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Opportunity ID",
      "name": "opportunityId",
      "type": "string",
      "default": "",
      "description": "ID of the opportunity to update",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "opportunity"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Update Fields",
      "name": "updateFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Customer Source ID",
          "name": "customer_source_id",
          "type": "string",
          "default": "",
          "description": "ID of the primary company associated with this opportunity"
        },
        {
          "displayName": "Name",
          "name": "name",
          "type": "string",
          "default": "",
          "description": "Name to set for the opportunity"
        },
        {
          "displayName": "Primary Contact ID",
          "name": "primary_contact_id",
          "type": "string",
          "default": "",
          "description": "ID of the customer source that generated this opportunity"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "opportunity"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "action": "Create a person"
        },
        {
          "name": "Delete",
          "value": "delete",
          "action": "Delete a person"
        },
        {
          "name": "Get",
          "value": "get",
          "action": "Get a person"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "action": "Get many people"
        },
        {
          "name": "Update",
          "value": "update",
          "action": "Update a person"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "person"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Name",
      "name": "name",
      "type": "string",
      "default": "",
      "description": "Name of the person to create",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "person"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Address",
          "name": "address",
          "placeholder": "Add Address Fields",
          "type": "fixedCollection",
          "default": {},
          "options": [
            {
              "displayName": "Address Fields",
              "name": "addressFields",
              "values": [
                {
                  "displayName": "Street",
                  "name": "street",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "City",
                  "name": "city",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "State",
                  "name": "state",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Postal Code",
                  "name": "postal_code",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Country",
                  "name": "country",
                  "type": "string",
                  "default": "",
                  "description": "ISO 3166 alpha-2 country code"
                }
              ]
            }
          ]
        },
        {
          "displayName": "Details",
          "name": "details",
          "type": "string",
          "default": "",
          "description": "Description to set for the person"
        },
        {
          "displayName": "Email Domain",
          "name": "email_domain",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Emails",
          "name": "emails",
          "placeholder": "Add Email",
          "type": "fixedCollection",
          "typeOptions": {
            "multipleValues": true
          },
          "default": {},
          "options": [
            {
              "displayName": "Email Fields",
              "name": "emailFields",
              "values": [
                {
                  "displayName": "Email",
                  "name": "email",
                  "type": "string",
                  "placeholder": "name@email.com",
                  "default": ""
                },
                {
                  "displayName": "Category",
                  "name": "category",
                  "type": "string",
                  "default": ""
                }
              ]
            }
          ]
        },
        {
          "displayName": "Phone Numbers",
          "name": "phone_numbers",
          "placeholder": "Add Phone Number",
          "type": "fixedCollection",
          "typeOptions": {
            "multipleValues": true
          },
          "default": {},
          "options": [
            {
              "displayName": "Phone Fields",
              "name": "phoneFields",
              "values": [
                {
                  "displayName": "Number",
                  "name": "number",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Category",
                  "name": "category",
                  "type": "string",
                  "default": ""
                }
              ]
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "person"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Person ID",
      "name": "personId",
      "type": "string",
      "default": "",
      "description": "ID of the person to delete",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "person"
          ],
          "operation": [
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "Person ID",
      "name": "personId",
      "type": "string",
      "default": "",
      "description": "ID of the person to retrieve",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "person"
          ],
          "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": [
            "person"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 5,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "person"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 1000
      }
    },
    {
      "displayName": "Filters",
      "name": "filterFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Name",
          "name": "name",
          "type": "string",
          "default": "",
          "description": "Name of the person to filter by"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "person"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Person ID",
      "name": "personId",
      "type": "string",
      "default": "",
      "description": "ID of the person to update",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "person"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Update Fields",
      "name": "updateFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Address",
          "name": "address",
          "placeholder": "Add Address Fields",
          "type": "fixedCollection",
          "default": {},
          "options": [
            {
              "displayName": "Address Fields",
              "name": "addressFields",
              "values": [
                {
                  "displayName": "Street",
                  "name": "street",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "City",
                  "name": "city",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "State",
                  "name": "state",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Postal Code",
                  "name": "postal_code",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Country",
                  "name": "country",
                  "type": "string",
                  "default": "",
                  "description": "ISO 3166 alpha-2 country code"
                }
              ]
            }
          ]
        },
        {
          "displayName": "Details",
          "name": "details",
          "type": "string",
          "default": "",
          "description": "Description to set for the person"
        },
        {
          "displayName": "Email Domain",
          "name": "email_domain",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Emails",
          "name": "emails",
          "placeholder": "Add Email",
          "type": "fixedCollection",
          "typeOptions": {
            "multipleValues": true
          },
          "default": {},
          "options": [
            {
              "displayName": "Email Fields",
              "name": "emailFields",
              "values": [
                {
                  "displayName": "Email",
                  "name": "email",
                  "type": "string",
                  "placeholder": "name@email.com",
                  "default": ""
                },
                {
                  "displayName": "Category",
                  "name": "category",
                  "type": "string",
                  "default": ""
                }
              ]
            }
          ]
        },
        {
          "displayName": "Name",
          "name": "name",
          "type": "string",
          "default": "",
          "description": "Name to set for the person"
        },
        {
          "displayName": "Phone Numbers",
          "name": "phone_numbers",
          "placeholder": "Add Phone Number",
          "type": "fixedCollection",
          "typeOptions": {
            "multipleValues": true
          },
          "default": {},
          "options": [
            {
              "displayName": "Phone Fields",
              "name": "phoneFields",
              "values": [
                {
                  "displayName": "Number",
                  "name": "number",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Category",
                  "name": "category",
                  "type": "string",
                  "default": ""
                }
              ]
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "person"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "action": "Create a project"
        },
        {
          "name": "Delete",
          "value": "delete",
          "action": "Delete a project"
        },
        {
          "name": "Get",
          "value": "get",
          "action": "Get a project"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "action": "Get many projects"
        },
        {
          "name": "Update",
          "value": "update",
          "action": "Update a project"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "project"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Name",
      "name": "name",
      "type": "string",
      "default": "",
      "description": "Name of the project to create",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "project"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Assignee ID",
          "name": "assignee_id",
          "type": "string",
          "default": "",
          "description": "ID of the user who will own the project to create"
        },
        {
          "displayName": "Details",
          "name": "details",
          "type": "string",
          "default": "",
          "description": "Description of the project to create"
        },
        {
          "displayName": "Status",
          "name": "status",
          "type": "options",
          "default": "Open",
          "options": [
            {
              "name": "Completed",
              "value": "Completed"
            },
            {
              "name": "Open",
              "value": "Open"
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "project"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Project ID",
      "name": "projectId",
      "type": "string",
      "default": "",
      "description": "ID of the project to delete",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "project"
          ],
          "operation": [
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "Project ID",
      "name": "projectId",
      "type": "string",
      "default": "",
      "description": "ID of the project to retrieve",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "project"
          ],
          "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": [
            "project"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 5,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "project"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 1000
      }
    },
    {
      "displayName": "Filters",
      "name": "filterFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Name",
          "name": "name",
          "type": "string",
          "default": "",
          "description": "Name of the project to filter by"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "project"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Project ID",
      "name": "projectId",
      "type": "string",
      "default": "",
      "description": "ID of the project to update",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "project"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Update Fields",
      "name": "updateFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Assignee ID",
          "name": "assignee_id",
          "type": "string",
          "default": "",
          "description": "ID of the user who will own the project"
        },
        {
          "displayName": "Details",
          "name": "details",
          "type": "string",
          "default": "",
          "description": "Description to set for the project"
        },
        {
          "displayName": "Name",
          "name": "name",
          "type": "string",
          "default": "",
          "description": "Name to set for the project"
        },
        {
          "displayName": "Status",
          "name": "status",
          "type": "options",
          "default": "Open",
          "options": [
            {
              "name": "Completed",
              "value": "Completed"
            },
            {
              "name": "Open",
              "value": "Open"
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "project"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "action": "Create a task"
        },
        {
          "name": "Delete",
          "value": "delete",
          "action": "Delete a task"
        },
        {
          "name": "Get",
          "value": "get",
          "action": "Get a task"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "action": "Get many tasks"
        },
        {
          "name": "Update",
          "value": "update",
          "action": "Update a task"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "task"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Name",
      "name": "name",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "task"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Assignee ID",
          "name": "assignee_id",
          "type": "string",
          "default": "",
          "description": "ID of the user who will own the task to create"
        },
        {
          "displayName": "Details",
          "name": "details",
          "type": "string",
          "default": "",
          "description": "Description of the task to create"
        },
        {
          "displayName": "Priority",
          "name": "priority",
          "type": "options",
          "default": "High",
          "options": [
            {
              "name": "High",
              "value": "High"
            },
            {
              "name": "None",
              "value": "None"
            }
          ]
        },
        {
          "displayName": "Status",
          "name": "status",
          "type": "options",
          "default": "Open",
          "options": [
            {
              "name": "Completed",
              "value": "Completed"
            },
            {
              "name": "Open",
              "value": "Open"
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "task"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Task ID",
      "name": "taskId",
      "type": "string",
      "default": "",
      "description": "ID of the task to delete",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "task"
          ],
          "operation": [
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "Task ID",
      "name": "taskId",
      "type": "string",
      "default": "",
      "description": "ID of the task to retrieve",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "task"
          ],
          "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": [
            "task"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 5,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "task"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 1000
      }
    },
    {
      "displayName": "Filters",
      "name": "filterFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Assignee IDs",
          "name": "assignee_ids",
          "type": "string",
          "default": "",
          "description": "Comma-separated IDs of assignee IDs to filter by"
        },
        {
          "displayName": "Project IDs",
          "name": "project_ids",
          "type": "string",
          "default": "",
          "description": "Comma-separated IDs of project IDs to filter by"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "task"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Task ID",
      "name": "taskId",
      "type": "string",
      "default": "",
      "description": "ID of the task to update",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "task"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Update Fields",
      "name": "updateFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Assignee ID",
          "name": "assignee_id",
          "type": "string",
          "default": "",
          "description": "ID of the user who will own the task"
        },
        {
          "displayName": "Details",
          "name": "details",
          "type": "string",
          "default": "",
          "description": "Description to set for the task"
        },
        {
          "displayName": "Name",
          "name": "name",
          "type": "string",
          "default": "",
          "description": "Name to set for the task"
        },
        {
          "displayName": "Priority",
          "name": "priority",
          "type": "options",
          "default": "High",
          "options": [
            {
              "name": "High",
              "value": "High"
            },
            {
              "name": "None",
              "value": "None"
            }
          ]
        },
        {
          "displayName": "Status",
          "name": "status",
          "type": "options",
          "default": "Open",
          "options": [
            {
              "name": "Completed",
              "value": "Completed"
            },
            {
              "name": "Open",
              "value": "Open"
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "task"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "getAll",
      "options": [
        {
          "name": "Get Many",
          "value": "getAll",
          "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": 5,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "user"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 1000
      }
    }
  ]

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


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

outputs:
  [
  "main"
  ]

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

  # Copper Trigger node

  [Copper](https://www.copper.com/){:target=_blank .external-link} is a CRM that focuses on strong integration with Google Workspace. It's mainly targeted towards small and medium-sized businesses.

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

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

properties_schema:
  [
    {
      "displayName": "Resource",
      "name": "resource",
      "type": "options",
      "default": "",
      "description": "The resource which will fire the event",
      "options": [
        {
          "name": "Company",
          "value": "company"
        },
        {
          "name": "Lead",
          "value": "lead"
        },
        {
          "name": "Opportunity",
          "value": "opportunity"
        },
        {
          "name": "Person",
          "value": "person"
        },
        {
          "name": "Project",
          "value": "project"
        },
        {
          "name": "Task",
          "value": "task"
        }
      ],
      "required": true,
      "noDataExpression": true
    },
    {
      "displayName": "Event",
      "name": "event",
      "type": "options",
      "default": "",
      "description": "The event to listen to",
      "options": [
        {
          "name": "Delete",
          "value": "delete",
          "description": "An existing record is removed"
        },
        {
          "name": "New",
          "value": "new",
          "description": "A new record is created"
        },
        {
          "name": "Update",
          "value": "update",
          "description": "Any field in the existing entity record is changed"
        }
      ],
      "required": true
    }
  ]


node_type: nodes-base.cortex
package_name: n8n-nodes-base
display_name: Cortex
description: Apply the Cortex analyzer/responder on the given entity
category: transform
development_style: programmatic
version: 1
credentials_required:
  [
  {
  "name": "cortexApi",
  "required": true
  }
  ]

outputs:
  [
  "main"
  ]

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

  # Cortex node

  Use the Cortex node to automate work in Cortex, and integrate Cortex with other applications. n8n has built-in support for a wide range of Cortex features, including executing analyzers, and responders, as well as getting job details.

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

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

  ## Operations

  * Analyzer
      * Execute Analyzer
  * Job
      * Get job details
      * Get job report
  * Responder
      * Execute Responder

  ## Templates and examples

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

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

properties_schema:
  [
    {
      "displayName": "Resource",
      "name": "resource",
      "type": "options",
      "default": "analyzer",
      "description": "Choose a resource",
      "options": [
        {
          "name": "Analyzer",
          "value": "analyzer"
        },
        {
          "name": "Job",
          "value": "job"
        },
        {
          "name": "Responder",
          "value": "responder"
        }
      ],
      "required": true,
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "execute",
      "description": "Choose an operation",
      "options": [
        {
          "name": "Execute",
          "value": "execute",
          "description": "Execute Analyzer",
          "action": "Execute an analyzer"
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "analyzer"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Analyzer Type Name or ID",
      "name": "analyzer",
      "type": "options",
      "default": "",
      "description": "Choose the analyzer. 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": [
            "analyzer"
          ],
          "operation": [
            "execute"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "loadActiveAnalyzers"
      }
    },
    {
      "displayName": "Observable Type Name or ID",
      "name": "observableType",
      "type": "options",
      "default": "",
      "description": "Choose the observable type. 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": [
            "analyzer"
          ],
          "operation": [
            "execute"
          ]
        },
        "hide": {
          "analyzer": [
            ""
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "loadObservableOptions",
        "loadOptionsDependsOn": [
          "analyzer"
        ]
      }
    },
    {
      "displayName": "Observable Value",
      "name": "observableValue",
      "type": "string",
      "default": "",
      "description": "Enter the observable value",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "analyzer"
          ],
          "operation": [
            "execute"
          ]
        },
        "hide": {
          "observableType": [
            "file"
          ],
          "analyzer": [
            ""
          ]
        }
      }
    },
    {
      "displayName": "Put Output File in Field",
      "name": "binaryPropertyName",
      "type": "string",
      "default": "data",
      "required": true,
      "displayOptions": {
        "show": {
          "observableType": [
            "file"
          ],
          "resource": [
            "analyzer"
          ],
          "operation": [
            "execute"
          ]
        }
      }
    },
    {
      "displayName": "TLP",
      "name": "tlp",
      "type": "options",
      "default": 2,
      "description": "The TLP of the analyzed observable",
      "options": [
        {
          "name": "White",
          "value": 0
        },
        {
          "name": "Green",
          "value": 1
        },
        {
          "name": "Amber",
          "value": 2
        },
        {
          "name": "Red",
          "value": 3
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "analyzer"
          ],
          "operation": [
            "execute"
          ]
        },
        "hide": {
          "observableType": [
            ""
          ],
          "analyzer": [
            ""
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Force",
          "name": "force",
          "type": "boolean",
          "default": false,
          "description": "Whether to force bypassing the cache"
        },
        {
          "displayName": "Timeout (Seconds)",
          "name": "timeout",
          "type": "number",
          "default": 3,
          "description": "Timeout to wait for the report in case it is not available at the time the query was made"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "analyzer"
          ],
          "operation": [
            "execute"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "execute",
      "description": "Choose an operation",
      "options": [
        {
          "name": "Execute",
          "value": "execute",
          "description": "Execute Responder",
          "action": "Execute a responder"
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "responder"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Responder Type Name or ID",
      "name": "responder",
      "type": "options",
      "default": "",
      "description": "Choose the responder. 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": [
            "responder"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "loadActiveResponders"
      }
    },
    {
      "displayName": "Entity Type Name or ID",
      "name": "entityType",
      "type": "options",
      "default": "",
      "description": "Choose the Data type. 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": [
            "responder"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "loadDataTypeOptions",
        "loadOptionsDependsOn": [
          "responder"
        ]
      }
    },
    {
      "displayName": "JSON Parameters",
      "name": "jsonObject",
      "type": "boolean",
      "default": false,
      "description": "Choose between providing JSON object or seperated attributes",
      "displayOptions": {
        "show": {
          "resource": [
            "responder"
          ]
        }
      }
    },
    {
      "displayName": "Entity Object (JSON)",
      "name": "objectData",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "responder"
          ],
          "jsonObject": [
            true
          ]
        }
      }
    },
    {
      "displayName": "Parameters",
      "name": "parameters",
      "type": "fixedCollection",
      "default": {},
      "options": [
        {
          "displayName": "Case Attributes",
          "name": "values",
          "values": [
            {
              "displayName": "Description",
              "name": "description",
              "type": "string",
              "default": "",
              "description": "Description of the case"
            },
            {
              "displayName": "Flag",
              "name": "flag",
              "type": "boolean",
              "default": false,
              "description": "Flag of the case default=false"
            },
            {
              "displayName": "Owner",
              "name": "owner",
              "type": "string",
              "default": "",
              "description": "User who owns the case. This is automatically set to current user when status is set to InProgress."
            },
            {
              "displayName": "Severity",
              "name": "severity",
              "type": "options",
              "default": 2,
              "options": [
                {
                  "name": "Low",
                  "value": 1
                },
                {
                  "name": "Medium",
                  "value": 2
                },
                {
                  "name": "High",
                  "value": 3
                }
              ],
              "description": "Severity of the case. Default=Medium."
            },
            {
              "displayName": "Start Date",
              "name": "startDate",
              "type": "dateTime",
              "default": "",
              "description": "Date and time of the begin of the case default=now"
            },
            {
              "displayName": "Tags",
              "name": "tags",
              "type": "string",
              "default": "",
              "placeholder": "tag1,tag2,..."
            },
            {
              "displayName": "Title",
              "name": "title",
              "type": "string",
              "default": "",
              "description": "Title of the case"
            },
            {
              "displayName": "TLP",
              "name": "tlp",
              "type": "options",
              "default": 2,
              "options": [
                {
                  "name": "White",
                  "value": 0
                },
                {
                  "name": "Green",
                  "value": 1
                },
                {
                  "name": "Amber",
                  "value": 2
                },
                {
                  "name": "Red",
                  "value": 3
                }
              ],
              "description": "Traffic Light Protocol (TLP). Default=Amber."
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "responder"
          ],
          "jsonObject": [
            false
          ],
          "entityType": [
            "case"
          ]
        },
        "hide": {
          "entityType": [
            "",
            "alert",
            "case_artifact",
            "case_task",
            "case_task_log"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsDependsOn": [
          "entityType"
        ]
      }
    },
    {
      "displayName": "Parameters",
      "name": "parameters",
      "type": "fixedCollection",
      "default": {},
      "options": [
        {
          "displayName": "Alert Attributes",
          "name": "values",
          "values": [
            {
              "displayName": "Artifacts",
              "name": "artifacts",
              "type": "fixedCollection",
              "placeholder": "Add an artifact",
              "typeOptions": {
                "multipleValues": true,
                "multipleValueButtonText": "Add an Artifact"
              },
              "default": [],
              "options": [
                {
                  "displayName": "Artifact",
                  "name": "artifactValues",
                  "values": [
                    {
                      "displayName": "Binary Field",
                      "name": "binaryProperty",
                      "type": "string",
                      "displayOptions": {
                        "show": {
                          "dataType": [
                            "file"
                          ]
                        }
                      },
                      "default": "data"
                    },
                    {
                      "displayName": "Data",
                      "name": "data",
                      "type": "string",
                      "displayOptions": {
                        "hide": {
                          "dataType": [
                            "file"
                          ]
                        }
                      },
                      "default": ""
                    },
                    {
                      "displayName": "Data Type",
                      "name": "dataType",
                      "type": "options",
                      "default": "",
                      "options": [
                        {
                          "name": "Domain",
                          "value": "domain"
                        },
                        {
                          "name": "File",
                          "value": "file"
                        },
                        {
                          "name": "Filename",
                          "value": "filename"
                        },
                        {
                          "name": "Fqdn",
                          "value": "fqdn"
                        },
                        {
                          "name": "Hash",
                          "value": "hash"
                        },
                        {
                          "name": "IP",
                          "value": "ip"
                        },
                        {
                          "name": "Mail",
                          "value": "mail"
                        },
                        {
                          "name": "Mail Subject",
                          "value": "mail_subject"
                        },
                        {
                          "name": "Other",
                          "value": "other"
                        },
                        {
                          "name": "Regexp",
                          "value": "regexp"
                        },
                        {
                          "name": "Registry",
                          "value": "registry"
                        },
                        {
                          "name": "Uri Path",
                          "value": "uri_path"
                        },
                        {
                          "name": "URL",
                          "value": "url"
                        },
                        {
                          "name": "User Agent",
                          "value": "user-agent"
                        }
                      ]
                    },
                    {
                      "displayName": "Message",
                      "name": "message",
                      "type": "string",
                      "default": ""
                    },
                    {
                      "displayName": "Tags",
                      "name": "tags",
                      "type": "string",
                      "default": ""
                    }
                  ]
                }
              ]
            },
            {
              "displayName": "Date",
              "name": "date",
              "type": "dateTime",
              "default": "",
              "description": "Date and time when the alert was raised default=now"
            },
            {
              "displayName": "Description",
              "name": "description",
              "type": "string",
              "default": "",
              "description": "Description of the alert"
            },
            {
              "displayName": "Follow",
              "name": "follow",
              "type": "boolean",
              "default": false
            },
            {
              "displayName": "Severity",
              "name": "severity",
              "type": "options",
              "default": 2,
              "options": [
                {
                  "name": "Low",
                  "value": 1
                },
                {
                  "name": "Medium",
                  "value": 2
                },
                {
                  "name": "High",
                  "value": 3
                }
              ],
              "description": "Severity of the case. Default=Medium."
            },
            {
              "displayName": "Source",
              "name": "source",
              "type": "string",
              "default": "",
              "description": "Source of the alert"
            },
            {
              "displayName": "SourceRef",
              "name": "sourceRef",
              "type": "string",
              "default": "",
              "description": "Source reference of the alert"
            },
            {
              "displayName": "Status",
              "name": "status",
              "type": "options",
              "default": "New",
              "options": [
                {
                  "name": "New",
                  "value": "New"
                },
                {
                  "name": "Updated",
                  "value": "Updated"
                },
                {
                  "name": "Ignored",
                  "value": "Ignored"
                },
                {
                  "name": "Imported",
                  "value": "Imported"
                }
              ],
              "description": "Status of the alert. Default=New."
            },
            {
              "displayName": "Tags",
              "name": "tags",
              "type": "string",
              "placeholder": "tag1,tag2,...",
              "default": ""
            },
            {
              "displayName": "Title",
              "name": "title",
              "type": "string",
              "default": "",
              "description": "Title of the alert"
            },
            {
              "displayName": "TLP",
              "name": "tlp",
              "type": "options",
              "default": 2,
              "options": [
                {
                  "name": "White",
                  "value": 0
                },
                {
                  "name": "Green",
                  "value": 1
                },
                {
                  "name": "Amber",
                  "value": 2
                },
                {
                  "name": "Red",
                  "value": 3
                }
              ],
              "description": "Traffic Light Protocol (TLP). Default=Amber."
            },
            {
              "displayName": "Type",
              "name": "type",
              "type": "string",
              "default": "",
              "description": "Type of the alert"
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "responder"
          ],
          "jsonObject": [
            false
          ],
          "entityType": [
            "alert"
          ]
        },
        "hide": {
          "responder": [
            ""
          ],
          "entityType": [
            "",
            "case",
            "case_artifact",
            "case_task",
            "case_task_log"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsDependsOn": [
          "entityType"
        ]
      }
    },
    {
      "displayName": "Parameters",
      "name": "parameters",
      "type": "fixedCollection",
      "default": {},
      "options": [
        {
          "displayName": "Observable Attributes",
          "name": "values",
          "values": [
            {
              "displayName": "Input Binary Field",
              "name": "binaryPropertyName",
              "type": "string",
              "default": "data",
              "displayOptions": {
                "show": {
                  "dataType": [
                    "file"
                  ]
                }
              },
              "hint": "The name of the input binary field containing the attachement data"
            },
            {
              "displayName": "Data",
              "name": "data",
              "type": "string",
              "default": "",
              "displayOptions": {
                "hide": {
                  "dataType": [
                    "file"
                  ]
                }
              }
            },
            {
              "displayName": "DataType",
              "name": "dataType",
              "type": "options",
              "default": "",
              "options": [
                {
                  "name": "Domain",
                  "value": "domain"
                },
                {
                  "name": "File",
                  "value": "file"
                },
                {
                  "name": "Filename",
                  "value": "filename"
                },
                {
                  "name": "Fqdn",
                  "value": "fqdn"
                },
                {
                  "name": "Hash",
                  "value": "hash"
                },
                {
                  "name": "IP",
                  "value": "ip"
                },
                {
                  "name": "Mail",
                  "value": "mail"
                },
                {
                  "name": "Mail Subject",
                  "value": "mail_subject"
                },
                {
                  "name": "Other",
                  "value": "other"
                },
                {
                  "name": "Regexp",
                  "value": "regexp"
                },
                {
                  "name": "Registry",
                  "value": "registry"
                },
                {
                  "name": "Uri Path",
                  "value": "uri_path"
                },
                {
                  "name": "URL",
                  "value": "url"
                },
                {
                  "name": "User Agent",
                  "value": "user-agent"
                }
              ]
            },
            {
              "displayName": "IOC",
              "name": "ioc",
              "type": "boolean",
              "default": false,
              "description": "Whether the observable is an IOC (Indicator of compromise)"
            },
            {
              "displayName": "Message",
              "name": "message",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "Start Date",
              "name": "startDate",
              "type": "dateTime",
              "default": "",
              "description": "Date and time of the begin of the case default=now"
            },
            {
              "displayName": "Status",
              "name": "status",
              "type": "options",
              "default": "",
              "options": [
                {
                  "name": "Ok",
                  "value": "Ok"
                },
                {
                  "name": "Deleted",
                  "value": "Deleted"
                }
              ],
              "description": "Status of the observable (Ok or Deleted) default=Ok"
            },
            {
              "displayName": "TLP",
              "name": "tlp",
              "type": "options",
              "default": 2,
              "options": [
                {
                  "name": "White",
                  "value": 0
                },
                {
                  "name": "Green",
                  "value": 1
                },
                {
                  "name": "Amber",
                  "value": 2
                },
                {
                  "name": "Red",
                  "value": 3
                }
              ],
              "description": "Traffic Light Protocol (TLP). Default=Amber."
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "responder"
          ],
          "jsonObject": [
            false
          ],
          "entityType": [
            "case_artifact"
          ]
        },
        "hide": {
          "responder": [
            ""
          ],
          "entityType": [
            "",
            "case",
            "alert",
            "case_task",
            "case_task_log"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsDependsOn": [
          "entityType"
        ]
      }
    },
    {
      "displayName": "Parameters",
      "name": "parameters",
      "type": "fixedCollection",
      "default": {},
      "options": [
        {
          "displayName": "Task Attributes",
          "name": "values",
          "values": [
            {
              "displayName": "Title",
              "name": "title",
              "type": "string",
              "default": "",
              "description": "Title of the task"
            },
            {
              "displayName": "Status",
              "name": "status",
              "type": "options",
              "default": "Waiting",
              "options": [
                {
                  "name": "Waiting",
                  "value": "Waiting"
                },
                {
                  "name": "InProgress",
                  "value": "InProgress"
                },
                {
                  "name": "Completed",
                  "value": "Completed"
                },
                {
                  "name": "Cancel",
                  "value": "Cancel"
                }
              ]
            },
            {
              "displayName": "Flag",
              "name": "flag",
              "type": "boolean",
              "default": false
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "responder"
          ],
          "jsonObject": [
            false
          ],
          "entityType": [
            "case_task"
          ]
        },
        "hide": {
          "responder": [
            ""
          ],
          "entityType": [
            "",
            "case",
            "alert",
            "case_artifact",
            "case_task_log"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsDependsOn": [
          "entityType"
        ]
      }
    },
    {
      "displayName": "Parameters",
      "name": "parameters",
      "type": "fixedCollection",
      "default": {},
      "options": [
        {
          "displayName": "Log Attributes",
          "name": "values",
          "values": [
            {
              "displayName": "Message",
              "name": "message",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "Start Date",
              "name": "startDate",
              "type": "dateTime",
              "default": "",
              "description": "Date and time of the begin of the case default=now"
            },
            {
              "displayName": "Status",
              "name": "status",
              "type": "options",
              "required": true,
              "default": "",
              "options": [
                {
                  "name": "Ok",
                  "value": "Ok"
                },
                {
                  "name": "Deleted",
                  "value": "Deleted"
                }
              ]
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "responder"
          ],
          "jsonObject": [
            false
          ],
          "entityType": [
            "case_task_log"
          ]
        },
        "hide": {
          "responder": [
            ""
          ],
          "entityType": [
            "",
            "case",
            "alert",
            "case_artifact",
            "case_task"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsDependsOn": [
          "entityType"
        ]
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "get",
      "description": "Choose an operation",
      "options": [
        {
          "name": "Get",
          "value": "get",
          "description": "Get job details",
          "action": "Get a job"
        },
        {
          "name": "Report",
          "value": "report",
          "description": "Get job report",
          "action": "Get a job report"
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "job"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Job ID",
      "name": "jobId",
      "type": "string",
      "default": "",
      "description": "ID of the job",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "job"
          ],
          "operation": [
            "get",
            "report"
          ]
        }
      }
    }
  ]

operations:
  [
    {
      "operation": "execute",
      "name": "Execute",
      "description": "Execute Analyzer"
    }
  ]


node_type: nodes-base.crateDb
package_name: n8n-nodes-base
display_name: CrateDB
description: Add and update data in CrateDB
category: input
development_style: programmatic
version: 1
credentials_required:
  [
  {
  "name": "crateDb",
  "required": true
  }
  ]

outputs:
  [
  "main"
  ]

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

  # CrateDB node

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

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

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

  ## Operations

  * Execute an SQL query
  * Insert rows in database
  * Update rows in database

  ## Templates and examples

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

  ## Node reference

  ### Specify a column's data type

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

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

operations:
  [
    {
      "operation": "executeQuery",
      "name": "Execute Query",
      "description": "Execute an SQL query"
    },
    {
      "operation": "insert",
      "name": "Insert",
      "description": "Insert rows in database"
    },
    {
      "operation": "update",
      "name": "Update",
      "description": "Update rows in database"
    }
  ]


node_type: nodes-base.cron
package_name: n8n-nodes-base
display_name: Cron
description: Triggers the workflow at a specific time
category: trigger
development_style: programmatic
version: 1
operations: []
credentials_required: []
outputs:
  [
  "main"
  ]

updated_at: 2025-11-03 20:57:26
properties_schema:
  [
    {
      "displayName": "This workflow will run on the schedule you define here once you <a data-key=\"activate\">activate</a> it.<br><br>For testing, you can also trigger it manually: by going back to the canvas and clicking 'execute workflow'",
      "name": "notice",
      "type": "notice",
      "default": ""
    },
    {
      "displayName": "Trigger Times",
      "name": "triggerTimes",
      "type": "fixedCollection",
      "default": {},
      "description": "Triggers for the workflow",
      "options": [
        {
          "name": "item",
          "displayName": "Item",
          "values": [
            {
              "displayName": "Mode",
              "name": "mode",
              "type": "options",
              "options": [
                {
                  "name": "Every Minute",
                  "value": "everyMinute"
                },
                {
                  "name": "Every Hour",
                  "value": "everyHour"
                },
                {
                  "name": "Every Day",
                  "value": "everyDay"
                },
                {
                  "name": "Every Week",
                  "value": "everyWeek"
                },
                {
                  "name": "Every Month",
                  "value": "everyMonth"
                },
                {
                  "name": "Every X",
                  "value": "everyX"
                },
                {
                  "name": "Custom",
                  "value": "custom"
                }
              ],
              "default": "everyDay",
              "description": "How often to trigger."
            },
            {
              "displayName": "Hour",
              "name": "hour",
              "type": "number",
              "typeOptions": {
                "minValue": 0,
                "maxValue": 23
              },
              "displayOptions": {
                "hide": {
                  "mode": [
                    "custom",
                    "everyHour",
                    "everyMinute",
                    "everyX"
                  ]
                }
              },
              "default": 14,
              "description": "The hour of the day to trigger (24h format)"
            },
            {
              "displayName": "Minute",
              "name": "minute",
              "type": "number",
              "typeOptions": {
                "minValue": 0,
                "maxValue": 59
              },
              "displayOptions": {
                "hide": {
                  "mode": [
                    "custom",
                    "everyMinute",
                    "everyX"
                  ]
                }
              },
              "default": 0,
              "description": "The minute of the day to trigger"
            },
            {
              "displayName": "Day of Month",
              "name": "dayOfMonth",
              "type": "number",
              "displayOptions": {
                "show": {
                  "mode": [
                    "everyMonth"
                  ]
                }
              },
              "typeOptions": {
                "minValue": 1,
                "maxValue": 31
              },
              "default": 1,
              "description": "The day of the month to trigger"
            },
            {
              "displayName": "Weekday",
              "name": "weekday",
              "type": "options",
              "displayOptions": {
                "show": {
                  "mode": [
                    "everyWeek"
                  ]
                }
              },
              "options": [
                {
                  "name": "Monday",
                  "value": "1"
                },
                {
                  "name": "Tuesday",
                  "value": "2"
                },
                {
                  "name": "Wednesday",
                  "value": "3"
                },
                {
                  "name": "Thursday",
                  "value": "4"
                },
                {
                  "name": "Friday",
                  "value": "5"
                },
                {
                  "name": "Saturday",
                  "value": "6"
                },
                {
                  "name": "Sunday",
                  "value": "0"
                }
              ],
              "default": "1",
              "description": "The weekday to trigger"
            },
            {
              "displayName": "Cron Expression",
              "name": "cronExpression",
              "type": "string",
              "displayOptions": {
                "show": {
                  "mode": [
                    "custom"
                  ]
                }
              },
              "default": "* * * * * *",
              "description": "Use custom cron expression. Values and ranges as follows:<ul><li>Seconds: 0-59</li><li>Minutes: 0 - 59</li><li>Hours: 0 - 23</li><li>Day of Month: 1 - 31</li><li>Months: 0 - 11 (Jan - Dec)</li><li>Day of Week: 0 - 6 (Sun - Sat)</li></ul>"
            },
            {
              "displayName": "Value",
              "name": "value",
              "type": "number",
              "typeOptions": {
                "minValue": 0,
                "maxValue": 1000
              },
              "displayOptions": {
                "show": {
                  "mode": [
                    "everyX"
                  ]
                }
              },
              "default": 2,
              "description": "All how many X minutes/hours it should trigger"
            },
            {
              "displayName": "Unit",
              "name": "unit",
              "type": "options",
              "displayOptions": {
                "show": {
                  "mode": [
                    "everyX"
                  ]
                }
              },
              "options": [
                {
                  "name": "Minutes",
                  "value": "minutes"
                },
                {
                  "name": "Hours",
                  "value": "hours"
                }
              ],
              "default": "hours",
              "description": "If it should trigger all X minutes or hours"
            }
          ]
        }
      ],
      "typeOptions": {
        "multipleValues": true,
        "multipleValueButtonText": "Add Time"
      }
    }
  ]


node_type: nodes-base.crowdDev
package_name: n8n-nodes-base
display_name: crowd.dev
category: transform
development_style: programmatic
version: 1
credentials_required:
  [
  {
  "name": "crowdDevApi",
  "required": true
  }
  ]

outputs:
  [
  "main"
  ]

updated_at: 2025-11-03 20:57:26
description:
  crowd.dev is an open-source suite of community and data tools built to unlock community-led growth for your organization.

documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: crowd.dev node documentation
  description: Learn how to use the crowd.dev node in n8n. Follow technical documentation to integrate crowd.dev node into your workflows.
  contentType: [integration, reference]
  ---

  # crowd.dev node

  Use the crowd.dev node to automate work in crowd.dev and integrate crowd.dev with other applications. n8n has built-in support for a wide range of crowd.dev features, which includes creating, updating, and deleting members, notes, organizations, and tasks.

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

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

  ## Operations

  * Activity
  	* Create or Update with a Member
  	* Create
  * Automation
  	* Create
  	* Destroy
  	* Find
  	* List
  	* Update
  * Member
  	* Create or Update
  	* Delete
  	* Find
  	* Update
  * Note
  	* Create
  	* Delete
  	* Find
  	* Update
  * Organization
  	* Create
  	* Delete
  	* Find
  	* Update
  * Task
  	* Create
  	* Delete
  	* Find
  	* Update

  ## Templates and examples

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

  ## Related resources

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

  Refer to [crowd.dev's documentation](https://docs.crowd.dev/reference/getting-started-with-crowd-dev-api){: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": "activity",
      "options": [
        {
          "name": "Activity",
          "value": "activity"
        },
        {
          "name": "Automation",
          "value": "automation"
        },
        {
          "name": "Member",
          "value": "member"
        },
        {
          "name": "Note",
          "value": "note"
        },
        {
          "name": "Organization",
          "value": "organization"
        },
        {
          "name": "Task",
          "value": "task"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "createWithMember",
      "options": [
        {
          "name": "Create or Update with a Member",
          "value": "createWithMember",
          "description": "Create or update an activity with a member",
          "action": "Create or update an activity with a member",
          "routing": {
            "send": {
              "preSend": [
                null
              ]
            },
            "request": {
              "method": "POST",
              "url": "/activity/with-member"
            }
          }
        },
        {
          "name": "Create",
          "value": "createForMember",
          "description": "Create an activity for a member",
          "action": "Create an activity for a member",
          "routing": {
            "send": {
              "preSend": [
                null
              ]
            },
            "request": {
              "method": "POST",
              "url": "/activity"
            }
          }
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "activity"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "find",
      "options": [
        {
          "name": "Create or Update",
          "value": "createOrUpdate",
          "description": "Create or update a member",
          "action": "Create or update a member",
          "routing": {
            "send": {
              "preSend": [
                null
              ]
            },
            "request": {
              "method": "POST",
              "url": "/member"
            }
          }
        },
        {
          "name": "Delete",
          "value": "delete",
          "description": "Delete a member",
          "action": "Delete a member",
          "routing": {
            "request": {
              "method": "DELETE",
              "url": "=/member"
            }
          }
        },
        {
          "name": "Find",
          "value": "find",
          "description": "Find a member",
          "action": "Find a member",
          "routing": {
            "request": {
              "method": "GET",
              "url": "=/member/{{$parameter[\"id\"]}}"
            }
          }
        },
        {
          "name": "Update",
          "value": "update",
          "description": "Update a member",
          "action": "Update a member",
          "routing": {
            "send": {
              "preSend": [
                null
              ]
            },
            "request": {
              "method": "PUT",
              "url": "=/member/{{$parameter[\"id\"]}}"
            }
          }
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "member"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "find",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create a note",
          "action": "Create a note",
          "routing": {
            "send": {
              "preSend": [
                null
              ]
            },
            "request": {
              "method": "POST",
              "url": "/note"
            }
          }
        },
        {
          "name": "Delete",
          "value": "delete",
          "description": "Delete a note",
          "action": "Delete a note",
          "routing": {
            "request": {
              "method": "DELETE",
              "url": "=/note"
            }
          }
        },
        {
          "name": "Find",
          "value": "find",
          "description": "Find a note",
          "action": "Find a note",
          "routing": {
            "request": {
              "method": "GET",
              "url": "=/note/{{$parameter[\"id\"]}}"
            }
          }
        },
        {
          "name": "Update",
          "value": "update",
          "description": "Update a note",
          "action": "Update a note",
          "routing": {
            "send": {
              "preSend": [
                null
              ]
            },
            "request": {
              "method": "PUT",
              "url": "=/note/{{$parameter[\"id\"]}}"
            }
          }
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "note"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "find",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create an organization",
          "action": "Create an organization",
          "routing": {
            "send": {
              "preSend": [
                null
              ]
            },
            "request": {
              "method": "POST",
              "url": "/organization"
            }
          }
        },
        {
          "name": "Delete",
          "value": "delete",
          "description": "Delete an organization",
          "action": "Delete an organization",
          "routing": {
            "request": {
              "method": "DELETE",
              "url": "=/organization"
            }
          }
        },
        {
          "name": "Find",
          "value": "find",
          "description": "Find an organization",
          "action": "Find an organization",
          "routing": {
            "request": {
              "method": "GET",
              "url": "=/organization/{{$parameter[\"id\"]}}"
            }
          }
        },
        {
          "name": "Update",
          "value": "update",
          "description": "Update an organization",
          "action": "Update an organization",
          "routing": {
            "send": {
              "preSend": [
                null
              ]
            },
            "request": {
              "method": "PUT",
              "url": "=/organization/{{$parameter[\"id\"]}}"
            }
          }
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "organization"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "find",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create a task",
          "action": "Create a task",
          "routing": {
            "send": {
              "preSend": [
                null
              ]
            },
            "request": {
              "method": "POST",
              "url": "/task"
            }
          }
        },
        {
          "name": "Delete",
          "value": "delete",
          "description": "Delete a task",
          "action": "Delete a task",
          "routing": {
            "request": {
              "method": "DELETE",
              "url": "=/task"
            }
          }
        },
        {
          "name": "Find",
          "value": "find",
          "description": "Find a task",
          "action": "Find a task",
          "routing": {
            "request": {
              "method": "GET",
              "url": "=/task/{{$parameter[\"id\"]}}"
            }
          }
        },
        {
          "name": "Update",
          "value": "update",
          "description": "Update a task",
          "action": "Update a task",
          "routing": {
            "send": {
              "preSend": [
                null
              ]
            },
            "request": {
              "method": "PUT",
              "url": "=/task/{{$parameter[\"id\"]}}"
            }
          }
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "task"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "list",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create a new automation for the tenant",
          "action": "Create a new automation for the tenant",
          "routing": {
            "send": {
              "preSend": [
                null
              ]
            },
            "request": {
              "method": "POST",
              "url": "/automation"
            }
          }
        },
        {
          "name": "Destroy",
          "value": "destroy",
          "description": "Destroy an existing automation for the tenant",
          "action": "Destroy an existing automation for the tenant",
          "routing": {
            "request": {
              "method": "DELETE",
              "url": "=/automation/{{$parameter[\"id\"]}}"
            }
          }
        },
        {
          "name": "Find",
          "value": "find",
          "description": "Get an existing automation data for the tenant",
          "action": "Get an existing automation data for the tenant",
          "routing": {
            "request": {
              "method": "GET",
              "url": "=/automation/{{$parameter[\"id\"]}}"
            }
          }
        },
        {
          "name": "List",
          "value": "list",
          "description": "Get all existing automation data for tenant",
          "action": "Get all existing automation data for tenant",
          "routing": {
            "request": {
              "method": "GET",
              "url": "/automation"
            }
          }
        },
        {
          "name": "Update",
          "value": "update",
          "description": "Updates an existing automation for the tenant",
          "action": "Updates an existing automation for the tenant",
          "routing": {
            "send": {
              "preSend": [
                null
              ]
            },
            "request": {
              "method": "PUT",
              "url": "=/automation/{{$parameter[\"id\"]}}"
            }
          }
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "automation"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Username",
      "name": "username",
      "type": "fixedCollection",
      "default": {},
      "options": [
        {
          "displayName": "Item Choice",
          "name": "itemChoice",
          "values": [
            {
              "displayName": "Platform",
              "description": "Platform name (e.g twitter, github, etc)",
              "name": "key",
              "type": "string",
              "required": true,
              "default": ""
            },
            {
              "displayName": "Username",
              "description": "Username at the specified Platform",
              "name": "value",
              "type": "string",
              "required": true,
              "default": ""
            }
          ]
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "activity"
          ],
          "operation": [
            "createWithMember"
          ]
        }
      },
      "typeOptions": {
        "multipleValues": true
      }
    },
    {
      "displayName": "displayName",
      "name": "displayName",
      "type": "string",
      "default": "",
      "description": "UI friendly name of the member",
      "displayOptions": {
        "show": {
          "resource": [
            "activity"
          ],
          "operation": [
            "createWithMember"
          ]
        }
      }
    },
    {
      "displayName": "Emails",
      "name": "emails",
      "type": "fixedCollection",
      "default": {},
      "description": "Email addresses of the member",
      "options": [
        {
          "displayName": "Item Choice",
          "name": "itemChoice",
          "values": [
            {
              "displayName": "Email",
              "name": "email",
              "type": "string",
              "placeholder": "name@email.com",
              "default": ""
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "activity"
          ],
          "operation": [
            "createWithMember"
          ]
        }
      },
      "typeOptions": {
        "multipleValues": true
      }
    },
    {
      "displayName": "Joined At",
      "name": "joinedAt",
      "type": "dateTime",
      "default": "",
      "description": "Date of joining the community",
      "displayOptions": {
        "show": {
          "resource": [
            "activity"
          ],
          "operation": [
            "createWithMember"
          ]
        }
      }
    },
    {
      "displayName": "Member",
      "name": "member",
      "type": "string",
      "default": "",
      "description": "The ID of the member that performed the activity",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "activity"
          ],
          "operation": [
            "createForMember"
          ]
        }
      }
    },
    {
      "displayName": "Type",
      "name": "type",
      "type": "string",
      "default": "",
      "description": "Type of activity",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "activity"
          ]
        }
      }
    },
    {
      "displayName": "Timestamp",
      "name": "timestamp",
      "type": "dateTime",
      "default": "",
      "description": "Date and time when the activity took place",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "activity"
          ]
        }
      }
    },
    {
      "displayName": "Platform",
      "name": "platform",
      "type": "string",
      "default": "",
      "description": "Platform on which the activity took place",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "activity"
          ]
        }
      }
    },
    {
      "displayName": "Source ID",
      "name": "sourceId",
      "type": "string",
      "default": "",
      "description": "The ID of the activity in the platform (e.g. the ID of the message in Discord)",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "activity"
          ]
        }
      }
    },
    {
      "displayName": "Additional Options",
      "name": "additionalOptions",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Title",
          "name": "title",
          "description": "Title of the activity",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Body",
          "name": "body",
          "description": "Body of the activity",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Channel",
          "name": "channel",
          "description": "Channel of the activity",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Source Parent ID",
          "name": "sourceParentId",
          "description": "The ID of the parent activity in the platform (e.g. the ID of the parent message in Discord)",
          "type": "string",
          "default": ""
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "activity"
          ]
        }
      }
    },
    {
      "displayName": "ID",
      "name": "id",
      "type": "string",
      "default": "",
      "description": "The ID of the member",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "member"
          ],
          "operation": [
            "delete",
            "find",
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Platform",
      "name": "platform",
      "type": "string",
      "default": "",
      "description": "Platform for which to check member existence",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "member"
          ],
          "operation": [
            "createOrUpdate",
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Username",
      "name": "username",
      "type": "string",
      "default": "",
      "description": "Username of the member in platform",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "member"
          ],
          "operation": [
            "createOrUpdate",
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Additional Options",
      "name": "additionalOptions",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Display Name",
          "name": "displayName",
          "description": "UI friendly name of the member",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Emails",
          "name": "emails",
          "description": "Email addresses of the member",
          "type": "fixedCollection",
          "typeOptions": {
            "multipleValues": true
          },
          "default": {},
          "options": [
            {
              "displayName": "Item Choice",
              "name": "itemChoice",
              "values": [
                {
                  "displayName": "Email",
                  "name": "email",
                  "type": "string",
                  "placeholder": "name@email.com",
                  "default": ""
                }
              ]
            }
          ]
        },
        {
          "displayName": "Joined At",
          "name": "joinedAt",
          "description": "Date of joining the community",
          "type": "dateTime",
          "default": ""
        },
        {
          "displayName": "Organizations",
          "name": "organizations",
          "description": "Organizations associated with the member. Each element in the array is the name of the organization, or an organization object. If the organization does not exist, it will be created.",
          "type": "fixedCollection",
          "typeOptions": {
            "multipleValues": true
          },
          "default": {},
          "options": [
            {
              "displayName": "Item Choice",
              "name": "itemChoice",
              "values": [
                {
                  "displayName": "Name",
                  "name": "name",
                  "description": "The name of the organization",
                  "type": "string",
                  "required": true,
                  "default": ""
                },
                {
                  "displayName": "Url",
                  "name": "url",
                  "description": "The URL of the organization",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Description",
                  "name": "description",
                  "description": "A short description of the organization",
                  "type": "string",
                  "typeOptions": {
                    "rows": 3
                  },
                  "default": ""
                },
                {
                  "displayName": "Logo",
                  "name": "logo",
                  "description": "A URL for logo of the organization",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Employees",
                  "name": "employees",
                  "description": "The number of employees of the organization",
                  "type": "number",
                  "default": ""
                }
              ]
            }
          ]
        },
        {
          "displayName": "Tags",
          "name": "tags",
          "description": "Tags associated with the member. Each element in the array is the ID of the tag.",
          "type": "fixedCollection",
          "typeOptions": {
            "multipleValues": true
          },
          "default": {},
          "options": [
            {
              "displayName": "Item Choice",
              "name": "itemChoice",
              "values": [
                {
                  "displayName": "Tag",
                  "name": "tag",
                  "type": "string",
                  "default": ""
                }
              ]
            }
          ]
        },
        {
          "displayName": "Tasks",
          "name": "tasks",
          "description": "Tasks associated with the member. Each element in the array is the ID of the task.",
          "type": "fixedCollection",
          "typeOptions": {
            "multipleValues": true
          },
          "default": {},
          "options": [
            {
              "displayName": "Item Choice",
              "name": "itemChoice",
              "values": [
                {
                  "displayName": "Task",
                  "name": "task",
                  "type": "string",
                  "default": ""
                }
              ]
            }
          ]
        },
        {
          "displayName": "Notes",
          "name": "notes",
          "description": "Notes associated with the member. Each element in the array is the ID of the note.",
          "type": "fixedCollection",
          "typeOptions": {
            "multipleValues": true
          },
          "default": {},
          "options": [
            {
              "displayName": "Item Choice",
              "name": "itemChoice",
              "values": [
                {
                  "displayName": "Note",
                  "name": "note",
                  "type": "string",
                  "default": ""
                }
              ]
            }
          ]
        },
        {
          "displayName": "Activities",
          "name": "activities",
          "description": "Activities associated with the member. Each element in the array is the ID of the activity.",
          "type": "fixedCollection",
          "typeOptions": {
            "multipleValues": true
          },
          "default": {},
          "options": [
            {
              "displayName": "Item Choice",
              "name": "itemChoice",
              "values": [
                {
                  "displayName": "Activity",
                  "name": "activity",
                  "type": "string",
                  "default": ""
                }
              ]
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "member"
          ],
          "operation": [
            "createOrUpdate",
            "update"
          ]
        }
      }
    },
    {
      "displayName": "ID",
      "name": "id",
      "type": "string",
      "default": "",
      "description": "The ID of the note",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "note"
          ],
          "operation": [
            "delete",
            "find",
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Body",
      "name": "body",
      "type": "string",
      "default": "",
      "description": "The body of the note",
      "displayOptions": {
        "show": {
          "resource": [
            "note"
          ],
          "operation": [
            "create",
            "update"
          ]
        }
      },
      "typeOptions": {
        "rows": 4
      }
    },
    {
      "displayName": "ID",
      "name": "id",
      "type": "string",
      "default": "",
      "description": "The ID of the organization",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "organization"
          ],
          "operation": [
            "delete",
            "find",
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Name",
      "name": "name",
      "type": "string",
      "default": "",
      "description": "The name of the organization",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "organization"
          ],
          "operation": [
            "create",
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Additional Options",
      "name": "additionalOptions",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Url",
          "name": "url",
          "description": "The URL of the organization",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Description",
          "name": "description",
          "description": "A short description of the organization",
          "type": "string",
          "typeOptions": {
            "rows": 3
          },
          "default": ""
        },
        {
          "displayName": "Logo",
          "name": "logo",
          "description": "A URL for logo of the organization",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Employees",
          "name": "employees",
          "description": "The number of employees of the organization",
          "type": "number",
          "default": ""
        },
        {
          "displayName": "Members",
          "name": "members",
          "description": "Members associated with the organization. Each element in the array is the ID of the member.",
          "type": "fixedCollection",
          "typeOptions": {
            "multipleValues": true
          },
          "default": {},
          "options": [
            {
              "displayName": "Item Choice",
              "name": "itemChoice",
              "values": [
                {
                  "displayName": "Member",
                  "name": "member",
                  "type": "string",
                  "default": ""
                }
              ]
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "organization"
          ],
          "operation": [
            "create",
            "update"
          ]
        }
      }
    },
    {
      "displayName": "ID",
      "name": "id",
      "type": "string",
      "default": "",
      "description": "The ID of the task",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "task"
          ],
          "operation": [
            "delete",
            "find",
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Additional Options",
      "name": "additionalOptions",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Name",
          "name": "name",
          "description": "The name of the task",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Body",
          "name": "body",
          "description": "The body of the task",
          "type": "string",
          "typeOptions": {
            "rows": 4
          },
          "default": ""
        },
        {
          "displayName": "Status",
          "name": "status",
          "description": "The status of the task",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Members",
          "name": "members",
          "description": "Members associated with the task. Each element in the array is the ID of the member.",
          "type": "fixedCollection",
          "typeOptions": {
            "multipleValues": true
          },
          "default": {},
          "options": [
            {
              "displayName": "Item Choice",
              "name": "itemChoice",
              "values": [
                {
                  "displayName": "Member",
                  "name": "member",
                  "type": "string",
                  "default": ""
                }
              ]
            }
          ]
        },
        {
          "displayName": "Activities",
          "name": "activities",
          "description": "Activities associated with the task. Each element in the array is the ID of the activity.",
          "type": "fixedCollection",
          "typeOptions": {
            "multipleValues": true
          },
          "default": {},
          "options": [
            {
              "displayName": "Item Choice",
              "name": "itemChoice",
              "values": [
                {
                  "displayName": "Activity",
                  "name": "activity",
                  "type": "string",
                  "default": ""
                }
              ]
            }
          ]
        },
        {
          "displayName": "Assigneess",
          "name": "assigneess",
          "description": "Users assigned with the task. Each element in the array is the ID of the user.",
          "type": "string",
          "default": ""
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "task"
          ],
          "operation": [
            "create",
            "update"
          ]
        }
      }
    },
    {
      "displayName": "ID",
      "name": "id",
      "type": "string",
      "default": "",
      "description": "The ID of the automation",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "automation"
          ],
          "operation": [
            "destroy",
            "find",
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Trigger",
      "name": "trigger",
      "type": "options",
      "default": "new_activity",
      "description": "What will trigger an automation",
      "options": [
        {
          "name": "New Activity",
          "value": "new_activity"
        },
        {
          "name": "New Member",
          "value": "new_member"
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "automation"
          ],
          "operation": [
            "create",
            "update"
          ]
        }
      }
    },
    {
      "displayName": "URL",
      "name": "url",
      "type": "string",
      "default": "",
      "description": "URL to POST webhook data to",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "automation"
          ],
          "operation": [
            "create",
            "update"
          ]
        }
      }
    }
  ]

operations:
  [
    {
      "operation": "createWithMember",
      "name": "Create or Update with a Member",
      "description": "Create or update an activity with a member"
    },
    {
      "operation": "createForMember",
      "name": "Create",
      "description": "Create an activity for a member"
    }
  ]


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

outputs:
  [
  "main"
  ]

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

  # crowd.dev Trigger node

  Use the crowd.dev Trigger node to respond to events in [crowd.dev](https://www.crowd.dev/){:target=_blank .external-link} and integrate crowd.dev with other applications. n8n has built-in support for a wide range of crowd.dev events, including new activities and new members.

  On this page, you'll find a list of events the crowd.dev Trigger node can respond to and links to more resources.

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

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

  ## Events

  * New Activity
  * New Member

  ## Related resources

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

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

  Refer to [crowd.dev's documentation](https://docs.crowd.dev/reference/getting-started-with-crowd-dev-api){:target=_blank .external-link} for more information about the service.

properties_schema:
  [
    {
      "displayName": "Trigger",
      "name": "trigger",
      "type": "options",
      "default": "new_activity",
      "description": "What will trigger an automation",
      "options": [
        {
          "name": "New Activity",
          "value": "new_activity"
        },
        {
          "name": "New Member",
          "value": "new_member"
        }
      ],
      "required": true
    }
  ]


node_type: nodes-base.crypto
package_name: n8n-nodes-base
display_name: Crypto
description: Provide cryptographic utilities
category: transform
development_style: programmatic
version: 1
credentials_required: []
outputs:
  [
  "main"
  ]

updated_at: 2025-11-03 20:57:26
documentation:
  ---
  #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
  title: Crypto
  description: Documentation for the Crypto node in n8n, a workflow automation platform. Includes guidance on usage, and links to examples.
  contentType: [integration, reference]
  priority: medium
  ---

  # Crypto

  Use the Crypto node to encrypt data in workflows.

  ## Actions

  * [**Generate** a random string](#generate-parameters)
  * [**Hash** a text or file](#hash-parameters) in a specified format
  * [**Hmac** a text or file](#hmac-parameters) in a specified format
  * [**Sign** a string](#sign-parameters) using a private key

  ## Node parameters

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

  Node parameters depend on the action you select.

  ### Generate parameters

  * **Property Name**: Enter the name of the property to write the random string to.
  * **Type**: Select the encoding type to use to generate the string. Choose from:
  	* **ASCII**
  	* **BASE64**
  	* **HEX**
  	* **UUID**

  ### Hash parameters

  * **Type**: Select the hash type to use. Choose from:
  	* **MD5**
  	* **SHA256**
  	* **SHA3-256**
  	* **SHA3-384**
  	* **SHA3-512**
  	* **SHA385**
  	* **SHA512**
  * **Binary File**: Turn this parameter on if the data you want to hash is from a binary file.
  	* **Value**: If you turn off **Binary File**, enter the value you want to hash.
  	* **Binary Property Name**: If you turn on **Binary File**, enter the name of the binary property that contains the data you want to hash.
  * **Property Name**: Enter the name of the property you want to write the hash to.
  * **Encoding**: Select the encoding type to use. Choose from:
  	* **BASE64**
  	* **HEX**

  ### Hmac parameters

  * **Binary File**: Turn this parameter on if the data you want to encrypt is from a binary file.
  	* **Value**: If you turn off **Binary File**, enter the value you want to encrypt.
  	* **Binary Property Name**: If you turn on **Binary File**, enter the name of the binary property that contains the data you want to encrypt.
  * **Type**: Select the encryption type to use. Choose from:
  	* **MD5**
  	* **SHA256**
  	* **SHA3-256**
  	* **SHA3-384**
  	* **SHA3-512**
  	* **SHA385**
  	* **SHA512**
  * **Property Name**: Enter the name of the property you want to write the hash to.
  * **Secret**: Enter the secret or secret key used for decoding.
  * **Encoding**: Select the encoding type to use. Choose from:
  	* **BASE64**
  	* **HEX**

  ### Sign parameters

  * **Value**: Enter the value you want to sign.
  * **Property Name**: Enter the name of the property you want to write the signed value to.
  * **Algorithm Name or ID**: Choose an algorithm name from the list or specify an ID using an [expression](/code/expressions.md).
  * **Encoding**: Select the encoding type to use. Choose from:
  	* **BASE64**
  	* **HEX**
  * **Private Key**: Enter a private key to use when signing the string.

  ## Templates and examples

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

properties_schema:
  [
    {
      "displayName": "Action",
      "name": "action",
      "type": "options",
      "default": "hash",
      "options": [
        {
          "name": "Generate",
          "description": "Generate random string",
          "value": "generate",
          "action": "Generate random string"
        },
        {
          "name": "Hash",
          "description": "Hash a text or file in a specified format",
          "value": "hash",
          "action": "Hash a text or file in a specified format"
        },
        {
          "name": "Hmac",
          "description": "Hmac a text or file in a specified format",
          "value": "hmac",
          "action": "HMAC a text or file in a specified format"
        },
        {
          "name": "Sign",
          "description": "Sign a string using a private key",
          "value": "sign",
          "action": "Sign a string using a private key"
        }
      ]
    },
    {
      "displayName": "Type",
      "name": "type",
      "type": "options",
      "default": "MD5",
      "description": "The hash type to use",
      "options": [
        {
          "name": "MD5",
          "value": "MD5"
        },
        {
          "name": "SHA256",
          "value": "SHA256"
        },
        {
          "name": "SHA3-256",
          "value": "SHA3-256"
        },
        {
          "name": "SHA3-384",
          "value": "SHA3-384"
        },
        {
          "name": "SHA3-512",
          "value": "SHA3-512"
        },
        {
          "name": "SHA384",
          "value": "SHA384"
        },
        {
          "name": "SHA512",
          "value": "SHA512"
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "action": [
            "hash"
          ]
        }
      }
    },
    {
      "displayName": "Binary File",
      "name": "binaryData",
      "type": "boolean",
      "default": false,
      "description": "Whether the data to hashed should be taken from binary field",
      "required": true,
      "displayOptions": {
        "show": {
          "action": [
            "hash",
            "hmac"
          ]
        }
      }
    },
    {
      "displayName": "Binary Property Name",
      "name": "binaryPropertyName",
      "type": "string",
      "default": "data",
      "description": "Name of the binary property which contains the input data",
      "required": true,
      "displayOptions": {
        "show": {
          "action": [
            "hash",
            "hmac"
          ],
          "binaryData": [
            true
          ]
        }
      }
    },
    {
      "displayName": "Value",
      "name": "value",
      "type": "string",
      "default": "",
      "description": "The value that should be hashed",
      "required": true,
      "displayOptions": {
        "show": {
          "action": [
            "hash"
          ],
          "binaryData": [
            false
          ]
        }
      }
    },
    {
      "displayName": "Property Name",
      "name": "dataPropertyName",
      "type": "string",
      "default": "data",
      "description": "Name of the property to which to write the hash",
      "required": true,
      "displayOptions": {
        "show": {
          "action": [
            "hash"
          ]
        }
      }
    },
    {
      "displayName": "Encoding",
      "name": "encoding",
      "type": "options",
      "default": "hex",
      "options": [
        {
          "name": "BASE64",
          "value": "base64"
        },
        {
          "name": "HEX",
          "value": "hex"
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "action": [
            "hash"
          ]
        }
      }
    },
    {
      "displayName": "Type",
      "name": "type",
      "type": "options",
      "default": "MD5",
      "description": "The hash type to use",
      "options": [
        {
          "name": "MD5",
          "value": "MD5"
        },
        {
          "name": "SHA256",
          "value": "SHA256"
        },
        {
          "name": "SHA3-256",
          "value": "SHA3-256"
        },
        {
          "name": "SHA3-384",
          "value": "SHA3-384"
        },
        {
          "name": "SHA3-512",
          "value": "SHA3-512"
        },
        {
          "name": "SHA384",
          "value": "SHA384"
        },
        {
          "name": "SHA512",
          "value": "SHA512"
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "action": [
            "hmac"
          ]
        }
      }
    },
    {
      "displayName": "Value",
      "name": "value",
      "type": "string",
      "default": "",
      "description": "The value of which the hmac should be created",
      "required": true,
      "displayOptions": {
        "show": {
          "action": [
            "hmac"
          ],
          "binaryData": [
            false
          ]
        }
      }
    },
    {
      "displayName": "Property Name",
      "name": "dataPropertyName",
      "type": "string",
      "default": "data",
      "description": "Name of the property to which to write the hmac",
      "required": true,
      "displayOptions": {
        "show": {
          "action": [
            "hmac"
          ]
        }
      }
    },
    {
      "displayName": "Secret",
      "name": "secret",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "action": [
            "hmac"
          ]
        }
      },
      "typeOptions": {
        "password": true
      }
    },
    {
      "displayName": "Encoding",
      "name": "encoding",
      "type": "options",
      "default": "hex",
      "options": [
        {
          "name": "BASE64",
          "value": "base64"
        },
        {
          "name": "HEX",
          "value": "hex"
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "action": [
            "hmac"
          ]
        }
      }
    },
    {
      "displayName": "Value",
      "name": "value",
      "type": "string",
      "default": "",
      "description": "The value that should be signed",
      "required": true,
      "displayOptions": {
        "show": {
          "action": [
            "sign"
          ]
        }
      }
    },
    {
      "displayName": "Property Name",
      "name": "dataPropertyName",
      "type": "string",
      "default": "data",
      "description": "Name of the property to which to write the signed value",
      "required": true,
      "displayOptions": {
        "show": {
          "action": [
            "sign"
          ]
        }
      }
    },
    {
      "displayName": "Algorithm Name or ID",
      "name": "algorithm",
      "type": "options",
      "default": "",
      "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
      "options": [
        {
          "name": "RSA-MD5",
          "value": "RSA-MD5"
        },
        {
          "name": "RSA-RIPEMD160",
          "value": "RSA-RIPEMD160"
        },
        {
          "name": "RSA-SHA1",
          "value": "RSA-SHA1"
        },
        {
          "name": "RSA-SHA1-2",
          "value": "RSA-SHA1-2"
        },
        {
          "name": "RSA-SHA224",
          "value": "RSA-SHA224"
        },
        {
          "name": "RSA-SHA256",
          "value": "RSA-SHA256"
        },
        {
          "name": "RSA-SHA3-224",
          "value": "RSA-SHA3-224"
        },
        {
          "name": "RSA-SHA3-256",
          "value": "RSA-SHA3-256"
        },
        {
          "name": "RSA-SHA3-384",
          "value": "RSA-SHA3-384"
        },
        {
          "name": "RSA-SHA3-512",
          "value": "RSA-SHA3-512"
        },
        {
          "name": "RSA-SHA384",
          "value": "RSA-SHA384"
        },
        {
          "name": "RSA-SHA512",
          "value": "RSA-SHA512"
        },
        {
          "name": "RSA-SHA512/224",
          "value": "RSA-SHA512/224"
        },
        {
          "name": "RSA-SHA512/256",
          "value": "RSA-SHA512/256"
        },
        {
          "name": "RSA-SM3",
          "value": "RSA-SM3"
        },
        {
          "name": "blake2b512",
          "value": "blake2b512"
        },
        {
          "name": "blake2s256",
          "value": "blake2s256"
        },
        {
          "name": "id-rsassa-pkcs1-v1_5-with-sha3-224",
          "value": "id-rsassa-pkcs1-v1_5-with-sha3-224"
        },
        {
          "name": "id-rsassa-pkcs1-v1_5-with-sha3-256",
          "value": "id-rsassa-pkcs1-v1_5-with-sha3-256"
        },
        {
          "name": "id-rsassa-pkcs1-v1_5-with-sha3-384",
          "value": "id-rsassa-pkcs1-v1_5-with-sha3-384"
        },
        {
          "name": "id-rsassa-pkcs1-v1_5-with-sha3-512",
          "value": "id-rsassa-pkcs1-v1_5-with-sha3-512"
        },
        {
          "name": "md5",
          "value": "md5"
        },
        {
          "name": "md5-sha1",
          "value": "md5-sha1"
        },
        {
          "name": "md5WithRSAEncryption",
          "value": "md5WithRSAEncryption"
        },
        {
          "name": "ripemd",
          "value": "ripemd"
        },
        {
          "name": "ripemd160",
          "value": "ripemd160"
        },
        {
          "name": "ripemd160WithRSA",
          "value": "ripemd160WithRSA"
        },
        {
          "name": "rmd160",
          "value": "rmd160"
        },
        {
          "name": "sha1",
          "value": "sha1"
        },
        {
          "name": "sha1WithRSAEncryption",
          "value": "sha1WithRSAEncryption"
        },
        {
          "name": "sha224",
          "value": "sha224"
        },
        {
          "name": "sha224WithRSAEncryption",
          "value": "sha224WithRSAEncryption"
        },
        {
          "name": "sha256",
          "value": "sha256"
        },
        {
          "name": "sha256WithRSAEncryption",
          "value": "sha256WithRSAEncryption"
        },
        {
          "name": "sha3-224",
          "value": "sha3-224"
        },
        {
          "name": "sha3-256",
          "value": "sha3-256"
        },
        {
          "name": "sha3-384",
          "value": "sha3-384"
        },
        {
          "name": "sha3-512",
          "value": "sha3-512"
        },
        {
          "name": "sha384",
          "value": "sha384"
        },
        {
          "name": "sha384WithRSAEncryption",
          "value": "sha384WithRSAEncryption"
        },
        {
          "name": "sha512",
          "value": "sha512"
        },
        {
          "name": "sha512-224",
          "value": "sha512-224"
        },
        {
          "name": "sha512-224WithRSAEncryption",
          "value": "sha512-224WithRSAEncryption"
        },
        {
          "name": "sha512-256",
          "value": "sha512-256"
        },
        {
          "name": "sha512-256WithRSAEncryption",
          "value": "sha512-256WithRSAEncryption"
        },
        {
          "name": "sha512WithRSAEncryption",
          "value": "sha512WithRSAEncryption"
        },
        {
          "name": "shake128",
          "value": "shake128"
        },
        {
          "name": "shake256",
          "value": "shake256"
        },
        {
          "name": "sm3",
          "value": "sm3"
        },
        {
          "name": "sm3WithRSAEncryption",
          "value": "sm3WithRSAEncryption"
        },
        {
          "name": "ssl3-md5",
          "value": "ssl3-md5"
        },
        {
          "name": "ssl3-sha1",
          "value": "ssl3-sha1"
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "action": [
            "sign"
          ]
        }
      }
    },
    {
      "displayName": "Encoding",
      "name": "encoding",
      "type": "options",
      "default": "hex",
      "options": [
        {
          "name": "BASE64",
          "value": "base64"
        },
        {
          "name": "HEX",
          "value": "hex"
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "action": [
            "sign"
          ]
        }
      }
    },
    {
      "displayName": "Private Key",
      "name": "privateKey",
      "type": "string",
      "default": "",
      "description": "Private key to use when signing the string",
      "required": true,
      "displayOptions": {
        "show": {
          "action": [
            "sign"
          ]
        }
      }
    },
    {
      "displayName": "Property Name",
      "name": "dataPropertyName",
      "type": "string",
      "default": "data",
      "description": "Name of the property to which to write the random string",
      "required": true,
      "displayOptions": {
        "show": {
          "action": [
            "generate"
          ]
        }
      }
    },
    {
      "displayName": "Type",
      "name": "encodingType",
      "type": "options",
      "default": "uuid",
      "description": "Encoding that will be used to generate string",
      "options": [
        {
          "name": "ASCII",
          "value": "ascii"
        },
        {
          "name": "BASE64",
          "value": "base64"
        },
        {
          "name": "HEX",
          "value": "hex"
        },
        {
          "name": "UUID",
          "value": "uuid"
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "action": [
            "generate"
          ]
        }
      }
    },
    {
      "displayName": "Length",
      "name": "stringLength",
      "type": "number",
      "default": 32,
      "description": "Length of the generated string",
      "displayOptions": {
        "show": {
          "action": [
            "generate"
          ],
          "encodingType": [
            "ascii",
            "base64",
            "hex"
          ]
        }
      }
    }
  ]

operations:
  [
    {
      "operation": "generate",
      "name": "Generate",
      "description": "Generate random string"
    },
    {
      "operation": "hash",
      "name": "Hash",
      "description": "Hash a text or file in a specified format"
    },
    {
      "operation": "hmac",
      "name": "Hmac",
      "description": "Hmac a text or file in a specified format"
    },
    {
      "operation": "sign",
      "name": "Sign",
      "description": "Sign a string using a private key"
    }
  ]


