# nodes

node_type: nodes-base.salesforceTrigger
package_name: n8n-nodes-base
display_name: Salesforce Trigger
description: Fetches data from Salesforce and starts the workflow on specified polling intervals.
category: trigger
development_style: programmatic
version: 1
operations: []
credentials_required:
  [
  {
  "name": "salesforceOAuth2Api",
  "required": true
  }
  ]

outputs:
  [
  "main"
  ]

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

  # Salesforce Trigger node

  Use the Salesforce Trigger node to respond to events in [Salesforce](https://login.salesforce.com/){:target=_blank .external-link} and integrate Salesforce with other applications. n8n has built-in support for a wide range of Salesforce events.

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

  ///  note  | Credentials
  You can find authentication information for this node [here](/integrations/builtin/credentials/salesforce.md).
  ///
  ///  note  | Examples and templates
  For usage examples and templates to help you get started, refer to n8n's [Salesforce trigger integrations](https://n8n.io/integrations/salesforce-trigger/){:target=_blank .external-link} page.
  ///

  ## Events

  * On Account Created
  * On Account Updated
  * On Attachment Created
  * On Attachment Updated
  * On Case Created
  * On Case Updated
  * On Contact Created
  * On Contact Updated
  * On Custom Object Created
  * On Custom Object Updated
  * On Lead Created
  * On Lead Updated
  * On Opportunity Created
  * On Opportunity Updated
  * On Task Created
  * On Task Updated
  * On User Created
  * On User Updated

  ## Related resources

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

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

properties_schema:
  [
    {
      "displayName": "Trigger On",
      "name": "triggerOn",
      "type": "options",
      "default": "",
      "description": "Which Salesforce event should trigger the node",
      "options": [
        {
          "name": "Account Created",
          "value": "accountCreated",
          "description": "When a new account is created"
        },
        {
          "name": "Account Updated",
          "value": "accountUpdated",
          "description": "When an existing account is modified"
        },
        {
          "name": "Attachment Created",
          "value": "attachmentCreated",
          "description": "When a file is uploaded and attached to an object"
        },
        {
          "name": "Attachment Updated",
          "value": "attachmentUpdated",
          "description": "When an existing file is modified"
        },
        {
          "name": "Case Created",
          "value": "caseCreated",
          "description": "When a new case is created"
        },
        {
          "name": "Case Updated",
          "value": "caseUpdated",
          "description": "When an existing case is modified"
        },
        {
          "name": "Contact Created",
          "value": "contactCreated",
          "description": "When a new contact is created"
        },
        {
          "name": "Contact Updated",
          "value": "contactUpdated",
          "description": "When an existing contact is modified"
        },
        {
          "name": "Custom Object Created",
          "value": "customObjectCreated",
          "description": "When a new object of a given type is created"
        },
        {
          "name": "Custom Object Updated",
          "value": "customObjectUpdated",
          "description": "When an object of a given type is modified"
        },
        {
          "name": "Lead Created",
          "value": "leadCreated",
          "description": "When a new lead is created"
        },
        {
          "name": "Lead Updated",
          "value": "leadUpdated",
          "description": "When an existing lead is modified"
        },
        {
          "name": "Opportunity Created",
          "value": "opportunityCreated",
          "description": "When a new opportunity is created"
        },
        {
          "name": "Opportunity Updated",
          "value": "opportunityUpdated",
          "description": "When an existing opportunity is modified"
        },
        {
          "name": "Task Created",
          "value": "taskCreated",
          "description": "When a new task is created"
        },
        {
          "name": "Task Updated",
          "value": "taskUpdated",
          "description": "When an existing task is modified"
        },
        {
          "name": "User Created",
          "value": "userCreated",
          "description": "When a new user is created"
        },
        {
          "name": "User Updated",
          "value": "userUpdated",
          "description": "When an existing user is modified"
        }
      ]
    },
    {
      "displayName": "Custom Object Name or ID",
      "name": "customObject",
      "type": "options",
      "default": "",
      "description": "Name of the custom object. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
      "required": true,
      "displayOptions": {
        "show": {
          "triggerOn": [
            "customObjectUpdated",
            "customObjectCreated"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getCustomObjects"
      }
    }
  ]


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

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

output_names:
  [
  "Tool"
  ]

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

  # Salesmate node

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

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

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

  ## Operations

  * Activity
      * Create an activity
      * Delete an activity
      * Get an activity
      * Get all companies
      * Update an activity
  * Company
      * Create a company
      * Delete a company
      * Get a company
      * Get all companies
      * Update a company
  * Deal
      * Create a deal
      * Delete a deal
      * Get a deal
      * Get all deals
      * Update a deal

  ## Templates and examples

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

properties_schema:
  [
    {
      "displayName": "Tool Description",
      "name": "toolDescription",
      "type": "string",
      "default": "",
      "required": false,
      "description": "Description for the AI to understand what this tool does and when to use it",
      "typeOptions": {
        "rows": 3
      },
      "placeholder": "e.g., Use this tool to interact with Salesmate"
    },
    {
      "displayName": "Resource",
      "name": "resource",
      "type": "options",
      "default": "activity",
      "options": [
        {
          "name": "Activity",
          "value": "activity"
        },
        {
          "name": "Company",
          "value": "company"
        },
        {
          "name": "Deal",
          "value": "deal"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create a company",
          "action": "Create a company"
        },
        {
          "name": "Delete",
          "value": "delete",
          "description": "Delete a company",
          "action": "Delete a company"
        },
        {
          "name": "Get",
          "value": "get",
          "description": "Get a company",
          "action": "Get a company"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get many companies",
          "action": "Get many companies"
        },
        {
          "name": "Update",
          "value": "update",
          "description": "Update a company",
          "action": "Update a company"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "company"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create an activity",
          "action": "Create an activity"
        },
        {
          "name": "Delete",
          "value": "delete",
          "description": "Delete an activity",
          "action": "Delete an activity"
        },
        {
          "name": "Get",
          "value": "get",
          "description": "Get an activity",
          "action": "Get an activity"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get many companies",
          "action": "Get many activities"
        },
        {
          "name": "Update",
          "value": "update",
          "description": "Update an activity",
          "action": "Update an activity"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "activity"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create a deal",
          "action": "Create a deal"
        },
        {
          "name": "Delete",
          "value": "delete",
          "description": "Delete a deal",
          "action": "Delete a deal"
        },
        {
          "name": "Get",
          "value": "get",
          "description": "Get a deal",
          "action": "Get a deal"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get many deals",
          "action": "Get many deals"
        },
        {
          "name": "Update",
          "value": "update",
          "description": "Update a deal",
          "action": "Update a deal"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "deal"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Name",
      "name": "name",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "company"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Owner Name or ID",
      "name": "owner",
      "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": [
            "company"
          ],
          "operation": [
            "create"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getUsers"
      }
    },
    {
      "displayName": "RAW Data",
      "name": "rawData",
      "type": "boolean",
      "default": false,
      "description": "Whether the data should include the fields details",
      "displayOptions": {
        "show": {
          "resource": [
            "company"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Website",
          "name": "website",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Phone",
          "name": "phone",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Other Phone",
          "name": "otherPhone",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Facebook Handle",
          "name": "facebookHandle",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Google Plus Handle",
          "name": "googlePlusHandle",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "LinkedIn Handle",
          "name": "linkedInHandle",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Skype ID",
          "name": "skypeId",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Twitter Handle",
          "name": "twitterHandle",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Currency",
          "name": "currency",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Billing Address Line 1",
          "name": "billingAddressLine1",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Billing Address Line 2",
          "name": "billingAddressLine2",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Billing City",
          "name": "billingCity",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Billing Zip Code",
          "name": "billingZipCode",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Billing State",
          "name": "billingState",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Billing Country",
          "name": "billingState",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Description",
          "name": "description",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Tags",
          "name": "tags",
          "type": "string",
          "default": ""
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "company"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Company ID",
      "name": "id",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "company"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "RAW Data",
      "name": "rawData",
      "type": "boolean",
      "default": false,
      "description": "Whether the data should include the fields details",
      "displayOptions": {
        "show": {
          "resource": [
            "company"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Update Fields",
      "name": "updateFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Name",
          "name": "name",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Owner Name or ID",
          "name": "owner",
          "type": "options",
          "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
          "default": "",
          "typeOptions": {
            "loadOptionsMethod": "getUsers"
          }
        },
        {
          "displayName": "Website",
          "name": "website",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Phone",
          "name": "phone",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Other Phone",
          "name": "otherPhone",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Facebook Handle",
          "name": "facebookHandle",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Google Plus Handle",
          "name": "googlePlusHandle",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "LinkedIn Handle",
          "name": "linkedInHandle",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Skype ID",
          "name": "skypeId",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Twitter Handle",
          "name": "twitterHandle",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Currency",
          "name": "currency",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Billing Address Line 1",
          "name": "billingAddressLine1",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Billing Address Line 2",
          "name": "billingAddressLine2",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Billing City",
          "name": "billingCity",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Billing Zip Code",
          "name": "billingZipCode",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Billing State",
          "name": "billingState",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Billing Country",
          "name": "billingState",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Description",
          "name": "description",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Tags",
          "name": "tags",
          "type": "string",
          "default": ""
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "company"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Company ID",
      "name": "id",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "company"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "RAW Data",
      "name": "rawData",
      "type": "boolean",
      "default": false,
      "description": "Whether the data should include the fields details",
      "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": 10,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "company"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 25
      }
    },
    {
      "displayName": "JSON Parameters",
      "name": "jsonParameters",
      "type": "boolean",
      "default": false,
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "company"
          ]
        }
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Fields",
          "name": "fields",
          "type": "string",
          "default": "",
          "description": "Comma-separated list of fields to return"
        },
        {
          "displayName": "Sort By",
          "name": "sortBy",
          "type": "string",
          "default": "",
          "description": "The field to sort by"
        },
        {
          "displayName": "Sort Order",
          "name": "sortOrder",
          "type": "options",
          "options": [
            {
              "name": "ASC",
              "value": "asc"
            },
            {
              "name": "DESC",
              "value": "desc"
            }
          ],
          "default": "desc"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "company"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Filters",
      "name": "filtersJson",
      "type": "json",
      "default": "",
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "company"
          ],
          "jsonParameters": [
            true
          ]
        }
      },
      "typeOptions": {
        "alwaysOpenEditWindow": true
      }
    },
    {
      "displayName": "Filters",
      "name": "filters",
      "type": "fixedCollection",
      "default": {},
      "options": [
        {
          "name": "filtersUi",
          "displayName": "Filters",
          "values": [
            {
              "displayName": "Operator",
              "name": "operator",
              "type": "options",
              "options": [
                {
                  "name": "AND",
                  "value": "AND"
                },
                {
                  "name": "OR",
                  "value": "OR"
                }
              ],
              "default": "AND"
            },
            {
              "displayName": "Conditions",
              "name": "conditions",
              "placeholder": "Add Condition",
              "type": "fixedCollection",
              "typeOptions": {
                "multipleValues": true
              },
              "default": {},
              "options": [
                {
                  "name": "conditionsUi",
                  "displayName": "Conditions",
                  "values": [
                    {
                      "displayName": "Field",
                      "name": "field",
                      "type": "options",
                      "options": [
                        {
                          "name": "Name",
                          "value": "name"
                        },
                        {
                          "name": "Email",
                          "value": "email"
                        },
                        {
                          "name": "Phone",
                          "value": "phone"
                        }
                      ],
                      "default": "name"
                    },
                    {
                      "displayName": "Condition",
                      "name": "condition",
                      "type": "options",
                      "options": [
                        {
                          "name": "Equals",
                          "value": "EQUALS"
                        },
                        {
                          "name": "Not Equals",
                          "value": "NOT_EQUALS"
                        },
                        {
                          "name": "CONTAINS",
                          "value": "Contains"
                        },
                        {
                          "name": "Does Not Contains",
                          "value": "DOES_NOT_CONTAINS"
                        },
                        {
                          "name": "Empty",
                          "value": "EMPTY"
                        },
                        {
                          "name": "Not Empty",
                          "value": "NOT_EMPTY"
                        },
                        {
                          "name": "Starts With",
                          "value": "STARTS_WITH"
                        },
                        {
                          "name": "Ends With",
                          "value": "ENDS_WITH"
                        }
                      ],
                      "default": "EQUALS",
                      "description": "Value of the property to set"
                    },
                    {
                      "displayName": "Value",
                      "name": "value",
                      "type": "string",
                      "default": ""
                    }
                  ]
                }
              ]
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "company"
          ],
          "operation": [
            "getAll"
          ],
          "jsonParameters": [
            false
          ]
        }
      },
      "typeOptions": {
        "multipleValues": false
      }
    },
    {
      "displayName": "Company ID",
      "name": "id",
      "type": "string",
      "default": "",
      "description": "If more than one company add them separated by ,",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "company"
          ],
          "operation": [
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "Title",
      "name": "title",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "activity"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Owner Name or ID",
      "name": "owner",
      "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": [
            "activity"
          ],
          "operation": [
            "create"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getUsers"
      }
    },
    {
      "displayName": "Type",
      "name": "type",
      "type": "string",
      "default": "",
      "description": "This field displays activity type such as call, meeting etc",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "activity"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "RAW Data",
      "name": "rawData",
      "type": "boolean",
      "default": false,
      "description": "Whether the data should include the fields details",
      "displayOptions": {
        "show": {
          "resource": [
            "activity"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Description",
          "name": "description",
          "type": "string",
          "default": "",
          "description": "This field contains details related to the activity"
        },
        {
          "displayName": "Tags",
          "name": "tags",
          "type": "string",
          "default": "",
          "description": "This field contains tags associated with an activity"
        },
        {
          "displayName": "Due Date",
          "name": "dueDate",
          "type": "dateTime",
          "default": "",
          "description": "Expiry date of an activity"
        },
        {
          "displayName": "Duration",
          "name": "duration",
          "type": "number",
          "default": "",
          "description": "Time duration of an activity"
        },
        {
          "displayName": "Is Calendar Invite",
          "name": "isCalendarInvite",
          "type": "boolean",
          "default": false,
          "description": "Whether to send calendar invite"
        },
        {
          "displayName": "Is Completed",
          "name": "isCompleted",
          "type": "boolean",
          "default": false,
          "description": "Whether the activity is completed or not"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "activity"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Activity ID",
      "name": "id",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "activity"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "RAW Data",
      "name": "rawData",
      "type": "boolean",
      "default": false,
      "description": "Whether the data should include the fields details",
      "displayOptions": {
        "show": {
          "resource": [
            "activity"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Update Fields",
      "name": "updateFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Title",
          "name": "title",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Type",
          "name": "type",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Owner",
          "name": "owner",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Description",
          "name": "description",
          "type": "string",
          "default": "",
          "description": "This field contains details related to the activity"
        },
        {
          "displayName": "Tags",
          "name": "tags",
          "type": "string",
          "default": "",
          "description": "This field contains tags associated with an activity"
        },
        {
          "displayName": "Due Date",
          "name": "dueDate",
          "type": "dateTime",
          "default": "",
          "description": "Expiry date of an activity"
        },
        {
          "displayName": "Duration",
          "name": "duration",
          "type": "number",
          "default": "",
          "description": "Time duration of an activity"
        },
        {
          "displayName": "Is Calendar Invite",
          "name": "isCalendarInvite",
          "type": "boolean",
          "default": false,
          "description": "Whether to send calendar invite"
        },
        {
          "displayName": "Is Completed",
          "name": "isCompleted",
          "type": "boolean",
          "default": false,
          "description": "Whether the activity is completed or not"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "activity"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Activity ID",
      "name": "id",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "activity"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "RAW Data",
      "name": "rawData",
      "type": "boolean",
      "default": false,
      "description": "Whether the data should include the fields details",
      "displayOptions": {
        "show": {
          "resource": [
            "activity"
          ],
          "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": [
            "activity"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 10,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "activity"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 25
      }
    },
    {
      "displayName": "JSON Parameters",
      "name": "jsonParameters",
      "type": "boolean",
      "default": false,
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "activity"
          ]
        }
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Fields",
          "name": "fields",
          "type": "string",
          "default": "",
          "description": "Comma-separated list of fields to return"
        },
        {
          "displayName": "Sort By",
          "name": "sortBy",
          "type": "string",
          "default": "",
          "description": "The field to sort by"
        },
        {
          "displayName": "Sort Order",
          "name": "sortOrder",
          "type": "options",
          "options": [
            {
              "name": "ASC",
              "value": "asc"
            },
            {
              "name": "DESC",
              "value": "desc"
            }
          ],
          "default": "desc"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "activity"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Filters",
      "name": "filtersJson",
      "type": "json",
      "default": "",
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "activity"
          ],
          "jsonParameters": [
            true
          ]
        }
      },
      "typeOptions": {
        "alwaysOpenEditWindow": true
      }
    },
    {
      "displayName": "Filters",
      "name": "filters",
      "type": "fixedCollection",
      "default": {},
      "options": [
        {
          "name": "filtersUi",
          "displayName": "Filters",
          "values": [
            {
              "displayName": "Operator",
              "name": "operator",
              "type": "options",
              "options": [
                {
                  "name": "AND",
                  "value": "AND"
                },
                {
                  "name": "OR",
                  "value": "OR"
                }
              ],
              "default": "AND"
            },
            {
              "displayName": "Conditions",
              "name": "conditions",
              "placeholder": "Add Condition",
              "type": "fixedCollection",
              "typeOptions": {
                "multipleValues": true
              },
              "default": {},
              "options": [
                {
                  "name": "conditionsUi",
                  "displayName": "Conditions",
                  "values": [
                    {
                      "displayName": "Field",
                      "name": "field",
                      "type": "options",
                      "options": [
                        {
                          "name": "Title",
                          "value": "title"
                        },
                        {
                          "name": "Tags",
                          "value": "tags"
                        }
                      ],
                      "default": "title"
                    },
                    {
                      "displayName": "Condition",
                      "name": "condition",
                      "type": "options",
                      "options": [
                        {
                          "name": "Equals",
                          "value": "EQUALS"
                        },
                        {
                          "name": "Not Equals",
                          "value": "NOT_EQUALS"
                        },
                        {
                          "name": "CONTAINS",
                          "value": "Contains"
                        },
                        {
                          "name": "Does Not Contains",
                          "value": "DOES_NOT_CONTAINS"
                        },
                        {
                          "name": "Empty",
                          "value": "EMPTY"
                        },
                        {
                          "name": "Not Empty",
                          "value": "NOT_EMPTY"
                        },
                        {
                          "name": "Starts With",
                          "value": "STARTS_WITH"
                        },
                        {
                          "name": "Ends With",
                          "value": "ENDS_WITH"
                        }
                      ],
                      "default": "EQUALS",
                      "description": "Value of the property to set"
                    },
                    {
                      "displayName": "Value",
                      "name": "value",
                      "type": "string",
                      "default": ""
                    }
                  ]
                }
              ]
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "activity"
          ],
          "operation": [
            "getAll"
          ],
          "jsonParameters": [
            false
          ]
        }
      },
      "typeOptions": {
        "multipleValues": false
      }
    },
    {
      "displayName": "Activity ID",
      "name": "id",
      "type": "string",
      "default": "",
      "description": "If more than one activity add them separated by ,",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "activity"
          ],
          "operation": [
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "Title",
      "name": "title",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "deal"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Owner Name or ID",
      "name": "owner",
      "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": [
            "deal"
          ],
          "operation": [
            "create"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getUsers"
      }
    },
    {
      "displayName": "Primary Contact Name or ID",
      "name": "primaryContact",
      "type": "options",
      "default": "",
      "description": "Primary contact for the deal. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "deal"
          ],
          "operation": [
            "create"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getContacts"
      }
    },
    {
      "displayName": "Pipeline",
      "name": "pipeline",
      "type": "options",
      "default": "",
      "options": [
        {
          "name": "Sales",
          "value": "Sales"
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "deal"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Status",
      "name": "status",
      "type": "options",
      "default": "Open",
      "options": [
        {
          "name": "Open",
          "value": "Open"
        },
        {
          "name": "Close",
          "value": "Close"
        },
        {
          "name": "Lost",
          "value": "Lost"
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "deal"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Stage",
      "name": "stage",
      "type": "options",
      "default": "",
      "options": [
        {
          "name": "New (Untouched)",
          "value": "New (Untouched)"
        },
        {
          "name": "Contacted",
          "value": "Contacted"
        },
        {
          "name": "Qualified",
          "value": "Qualified"
        },
        {
          "name": "In Negotiation",
          "value": "In Negotiation"
        },
        {
          "name": "Proposal Presented",
          "value": "Proposal Presented"
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "deal"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Currency",
      "name": "currency",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "deal"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "RAW Data",
      "name": "rawData",
      "type": "boolean",
      "default": false,
      "description": "Whether the data should include the fields details",
      "displayOptions": {
        "show": {
          "resource": [
            "deal"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Description",
          "name": "description",
          "type": "string",
          "default": "",
          "description": "This field contains details related to the deal"
        },
        {
          "displayName": "Tags",
          "name": "tags",
          "type": "string",
          "default": "",
          "description": "This field contains tags associated with an deal"
        },
        {
          "displayName": "Primary Company Name or ID",
          "name": "primaryCompany",
          "type": "options",
          "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
          "typeOptions": {
            "loadOptionsMethod": "getCompanies"
          },
          "default": ""
        },
        {
          "displayName": "Source",
          "name": "source",
          "type": "options",
          "options": [
            {
              "name": "Ads",
              "value": "Ads"
            },
            {
              "name": "Referrals",
              "value": "Referrals"
            },
            {
              "name": "Website",
              "value": "Website"
            },
            {
              "name": "Word of Mouth",
              "value": "Word of mouth"
            }
          ],
          "default": "Ads"
        },
        {
          "displayName": "Estimated Close Date",
          "name": "estimatedCloseDate",
          "type": "dateTime",
          "default": ""
        },
        {
          "displayName": "Deal Value",
          "name": "dealValue",
          "type": "number",
          "typeOptions": {
            "numberPrecision": 2
          },
          "default": 0
        },
        {
          "displayName": "Priority",
          "name": "priority",
          "type": "options",
          "default": "Medium",
          "options": [
            {
              "name": "High",
              "value": "High"
            },
            {
              "name": "Medium",
              "value": "Medium"
            },
            {
              "name": "Low",
              "value": "Low"
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "deal"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Deal ID",
      "name": "id",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "deal"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "RAW Data",
      "name": "rawData",
      "type": "boolean",
      "default": false,
      "description": "Whether the data should include the fields details",
      "displayOptions": {
        "show": {
          "resource": [
            "deal"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Update Fields",
      "name": "updateFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Title",
          "name": "title",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Owner Name or ID",
          "name": "owner",
          "type": "options",
          "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
          "default": "",
          "typeOptions": {
            "loadOptionsMethod": "getUsers"
          }
        },
        {
          "displayName": "Primary Contact Name or ID",
          "name": "primaryContact",
          "type": "options",
          "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
          "default": "",
          "typeOptions": {
            "loadOptionsMethod": "getContacts"
          }
        },
        {
          "displayName": "Pipeline",
          "name": "pipeline",
          "type": "options",
          "options": [
            {
              "name": "Sales",
              "value": "Sales"
            }
          ],
          "default": ""
        },
        {
          "displayName": "Status",
          "name": "status",
          "type": "options",
          "default": "Open",
          "options": [
            {
              "name": "Open",
              "value": "Open"
            },
            {
              "name": "Close",
              "value": "Close"
            },
            {
              "name": "Lost",
              "value": "Lost"
            }
          ]
        },
        {
          "displayName": "Stage",
          "name": "stage",
          "type": "options",
          "default": "",
          "options": [
            {
              "name": "Contacted",
              "value": "Contacted"
            },
            {
              "name": "In Negotiation",
              "value": "In Negotiation"
            },
            {
              "name": "New (Untouched)",
              "value": "New (Untouched)"
            },
            {
              "name": "Proposal Presented",
              "value": "Proposal Presented"
            },
            {
              "name": "Qualified",
              "value": "Qualified"
            }
          ]
        },
        {
          "displayName": "Currency",
          "name": "currency",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Description",
          "name": "description",
          "type": "string",
          "default": "",
          "description": "This field contains details related to the deal"
        },
        {
          "displayName": "Tags",
          "name": "tags",
          "type": "string",
          "default": "",
          "description": "This field contains tags associated with an deal"
        },
        {
          "displayName": "Primary Company Name or ID",
          "name": "primaryCompany",
          "type": "options",
          "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
          "typeOptions": {
            "loadOptionsMethod": "getCompanies"
          },
          "default": ""
        },
        {
          "displayName": "Source",
          "name": "source",
          "type": "options",
          "options": [
            {
              "name": "Ads",
              "value": "Ads"
            },
            {
              "name": "Referrals",
              "value": "Referrals"
            },
            {
              "name": "Website",
              "value": "Website"
            },
            {
              "name": "Word of Mouth",
              "value": "Word of mouth"
            }
          ],
          "default": "Ads"
        },
        {
          "displayName": "Estimated Close Date",
          "name": "estimatedCloseDate",
          "type": "dateTime",
          "default": ""
        },
        {
          "displayName": "Deal Value",
          "name": "dealValue",
          "type": "number",
          "typeOptions": {
            "numberPrecision": 2
          },
          "default": 0
        },
        {
          "displayName": "Priority",
          "name": "priority",
          "type": "options",
          "default": "Medium",
          "options": [
            {
              "name": "High",
              "value": "High"
            },
            {
              "name": "Medium",
              "value": "Medium"
            },
            {
              "name": "Low",
              "value": "Low"
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "deal"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Deal ID",
      "name": "id",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "deal"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "RAW Data",
      "name": "rawData",
      "type": "boolean",
      "default": false,
      "description": "Whether the data should include the fields details",
      "displayOptions": {
        "show": {
          "resource": [
            "deal"
          ],
          "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": [
            "deal"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 10,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "deal"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 25
      }
    },
    {
      "displayName": "JSON Parameters",
      "name": "jsonParameters",
      "type": "boolean",
      "default": false,
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "deal"
          ]
        }
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Fields",
          "name": "fields",
          "type": "string",
          "default": "",
          "description": "Comma-separated list of fields to return"
        },
        {
          "displayName": "Sort By",
          "name": "sortBy",
          "type": "string",
          "default": "",
          "description": "The field to sort by"
        },
        {
          "displayName": "Sort Order",
          "name": "sortOrder",
          "type": "options",
          "options": [
            {
              "name": "ASC",
              "value": "asc"
            },
            {
              "name": "DESC",
              "value": "desc"
            }
          ],
          "default": "desc"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "deal"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Filters",
      "name": "filtersJson",
      "type": "json",
      "default": "",
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "deal"
          ],
          "jsonParameters": [
            true
          ]
        }
      },
      "typeOptions": {
        "alwaysOpenEditWindow": true
      }
    },
    {
      "displayName": "Filters",
      "name": "filters",
      "type": "fixedCollection",
      "default": {},
      "options": [
        {
          "name": "filtersUi",
          "displayName": "Filters",
          "values": [
            {
              "displayName": "Operator",
              "name": "operator",
              "type": "options",
              "options": [
                {
                  "name": "AND",
                  "value": "AND"
                },
                {
                  "name": "OR",
                  "value": "OR"
                }
              ],
              "default": "AND"
            },
            {
              "displayName": "Conditions",
              "name": "conditions",
              "placeholder": "Add Condition",
              "type": "fixedCollection",
              "typeOptions": {
                "multipleValues": true
              },
              "default": {},
              "options": [
                {
                  "name": "conditionsUi",
                  "displayName": "Conditions",
                  "values": [
                    {
                      "displayName": "Field",
                      "name": "field",
                      "type": "options",
                      "options": [
                        {
                          "name": "Title",
                          "value": "title"
                        },
                        {
                          "name": "Tags",
                          "value": "tags"
                        },
                        {
                          "name": "Last Communication Mode",
                          "value": "lastCommunicationMode"
                        }
                      ],
                      "default": "title"
                    },
                    {
                      "displayName": "Condition",
                      "name": "condition",
                      "type": "options",
                      "options": [
                        {
                          "name": "Equals",
                          "value": "EQUALS"
                        },
                        {
                          "name": "Not Equals",
                          "value": "NOT_EQUALS"
                        },
                        {
                          "name": "CONTAINS",
                          "value": "Contains"
                        },
                        {
                          "name": "Does Not Contains",
                          "value": "DOES_NOT_CONTAINS"
                        },
                        {
                          "name": "Empty",
                          "value": "EMPTY"
                        },
                        {
                          "name": "Not Empty",
                          "value": "NOT_EMPTY"
                        },
                        {
                          "name": "Starts With",
                          "value": "STARTS_WITH"
                        },
                        {
                          "name": "Ends With",
                          "value": "ENDS_WITH"
                        }
                      ],
                      "default": "EQUALS",
                      "description": "Value of the property to set"
                    },
                    {
                      "displayName": "Value",
                      "name": "value",
                      "type": "string",
                      "default": ""
                    }
                  ]
                }
              ]
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "deal"
          ],
          "operation": [
            "getAll"
          ],
          "jsonParameters": [
            false
          ]
        }
      },
      "typeOptions": {
        "multipleValues": false
      }
    },
    {
      "displayName": "Deal ID",
      "name": "id",
      "type": "string",
      "default": "",
      "description": "If more than one deal add them separated by ,",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "deal"
          ],
          "operation": [
            "delete"
          ]
        }
      }
    }
  ]

operations:
  [
    {
      "operation": "create",
      "name": "Create",
      "description": "Create a company",
      "resource": "company"
    },
    {
      "operation": "delete",
      "name": "Delete",
      "description": "Delete a company",
      "resource": "company"
    },
    {
      "operation": "get",
      "name": "Get",
      "description": "Get a company",
      "resource": "company"
    },
    {
      "operation": "getAll",
      "name": "Get Many",
      "description": "Get many companies",
      "resource": "company"
    },
    {
      "operation": "update",
      "name": "Update",
      "description": "Update a company",
      "resource": "company"
    },
    {
      "operation": "create",
      "name": "Create",
      "description": "Create an activity",
      "resource": "activity"
    },
    {
      "operation": "delete",
      "name": "Delete",
      "description": "Delete an activity",
      "resource": "activity"
    },
    {
      "operation": "get",
      "name": "Get",
      "description": "Get an activity",
      "resource": "activity"
    },
    {
      "operation": "getAll",
      "name": "Get Many",
      "description": "Get many companies",
      "resource": "activity"
    },
    {
      "operation": "update",
      "name": "Update",
      "description": "Update an activity",
      "resource": "activity"
    },
    {
      "operation": "create",
      "name": "Create",
      "description": "Create a deal",
      "resource": "deal"
    },
    {
      "operation": "delete",
      "name": "Delete",
      "description": "Delete a deal",
      "resource": "deal"
    },
    {
      "operation": "get",
      "name": "Get",
      "description": "Get a deal",
      "resource": "deal"
    },
    {
      "operation": "getAll",
      "name": "Get Many",
      "description": "Get many deals",
      "resource": "deal"
    },
    {
      "operation": "update",
      "name": "Update",
      "description": "Update a deal",
      "resource": "deal"
    }
  ]


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

outputs:
  [
  "main"
  ]

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

  # Salesmate node

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

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

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

  ## Operations

  * Activity
      * Create an activity
      * Delete an activity
      * Get an activity
      * Get all companies
      * Update an activity
  * Company
      * Create a company
      * Delete a company
      * Get a company
      * Get all companies
      * Update a company
  * Deal
      * Create a deal
      * Delete a deal
      * Get a deal
      * Get all deals
      * Update a deal

  ## Templates and examples

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

properties_schema:
  [
    {
      "displayName": "Resource",
      "name": "resource",
      "type": "options",
      "default": "activity",
      "options": [
        {
          "name": "Activity",
          "value": "activity"
        },
        {
          "name": "Company",
          "value": "company"
        },
        {
          "name": "Deal",
          "value": "deal"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create a company",
          "action": "Create a company"
        },
        {
          "name": "Delete",
          "value": "delete",
          "description": "Delete a company",
          "action": "Delete a company"
        },
        {
          "name": "Get",
          "value": "get",
          "description": "Get a company",
          "action": "Get a company"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get many companies",
          "action": "Get many companies"
        },
        {
          "name": "Update",
          "value": "update",
          "description": "Update a company",
          "action": "Update a company"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "company"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create an activity",
          "action": "Create an activity"
        },
        {
          "name": "Delete",
          "value": "delete",
          "description": "Delete an activity",
          "action": "Delete an activity"
        },
        {
          "name": "Get",
          "value": "get",
          "description": "Get an activity",
          "action": "Get an activity"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get many companies",
          "action": "Get many activities"
        },
        {
          "name": "Update",
          "value": "update",
          "description": "Update an activity",
          "action": "Update an activity"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "activity"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create a deal",
          "action": "Create a deal"
        },
        {
          "name": "Delete",
          "value": "delete",
          "description": "Delete a deal",
          "action": "Delete a deal"
        },
        {
          "name": "Get",
          "value": "get",
          "description": "Get a deal",
          "action": "Get a deal"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get many deals",
          "action": "Get many deals"
        },
        {
          "name": "Update",
          "value": "update",
          "description": "Update a deal",
          "action": "Update a deal"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "deal"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Name",
      "name": "name",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "company"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Owner Name or ID",
      "name": "owner",
      "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": [
            "company"
          ],
          "operation": [
            "create"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getUsers"
      }
    },
    {
      "displayName": "RAW Data",
      "name": "rawData",
      "type": "boolean",
      "default": false,
      "description": "Whether the data should include the fields details",
      "displayOptions": {
        "show": {
          "resource": [
            "company"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Website",
          "name": "website",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Phone",
          "name": "phone",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Other Phone",
          "name": "otherPhone",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Facebook Handle",
          "name": "facebookHandle",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Google Plus Handle",
          "name": "googlePlusHandle",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "LinkedIn Handle",
          "name": "linkedInHandle",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Skype ID",
          "name": "skypeId",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Twitter Handle",
          "name": "twitterHandle",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Currency",
          "name": "currency",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Billing Address Line 1",
          "name": "billingAddressLine1",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Billing Address Line 2",
          "name": "billingAddressLine2",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Billing City",
          "name": "billingCity",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Billing Zip Code",
          "name": "billingZipCode",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Billing State",
          "name": "billingState",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Billing Country",
          "name": "billingState",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Description",
          "name": "description",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Tags",
          "name": "tags",
          "type": "string",
          "default": ""
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "company"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Company ID",
      "name": "id",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "company"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "RAW Data",
      "name": "rawData",
      "type": "boolean",
      "default": false,
      "description": "Whether the data should include the fields details",
      "displayOptions": {
        "show": {
          "resource": [
            "company"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Update Fields",
      "name": "updateFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Name",
          "name": "name",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Owner Name or ID",
          "name": "owner",
          "type": "options",
          "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
          "default": "",
          "typeOptions": {
            "loadOptionsMethod": "getUsers"
          }
        },
        {
          "displayName": "Website",
          "name": "website",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Phone",
          "name": "phone",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Other Phone",
          "name": "otherPhone",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Facebook Handle",
          "name": "facebookHandle",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Google Plus Handle",
          "name": "googlePlusHandle",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "LinkedIn Handle",
          "name": "linkedInHandle",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Skype ID",
          "name": "skypeId",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Twitter Handle",
          "name": "twitterHandle",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Currency",
          "name": "currency",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Billing Address Line 1",
          "name": "billingAddressLine1",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Billing Address Line 2",
          "name": "billingAddressLine2",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Billing City",
          "name": "billingCity",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Billing Zip Code",
          "name": "billingZipCode",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Billing State",
          "name": "billingState",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Billing Country",
          "name": "billingState",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Description",
          "name": "description",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Tags",
          "name": "tags",
          "type": "string",
          "default": ""
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "company"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Company ID",
      "name": "id",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "company"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "RAW Data",
      "name": "rawData",
      "type": "boolean",
      "default": false,
      "description": "Whether the data should include the fields details",
      "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": 10,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "company"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 25
      }
    },
    {
      "displayName": "JSON Parameters",
      "name": "jsonParameters",
      "type": "boolean",
      "default": false,
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "company"
          ]
        }
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Fields",
          "name": "fields",
          "type": "string",
          "default": "",
          "description": "Comma-separated list of fields to return"
        },
        {
          "displayName": "Sort By",
          "name": "sortBy",
          "type": "string",
          "default": "",
          "description": "The field to sort by"
        },
        {
          "displayName": "Sort Order",
          "name": "sortOrder",
          "type": "options",
          "options": [
            {
              "name": "ASC",
              "value": "asc"
            },
            {
              "name": "DESC",
              "value": "desc"
            }
          ],
          "default": "desc"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "company"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Filters",
      "name": "filtersJson",
      "type": "json",
      "default": "",
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "company"
          ],
          "jsonParameters": [
            true
          ]
        }
      },
      "typeOptions": {
        "alwaysOpenEditWindow": true
      }
    },
    {
      "displayName": "Filters",
      "name": "filters",
      "type": "fixedCollection",
      "default": {},
      "options": [
        {
          "name": "filtersUi",
          "displayName": "Filters",
          "values": [
            {
              "displayName": "Operator",
              "name": "operator",
              "type": "options",
              "options": [
                {
                  "name": "AND",
                  "value": "AND"
                },
                {
                  "name": "OR",
                  "value": "OR"
                }
              ],
              "default": "AND"
            },
            {
              "displayName": "Conditions",
              "name": "conditions",
              "placeholder": "Add Condition",
              "type": "fixedCollection",
              "typeOptions": {
                "multipleValues": true
              },
              "default": {},
              "options": [
                {
                  "name": "conditionsUi",
                  "displayName": "Conditions",
                  "values": [
                    {
                      "displayName": "Field",
                      "name": "field",
                      "type": "options",
                      "options": [
                        {
                          "name": "Name",
                          "value": "name"
                        },
                        {
                          "name": "Email",
                          "value": "email"
                        },
                        {
                          "name": "Phone",
                          "value": "phone"
                        }
                      ],
                      "default": "name"
                    },
                    {
                      "displayName": "Condition",
                      "name": "condition",
                      "type": "options",
                      "options": [
                        {
                          "name": "Equals",
                          "value": "EQUALS"
                        },
                        {
                          "name": "Not Equals",
                          "value": "NOT_EQUALS"
                        },
                        {
                          "name": "CONTAINS",
                          "value": "Contains"
                        },
                        {
                          "name": "Does Not Contains",
                          "value": "DOES_NOT_CONTAINS"
                        },
                        {
                          "name": "Empty",
                          "value": "EMPTY"
                        },
                        {
                          "name": "Not Empty",
                          "value": "NOT_EMPTY"
                        },
                        {
                          "name": "Starts With",
                          "value": "STARTS_WITH"
                        },
                        {
                          "name": "Ends With",
                          "value": "ENDS_WITH"
                        }
                      ],
                      "default": "EQUALS",
                      "description": "Value of the property to set"
                    },
                    {
                      "displayName": "Value",
                      "name": "value",
                      "type": "string",
                      "default": ""
                    }
                  ]
                }
              ]
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "company"
          ],
          "operation": [
            "getAll"
          ],
          "jsonParameters": [
            false
          ]
        }
      },
      "typeOptions": {
        "multipleValues": false
      }
    },
    {
      "displayName": "Company ID",
      "name": "id",
      "type": "string",
      "default": "",
      "description": "If more than one company add them separated by ,",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "company"
          ],
          "operation": [
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "Title",
      "name": "title",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "activity"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Owner Name or ID",
      "name": "owner",
      "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": [
            "activity"
          ],
          "operation": [
            "create"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getUsers"
      }
    },
    {
      "displayName": "Type",
      "name": "type",
      "type": "string",
      "default": "",
      "description": "This field displays activity type such as call, meeting etc",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "activity"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "RAW Data",
      "name": "rawData",
      "type": "boolean",
      "default": false,
      "description": "Whether the data should include the fields details",
      "displayOptions": {
        "show": {
          "resource": [
            "activity"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Description",
          "name": "description",
          "type": "string",
          "default": "",
          "description": "This field contains details related to the activity"
        },
        {
          "displayName": "Tags",
          "name": "tags",
          "type": "string",
          "default": "",
          "description": "This field contains tags associated with an activity"
        },
        {
          "displayName": "Due Date",
          "name": "dueDate",
          "type": "dateTime",
          "default": "",
          "description": "Expiry date of an activity"
        },
        {
          "displayName": "Duration",
          "name": "duration",
          "type": "number",
          "default": "",
          "description": "Time duration of an activity"
        },
        {
          "displayName": "Is Calendar Invite",
          "name": "isCalendarInvite",
          "type": "boolean",
          "default": false,
          "description": "Whether to send calendar invite"
        },
        {
          "displayName": "Is Completed",
          "name": "isCompleted",
          "type": "boolean",
          "default": false,
          "description": "Whether the activity is completed or not"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "activity"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Activity ID",
      "name": "id",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "activity"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "RAW Data",
      "name": "rawData",
      "type": "boolean",
      "default": false,
      "description": "Whether the data should include the fields details",
      "displayOptions": {
        "show": {
          "resource": [
            "activity"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Update Fields",
      "name": "updateFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Title",
          "name": "title",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Type",
          "name": "type",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Owner",
          "name": "owner",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Description",
          "name": "description",
          "type": "string",
          "default": "",
          "description": "This field contains details related to the activity"
        },
        {
          "displayName": "Tags",
          "name": "tags",
          "type": "string",
          "default": "",
          "description": "This field contains tags associated with an activity"
        },
        {
          "displayName": "Due Date",
          "name": "dueDate",
          "type": "dateTime",
          "default": "",
          "description": "Expiry date of an activity"
        },
        {
          "displayName": "Duration",
          "name": "duration",
          "type": "number",
          "default": "",
          "description": "Time duration of an activity"
        },
        {
          "displayName": "Is Calendar Invite",
          "name": "isCalendarInvite",
          "type": "boolean",
          "default": false,
          "description": "Whether to send calendar invite"
        },
        {
          "displayName": "Is Completed",
          "name": "isCompleted",
          "type": "boolean",
          "default": false,
          "description": "Whether the activity is completed or not"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "activity"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Activity ID",
      "name": "id",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "activity"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "RAW Data",
      "name": "rawData",
      "type": "boolean",
      "default": false,
      "description": "Whether the data should include the fields details",
      "displayOptions": {
        "show": {
          "resource": [
            "activity"
          ],
          "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": [
            "activity"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 10,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "activity"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 25
      }
    },
    {
      "displayName": "JSON Parameters",
      "name": "jsonParameters",
      "type": "boolean",
      "default": false,
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "activity"
          ]
        }
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Fields",
          "name": "fields",
          "type": "string",
          "default": "",
          "description": "Comma-separated list of fields to return"
        },
        {
          "displayName": "Sort By",
          "name": "sortBy",
          "type": "string",
          "default": "",
          "description": "The field to sort by"
        },
        {
          "displayName": "Sort Order",
          "name": "sortOrder",
          "type": "options",
          "options": [
            {
              "name": "ASC",
              "value": "asc"
            },
            {
              "name": "DESC",
              "value": "desc"
            }
          ],
          "default": "desc"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "activity"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Filters",
      "name": "filtersJson",
      "type": "json",
      "default": "",
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "activity"
          ],
          "jsonParameters": [
            true
          ]
        }
      },
      "typeOptions": {
        "alwaysOpenEditWindow": true
      }
    },
    {
      "displayName": "Filters",
      "name": "filters",
      "type": "fixedCollection",
      "default": {},
      "options": [
        {
          "name": "filtersUi",
          "displayName": "Filters",
          "values": [
            {
              "displayName": "Operator",
              "name": "operator",
              "type": "options",
              "options": [
                {
                  "name": "AND",
                  "value": "AND"
                },
                {
                  "name": "OR",
                  "value": "OR"
                }
              ],
              "default": "AND"
            },
            {
              "displayName": "Conditions",
              "name": "conditions",
              "placeholder": "Add Condition",
              "type": "fixedCollection",
              "typeOptions": {
                "multipleValues": true
              },
              "default": {},
              "options": [
                {
                  "name": "conditionsUi",
                  "displayName": "Conditions",
                  "values": [
                    {
                      "displayName": "Field",
                      "name": "field",
                      "type": "options",
                      "options": [
                        {
                          "name": "Title",
                          "value": "title"
                        },
                        {
                          "name": "Tags",
                          "value": "tags"
                        }
                      ],
                      "default": "title"
                    },
                    {
                      "displayName": "Condition",
                      "name": "condition",
                      "type": "options",
                      "options": [
                        {
                          "name": "Equals",
                          "value": "EQUALS"
                        },
                        {
                          "name": "Not Equals",
                          "value": "NOT_EQUALS"
                        },
                        {
                          "name": "CONTAINS",
                          "value": "Contains"
                        },
                        {
                          "name": "Does Not Contains",
                          "value": "DOES_NOT_CONTAINS"
                        },
                        {
                          "name": "Empty",
                          "value": "EMPTY"
                        },
                        {
                          "name": "Not Empty",
                          "value": "NOT_EMPTY"
                        },
                        {
                          "name": "Starts With",
                          "value": "STARTS_WITH"
                        },
                        {
                          "name": "Ends With",
                          "value": "ENDS_WITH"
                        }
                      ],
                      "default": "EQUALS",
                      "description": "Value of the property to set"
                    },
                    {
                      "displayName": "Value",
                      "name": "value",
                      "type": "string",
                      "default": ""
                    }
                  ]
                }
              ]
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "activity"
          ],
          "operation": [
            "getAll"
          ],
          "jsonParameters": [
            false
          ]
        }
      },
      "typeOptions": {
        "multipleValues": false
      }
    },
    {
      "displayName": "Activity ID",
      "name": "id",
      "type": "string",
      "default": "",
      "description": "If more than one activity add them separated by ,",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "activity"
          ],
          "operation": [
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "Title",
      "name": "title",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "deal"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Owner Name or ID",
      "name": "owner",
      "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": [
            "deal"
          ],
          "operation": [
            "create"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getUsers"
      }
    },
    {
      "displayName": "Primary Contact Name or ID",
      "name": "primaryContact",
      "type": "options",
      "default": "",
      "description": "Primary contact for the deal. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "deal"
          ],
          "operation": [
            "create"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getContacts"
      }
    },
    {
      "displayName": "Pipeline",
      "name": "pipeline",
      "type": "options",
      "default": "",
      "options": [
        {
          "name": "Sales",
          "value": "Sales"
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "deal"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Status",
      "name": "status",
      "type": "options",
      "default": "Open",
      "options": [
        {
          "name": "Open",
          "value": "Open"
        },
        {
          "name": "Close",
          "value": "Close"
        },
        {
          "name": "Lost",
          "value": "Lost"
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "deal"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Stage",
      "name": "stage",
      "type": "options",
      "default": "",
      "options": [
        {
          "name": "New (Untouched)",
          "value": "New (Untouched)"
        },
        {
          "name": "Contacted",
          "value": "Contacted"
        },
        {
          "name": "Qualified",
          "value": "Qualified"
        },
        {
          "name": "In Negotiation",
          "value": "In Negotiation"
        },
        {
          "name": "Proposal Presented",
          "value": "Proposal Presented"
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "deal"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Currency",
      "name": "currency",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "deal"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "RAW Data",
      "name": "rawData",
      "type": "boolean",
      "default": false,
      "description": "Whether the data should include the fields details",
      "displayOptions": {
        "show": {
          "resource": [
            "deal"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Description",
          "name": "description",
          "type": "string",
          "default": "",
          "description": "This field contains details related to the deal"
        },
        {
          "displayName": "Tags",
          "name": "tags",
          "type": "string",
          "default": "",
          "description": "This field contains tags associated with an deal"
        },
        {
          "displayName": "Primary Company Name or ID",
          "name": "primaryCompany",
          "type": "options",
          "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
          "typeOptions": {
            "loadOptionsMethod": "getCompanies"
          },
          "default": ""
        },
        {
          "displayName": "Source",
          "name": "source",
          "type": "options",
          "options": [
            {
              "name": "Ads",
              "value": "Ads"
            },
            {
              "name": "Referrals",
              "value": "Referrals"
            },
            {
              "name": "Website",
              "value": "Website"
            },
            {
              "name": "Word of Mouth",
              "value": "Word of mouth"
            }
          ],
          "default": "Ads"
        },
        {
          "displayName": "Estimated Close Date",
          "name": "estimatedCloseDate",
          "type": "dateTime",
          "default": ""
        },
        {
          "displayName": "Deal Value",
          "name": "dealValue",
          "type": "number",
          "typeOptions": {
            "numberPrecision": 2
          },
          "default": 0
        },
        {
          "displayName": "Priority",
          "name": "priority",
          "type": "options",
          "default": "Medium",
          "options": [
            {
              "name": "High",
              "value": "High"
            },
            {
              "name": "Medium",
              "value": "Medium"
            },
            {
              "name": "Low",
              "value": "Low"
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "deal"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Deal ID",
      "name": "id",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "deal"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "RAW Data",
      "name": "rawData",
      "type": "boolean",
      "default": false,
      "description": "Whether the data should include the fields details",
      "displayOptions": {
        "show": {
          "resource": [
            "deal"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Update Fields",
      "name": "updateFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Title",
          "name": "title",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Owner Name or ID",
          "name": "owner",
          "type": "options",
          "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
          "default": "",
          "typeOptions": {
            "loadOptionsMethod": "getUsers"
          }
        },
        {
          "displayName": "Primary Contact Name or ID",
          "name": "primaryContact",
          "type": "options",
          "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
          "default": "",
          "typeOptions": {
            "loadOptionsMethod": "getContacts"
          }
        },
        {
          "displayName": "Pipeline",
          "name": "pipeline",
          "type": "options",
          "options": [
            {
              "name": "Sales",
              "value": "Sales"
            }
          ],
          "default": ""
        },
        {
          "displayName": "Status",
          "name": "status",
          "type": "options",
          "default": "Open",
          "options": [
            {
              "name": "Open",
              "value": "Open"
            },
            {
              "name": "Close",
              "value": "Close"
            },
            {
              "name": "Lost",
              "value": "Lost"
            }
          ]
        },
        {
          "displayName": "Stage",
          "name": "stage",
          "type": "options",
          "default": "",
          "options": [
            {
              "name": "Contacted",
              "value": "Contacted"
            },
            {
              "name": "In Negotiation",
              "value": "In Negotiation"
            },
            {
              "name": "New (Untouched)",
              "value": "New (Untouched)"
            },
            {
              "name": "Proposal Presented",
              "value": "Proposal Presented"
            },
            {
              "name": "Qualified",
              "value": "Qualified"
            }
          ]
        },
        {
          "displayName": "Currency",
          "name": "currency",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Description",
          "name": "description",
          "type": "string",
          "default": "",
          "description": "This field contains details related to the deal"
        },
        {
          "displayName": "Tags",
          "name": "tags",
          "type": "string",
          "default": "",
          "description": "This field contains tags associated with an deal"
        },
        {
          "displayName": "Primary Company Name or ID",
          "name": "primaryCompany",
          "type": "options",
          "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
          "typeOptions": {
            "loadOptionsMethod": "getCompanies"
          },
          "default": ""
        },
        {
          "displayName": "Source",
          "name": "source",
          "type": "options",
          "options": [
            {
              "name": "Ads",
              "value": "Ads"
            },
            {
              "name": "Referrals",
              "value": "Referrals"
            },
            {
              "name": "Website",
              "value": "Website"
            },
            {
              "name": "Word of Mouth",
              "value": "Word of mouth"
            }
          ],
          "default": "Ads"
        },
        {
          "displayName": "Estimated Close Date",
          "name": "estimatedCloseDate",
          "type": "dateTime",
          "default": ""
        },
        {
          "displayName": "Deal Value",
          "name": "dealValue",
          "type": "number",
          "typeOptions": {
            "numberPrecision": 2
          },
          "default": 0
        },
        {
          "displayName": "Priority",
          "name": "priority",
          "type": "options",
          "default": "Medium",
          "options": [
            {
              "name": "High",
              "value": "High"
            },
            {
              "name": "Medium",
              "value": "Medium"
            },
            {
              "name": "Low",
              "value": "Low"
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "deal"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Deal ID",
      "name": "id",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "deal"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "RAW Data",
      "name": "rawData",
      "type": "boolean",
      "default": false,
      "description": "Whether the data should include the fields details",
      "displayOptions": {
        "show": {
          "resource": [
            "deal"
          ],
          "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": [
            "deal"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 10,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "deal"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 25
      }
    },
    {
      "displayName": "JSON Parameters",
      "name": "jsonParameters",
      "type": "boolean",
      "default": false,
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "deal"
          ]
        }
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Fields",
          "name": "fields",
          "type": "string",
          "default": "",
          "description": "Comma-separated list of fields to return"
        },
        {
          "displayName": "Sort By",
          "name": "sortBy",
          "type": "string",
          "default": "",
          "description": "The field to sort by"
        },
        {
          "displayName": "Sort Order",
          "name": "sortOrder",
          "type": "options",
          "options": [
            {
              "name": "ASC",
              "value": "asc"
            },
            {
              "name": "DESC",
              "value": "desc"
            }
          ],
          "default": "desc"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "deal"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Filters",
      "name": "filtersJson",
      "type": "json",
      "default": "",
      "displayOptions": {
        "show": {
          "operation": [
            "getAll"
          ],
          "resource": [
            "deal"
          ],
          "jsonParameters": [
            true
          ]
        }
      },
      "typeOptions": {
        "alwaysOpenEditWindow": true
      }
    },
    {
      "displayName": "Filters",
      "name": "filters",
      "type": "fixedCollection",
      "default": {},
      "options": [
        {
          "name": "filtersUi",
          "displayName": "Filters",
          "values": [
            {
              "displayName": "Operator",
              "name": "operator",
              "type": "options",
              "options": [
                {
                  "name": "AND",
                  "value": "AND"
                },
                {
                  "name": "OR",
                  "value": "OR"
                }
              ],
              "default": "AND"
            },
            {
              "displayName": "Conditions",
              "name": "conditions",
              "placeholder": "Add Condition",
              "type": "fixedCollection",
              "typeOptions": {
                "multipleValues": true
              },
              "default": {},
              "options": [
                {
                  "name": "conditionsUi",
                  "displayName": "Conditions",
                  "values": [
                    {
                      "displayName": "Field",
                      "name": "field",
                      "type": "options",
                      "options": [
                        {
                          "name": "Title",
                          "value": "title"
                        },
                        {
                          "name": "Tags",
                          "value": "tags"
                        },
                        {
                          "name": "Last Communication Mode",
                          "value": "lastCommunicationMode"
                        }
                      ],
                      "default": "title"
                    },
                    {
                      "displayName": "Condition",
                      "name": "condition",
                      "type": "options",
                      "options": [
                        {
                          "name": "Equals",
                          "value": "EQUALS"
                        },
                        {
                          "name": "Not Equals",
                          "value": "NOT_EQUALS"
                        },
                        {
                          "name": "CONTAINS",
                          "value": "Contains"
                        },
                        {
                          "name": "Does Not Contains",
                          "value": "DOES_NOT_CONTAINS"
                        },
                        {
                          "name": "Empty",
                          "value": "EMPTY"
                        },
                        {
                          "name": "Not Empty",
                          "value": "NOT_EMPTY"
                        },
                        {
                          "name": "Starts With",
                          "value": "STARTS_WITH"
                        },
                        {
                          "name": "Ends With",
                          "value": "ENDS_WITH"
                        }
                      ],
                      "default": "EQUALS",
                      "description": "Value of the property to set"
                    },
                    {
                      "displayName": "Value",
                      "name": "value",
                      "type": "string",
                      "default": ""
                    }
                  ]
                }
              ]
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "deal"
          ],
          "operation": [
            "getAll"
          ],
          "jsonParameters": [
            false
          ]
        }
      },
      "typeOptions": {
        "multipleValues": false
      }
    },
    {
      "displayName": "Deal ID",
      "name": "id",
      "type": "string",
      "default": "",
      "description": "If more than one deal add them separated by ,",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "deal"
          ],
          "operation": [
            "delete"
          ]
        }
      }
    }
  ]

operations:
  [
    {
      "operation": "create",
      "name": "Create",
      "description": "Create a company",
      "resource": "company"
    },
    {
      "operation": "delete",
      "name": "Delete",
      "description": "Delete a company",
      "resource": "company"
    },
    {
      "operation": "get",
      "name": "Get",
      "description": "Get a company",
      "resource": "company"
    },
    {
      "operation": "getAll",
      "name": "Get Many",
      "description": "Get many companies",
      "resource": "company"
    },
    {
      "operation": "update",
      "name": "Update",
      "description": "Update a company",
      "resource": "company"
    },
    {
      "operation": "create",
      "name": "Create",
      "description": "Create an activity",
      "resource": "activity"
    },
    {
      "operation": "delete",
      "name": "Delete",
      "description": "Delete an activity",
      "resource": "activity"
    },
    {
      "operation": "get",
      "name": "Get",
      "description": "Get an activity",
      "resource": "activity"
    },
    {
      "operation": "getAll",
      "name": "Get Many",
      "description": "Get many companies",
      "resource": "activity"
    },
    {
      "operation": "update",
      "name": "Update",
      "description": "Update an activity",
      "resource": "activity"
    },
    {
      "operation": "create",
      "name": "Create",
      "description": "Create a deal",
      "resource": "deal"
    },
    {
      "operation": "delete",
      "name": "Delete",
      "description": "Delete a deal",
      "resource": "deal"
    },
    {
      "operation": "get",
      "name": "Get",
      "description": "Get a deal",
      "resource": "deal"
    },
    {
      "operation": "getAll",
      "name": "Get Many",
      "description": "Get many deals",
      "resource": "deal"
    },
    {
      "operation": "update",
      "name": "Update",
      "description": "Update a deal",
      "resource": "deal"
    }
  ]


node_type: nodes-base.scheduleTrigger
package_name: n8n-nodes-base
display_name: Schedule Trigger
description: Triggers the workflow on a given schedule
category: trigger
development_style: programmatic
version: 1.3
operations: []
credentials_required: []
outputs:
  [
  "main"
  ]

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

  # Schedule Trigger node

  Use the Schedule Trigger node to run workflows at fixed intervals and times. This works in a similar way to the Cron software utility in Unix-like systems.

  /// note | You must activate the workflow
  If a workflow uses the Schedule node as a trigger, make sure that you save and activate the workflow. 
  ///

  --8<-- "_snippets/integrations/builtin/core-nodes/schedule/timezone-settings.md"

  ## Node parameters

  Add **Trigger Rules** to determine when the trigger should run.

  Use the **Trigger Interval** to select the time interval unit of measure to schedule the trigger for. All other parameters depend on the interval you select. Choose from:

  - [Seconds trigger interval](#seconds-trigger-interval)
  - [Minutes trigger interval](#minutes-trigger-interval)
  - [Hours trigger interval](#hours-trigger-interval)
  - [Days trigger interval](#days-trigger-interval)
  - [Weeks trigger interval](#weeks-trigger-interval)
  - [Months trigger interval](#months-trigger-interval)
  - [Custom (Cron) interval](#custom-cron-interval)

  You can add multiple **Trigger Rules** to run the node on different schedules.

  Refer to the sections below for more detail on configuring each **Trigger Interval**. Refer to [Templates and examples](#templates-and-examples) for further examples.

  ### Seconds trigger interval

  * **Seconds Between Triggers**: Enter the number of seconds between each workflow trigger. For example, if you enter `30` here, the trigger will run every 30 seconds.

  ### Minutes trigger interval

  * **Minutes Between Triggers**: Enter the number of minutes between each workflow trigger. For example, if you enter `5` here, the trigger will run every 5 minutes.

  ### Hours trigger interval

  * **Hours Between Triggers**: Enter the number of hours between each workflow trigger.
  * **Trigger at Minute**: Enter the minute past the hour to trigger the node when it runs, from `0` to `59`.

  For example, if you enter `6` **Hours Between Triggers** and `30` **Trigger at Minute**, the node will run every six hours at 30 minutes past the hour.

  ### Days trigger interval

  * **Days Between Triggers**: Enter the number of days between each workflow trigger.
  * **Trigger at Hour**: Select the hour of the day to trigger the node.
  * **Trigger at Minute**: Enter the minute past the hour to trigger the node when it runs, from `0` to `59`.

  <!-- vale from-microsoft.AMPM = NO -->
  For example, if you enter `2` **Days Between Triggers**, **9am** for **Trigger at Hour**, and `15` **Trigger at Minute**, the node will run every two days at 9:15am.
  <!-- vale from-microsoft.AMPM = YES -->

  ### Weeks trigger interval

  * **Weeks Between Triggers**: Enter the number of weeks between each workflow trigger.
  * **Trigger on Weekdays**: Select the day(s) of the week you want to trigger the node.
  * **Trigger at Hour**: Select the hour of the day to trigger the node.
  * **Trigger at Minute**: Enter the minute past the hour to trigger the node when it runs, from `0` to `59`.

  For example, if you enter `2` **Weeks Between Triggers**, **Monday** for **Trigger on Weekdays**, **3pm** for **Trigger at Hour**, and `30` **Trigger at Minute**, the node will run every two weeks on Monday at 3:30 PM.

  ### Months trigger interval

  * **Months Between Triggers**: Enter the number of months between each workflow trigger.
  * **Trigger at Day of Month**: Enter the day of the month the day should trigger at, from `1` to `31`. If a month doesn't have this day, the node won't trigger. For example, if you enter `30` here, the node won't trigger in February.
  * **Trigger at Hour**: Select the hour of the day to trigger the node.
  * **Trigger at Minute**: Enter the minute past the hour to trigger the node when it runs, from `0` to `59`.

  For example, if you enter `3` **Months Between Triggers**, `28` **Trigger at Day of Month**, **9am** for **Trigger at Hour**, and `0` **Trigger at Minute**, the node will run each quarter on the 28th day of the month at 9:00 AM.

  ### Custom (Cron) interval

  Enter a custom cron **Expression** to set the schedule for the trigger.

  To generate a Cron expression, you can use [crontab guru](https://crontab.guru){:target=_blank .external-link}. Paste the Cron expression that you generated using crontab guru in the **Expression** field in n8n.

  #### Examples

  <!-- vale from-write-good.Weasel = NO -->
  |Type|Cron Expression|Description|
  |---|---|---|
  |Every X Seconds|`*/10 * * * * *`|Every 10 seconds.|
  |Every X Minutes|`*/5 * * * *`|Every 5 minutes.|
  |Hourly|`0 * * * *`|Every hour on the hour.|
  |Daily|`0 6 * * *`|At 6:00 AM every day.|
  |Weekly|`0 12 * * 1`|At noon every Monday.|
  |Monthly|`0 0 1 * *`|At midnight on the 1st of every month.|
  |Every X Days|`0 0 */3 * *`|At midnight every 3rd day.|
  |Only Weekdays|`0 9 * * 1-5`|At 9:00 AM Monday through Friday.|
  |Custom Hourly Range|`0 9-17 * * *`|Every hour from 9:00 AM to 5:00 PM every day.|
  |Quarterly|`0 0 1 1,4,7,10 *`|At midnight on the 1st of January, April, July, and October.|
  <!-- vale from-write-good.Weasel = YES -->

  /// warning | Using variables in the Cron expression
  While variables can be used in the scheduled trigger, their values only get evaluated when the workflow is activated. If you alter a variable's value in the settings after a workflow is activated, the changes won't alter the cron schedule. To re-evaluate the variable, set the workflow to **Inactive** and then back to **Active** again
  /// 

  #### Why there are six asterisks in the Cron expression

  The sixth asterisk in the Cron expression represents seconds. Setting this is optional. The node will execute even if you don't set the value for seconds.

  |  (*)  |  *  |  *  |  *  |  *  |  *  |
  |:--:|:--:|:--:|:--:|:--:|:--:|
  |(second)|minute|hour|day of month|month|day of week(Sun-Sat)|

  ## Templates and examples

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

  ## Common issues

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

properties_schema:
  [
    {
      "displayName": "This workflow will run on the schedule you define here once you publish 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 Rules",
      "name": "rule",
      "type": "fixedCollection",
      "default": {
        "interval": [
          {
            "field": "days"
          }
        ]
      },
      "options": [
        {
          "name": "interval",
          "displayName": "Trigger Interval",
          "builderHint": {
            "message": "You can add multiple intervals to trigger at different times. Use \"Custom (Cron)\" for more specific scheduling patterns."
          },
          "values": [
            {
              "displayName": "Trigger Interval",
              "name": "field",
              "type": "options",
              "default": "days",
              "options": [
                {
                  "name": "Seconds",
                  "value": "seconds"
                },
                {
                  "name": "Minutes",
                  "value": "minutes"
                },
                {
                  "name": "Hours",
                  "value": "hours"
                },
                {
                  "name": "Days",
                  "value": "days"
                },
                {
                  "name": "Weeks",
                  "value": "weeks"
                },
                {
                  "name": "Months",
                  "value": "months"
                },
                {
                  "name": "Custom (Cron)",
                  "value": "cronExpression"
                }
              ]
            },
            {
              "displayName": "Seconds Between Triggers",
              "name": "secondsInterval",
              "type": "number",
              "default": 30,
              "displayOptions": {
                "show": {
                  "field": [
                    "seconds"
                  ]
                }
              },
              "description": "Number of seconds between each workflow trigger",
              "hint": "Must be in range 1-59"
            },
            {
              "displayName": "Minutes Between Triggers",
              "name": "minutesInterval",
              "type": "number",
              "default": 5,
              "displayOptions": {
                "show": {
                  "field": [
                    "minutes"
                  ]
                }
              },
              "description": "Number of minutes between each workflow trigger",
              "hint": "Must be in range 1-59"
            },
            {
              "displayName": "Hours Between Triggers",
              "name": "hoursInterval",
              "type": "number",
              "displayOptions": {
                "show": {
                  "field": [
                    "hours"
                  ]
                }
              },
              "default": 1,
              "description": "Number of hours between each workflow trigger",
              "hint": "Must be in range 1-23"
            },
            {
              "displayName": "Days Between Triggers",
              "name": "daysInterval",
              "type": "number",
              "displayOptions": {
                "show": {
                  "field": [
                    "days"
                  ]
                }
              },
              "default": 1,
              "description": "Number of days between each workflow trigger",
              "hint": "Must be in range 1-31"
            },
            {
              "displayName": "Weeks Between Triggers",
              "name": "weeksInterval",
              "type": "number",
              "displayOptions": {
                "show": {
                  "field": [
                    "weeks"
                  ]
                }
              },
              "default": 1,
              "description": "Would run every week unless specified otherwise"
            },
            {
              "displayName": "Months Between Triggers",
              "name": "monthsInterval",
              "type": "number",
              "displayOptions": {
                "show": {
                  "field": [
                    "months"
                  ]
                }
              },
              "default": 1,
              "description": "Would run every month unless specified otherwise"
            },
            {
              "displayName": "Trigger at Day of Month",
              "name": "triggerAtDayOfMonth",
              "type": "number",
              "displayOptions": {
                "show": {
                  "field": [
                    "months"
                  ]
                }
              },
              "typeOptions": {
                "minValue": 1,
                "maxValue": 31
              },
              "default": 1,
              "description": "The day of the month to trigger (1-31)",
              "hint": "If a month doesn’t have this day, the node won’t trigger"
            },
            {
              "displayName": "Trigger on Weekdays",
              "name": "triggerAtDay",
              "type": "multiOptions",
              "displayOptions": {
                "show": {
                  "field": [
                    "weeks"
                  ]
                }
              },
              "typeOptions": {
                "maxValue": 7
              },
              "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": [
                0
              ]
            },
            {
              "displayName": "Trigger at Hour",
              "name": "triggerAtHour",
              "type": "options",
              "default": 0,
              "displayOptions": {
                "show": {
                  "field": [
                    "days",
                    "weeks",
                    "months"
                  ]
                }
              },
              "options": [
                {
                  "name": "Midnight",
                  "displayName": "Midnight",
                  "value": 0
                },
                {
                  "name": "1am",
                  "displayName": "1am",
                  "value": 1
                },
                {
                  "name": "2am",
                  "displayName": "2am",
                  "value": 2
                },
                {
                  "name": "3am",
                  "displayName": "3am",
                  "value": 3
                },
                {
                  "name": "4am",
                  "displayName": "4am",
                  "value": 4
                },
                {
                  "name": "5am",
                  "displayName": "5am",
                  "value": 5
                },
                {
                  "name": "6am",
                  "displayName": "6am",
                  "value": 6
                },
                {
                  "name": "7am",
                  "displayName": "7am",
                  "value": 7
                },
                {
                  "name": "8am",
                  "displayName": "8am",
                  "value": 8
                },
                {
                  "name": "9am",
                  "displayName": "9am",
                  "value": 9
                },
                {
                  "name": "10am",
                  "displayName": "10am",
                  "value": 10
                },
                {
                  "name": "11am",
                  "displayName": "11am",
                  "value": 11
                },
                {
                  "name": "Noon",
                  "displayName": "Noon",
                  "value": 12
                },
                {
                  "name": "1pm",
                  "displayName": "1pm",
                  "value": 13
                },
                {
                  "name": "2pm",
                  "displayName": "2pm",
                  "value": 14
                },
                {
                  "name": "3pm",
                  "displayName": "3pm",
                  "value": 15
                },
                {
                  "name": "4pm",
                  "displayName": "4pm",
                  "value": 16
                },
                {
                  "name": "5pm",
                  "displayName": "5pm",
                  "value": 17
                },
                {
                  "name": "6pm",
                  "displayName": "6pm",
                  "value": 18
                },
                {
                  "name": "7pm",
                  "displayName": "7pm",
                  "value": 19
                },
                {
                  "name": "8pm",
                  "displayName": "8pm",
                  "value": 20
                },
                {
                  "name": "9pm",
                  "displayName": "9pm",
                  "value": 21
                },
                {
                  "name": "10pm",
                  "displayName": "10pm",
                  "value": 22
                },
                {
                  "name": "11pm",
                  "displayName": "11pm",
                  "value": 23
                }
              ],
              "description": "The hour of the day to trigger"
            },
            {
              "displayName": "Trigger at Minute",
              "name": "triggerAtMinute",
              "type": "number",
              "default": 0,
              "displayOptions": {
                "show": {
                  "field": [
                    "hours",
                    "days",
                    "weeks",
                    "months"
                  ]
                }
              },
              "typeOptions": {
                "minValue": 0,
                "maxValue": 59
              },
              "description": "The minute past the hour to trigger (0-59)"
            },
            {
              "displayName": "You can find help generating your cron expression <a href=\"https://crontab.guru/examples.html\" target=\"_blank\">here</a>",
              "name": "notice",
              "type": "notice",
              "displayOptions": {
                "show": {
                  "field": [
                    "cronExpression"
                  ]
                }
              },
              "default": ""
            },
            {
              "displayName": "Expression",
              "name": "expression",
              "type": "string",
              "default": "",
              "placeholder": "eg. 0 15 * 1 sun",
              "displayOptions": {
                "show": {
                  "field": [
                    "cronExpression"
                  ]
                }
              },
              "hint": "Format: [Second] [Minute] [Hour] [Day of Month] [Month] [Day of Week]"
            }
          ]
        }
      ],
      "typeOptions": {
        "multipleValues": true
      }
    }
  ]


node_type: nodes-base.seaTableTool
package_name: n8n-nodes-base
display_name: SeaTable Tool
description: Read, update, write and delete data from SeaTable (AI Tool variant for use with AI Agents)
category: output
development_style: programmatic
version: 2
credentials_required:
  [
  {
  "name": "seaTableApi",
  "required": true
  }
  ]

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

output_names:
  [
  "Tool"
  ]

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

  # SeaTable node

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

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

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

  ## Operations

  * Row
      * Create
      * Delete
      * Get
      * Get All
      * Update

  ## Templates and examples

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

properties_schema:
  [
    {
      "displayName": "Tool Description",
      "name": "toolDescription",
      "type": "string",
      "default": "",
      "required": false,
      "description": "Description for the AI to understand what this tool does and when to use it",
      "typeOptions": {
        "rows": 3
      },
      "placeholder": "e.g., Use this tool to interact with SeaTable"
    },
    {
      "displayName": "Resource",
      "name": "resource",
      "type": "options",
      "default": "row",
      "options": [
        {
          "name": "Row",
          "value": "row"
        },
        {
          "name": "Base",
          "value": "base"
        },
        {
          "name": "Link",
          "value": "link"
        },
        {
          "name": "Asset",
          "value": "asset"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create a new row",
          "action": "Create a row"
        },
        {
          "name": "Delete",
          "value": "remove",
          "description": "Delete a row",
          "action": "Delete a row"
        },
        {
          "name": "Get",
          "value": "get",
          "description": "Get the content of a row",
          "action": "Get a row"
        },
        {
          "name": "Get Many",
          "value": "list",
          "description": "Get many rows from a table or a table view",
          "action": "Get many rows"
        },
        {
          "name": "Lock",
          "value": "lock",
          "description": "Lock a row to prevent further changes",
          "action": "Add a row lock"
        },
        {
          "name": "Search",
          "value": "search",
          "description": "Search one or multiple rows",
          "action": "Search a row by keyword"
        },
        {
          "name": "Unlock",
          "value": "unlock",
          "description": "Remove the lock from a row",
          "action": "Remove a row lock"
        },
        {
          "name": "Update",
          "value": "update",
          "description": "Update the content of a row",
          "action": "Update a row"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "row"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Table Name",
      "name": "tableName",
      "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": [
            "row"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getTableNames"
      }
    },
    {
      "displayName": "Row ID",
      "name": "rowId",
      "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": [
            "row"
          ]
        },
        "hide": {
          "operation": [
            "create",
            "list",
            "search"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsDependsOn": [
          "tableName"
        ],
        "loadOptionsMethod": "getRowIds"
      }
    },
    {
      "displayName": "Data to Send",
      "name": "fieldsToSend",
      "type": "options",
      "default": "defineBelow",
      "description": "Whether to insert the input data this node receives in the new row",
      "options": [
        {
          "name": "Auto-Map Input Data to Columns",
          "value": "autoMapInputData",
          "description": "Use when node input properties match destination column names"
        },
        {
          "name": "Define Below for Each Column",
          "value": "defineBelow",
          "description": "Set the value for each destination column"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "row"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Apply Column Default Values",
      "name": "apply_default",
      "type": "boolean",
      "default": false,
      "description": "Whether to use the column default values to populate new rows during creation (only available for normal backend)",
      "displayOptions": {
        "show": {
          "bigdata": [
            false
          ],
          "resource": [
            "row"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "In this mode, make sure the incoming data fields are named the same as the columns in SeaTable. (Use an \"Edit Fields\" node before this node to change them if required.)",
      "name": "notice",
      "type": "notice",
      "default": "",
      "displayOptions": {
        "show": {
          "/fieldsToSend": [
            "autoMapInputData"
          ],
          "resource": [
            "row"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Inputs to Ignore",
      "name": "inputsToIgnore",
      "type": "string",
      "default": "",
      "description": "List of input properties to avoid sending, separated by commas. Leave empty to send all properties.",
      "displayOptions": {
        "show": {
          "/fieldsToSend": [
            "autoMapInputData"
          ],
          "resource": [
            "row"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Columns to Send",
      "name": "columnsUi",
      "type": "fixedCollection",
      "default": {},
      "description": "Add destination column with its value. Provide the value in this way. Date: YYYY-MM-DD or YYYY-MM-DD hh:mm. Duration: time in seconds. Checkbox: true, on or 1. Multi-Select: comma-separated list.",
      "options": [
        {
          "displayName": "Column",
          "name": "columnValues",
          "values": [
            {
              "displayName": "Column Name or ID",
              "name": "columnName",
              "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": [
                  "tableName"
                ],
                "loadOptionsMethod": "getTableUpdateAbleColumns"
              },
              "default": ""
            },
            {
              "displayName": "Column Value",
              "name": "columnValue",
              "type": "string",
              "default": ""
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "/fieldsToSend": [
            "defineBelow"
          ],
          "resource": [
            "row"
          ],
          "operation": [
            "create"
          ]
        }
      },
      "typeOptions": {
        "multipleValueButtonText": "Add Column to Send",
        "multipleValues": true
      }
    },
    {
      "displayName": "Save to \"Big Data\" Backend",
      "name": "bigdata",
      "type": "boolean",
      "default": false,
      "description": "Whether write to Big Data backend (true) or not (false). True requires the activation of the Big Data backend in the base.",
      "displayOptions": {
        "show": {
          "resource": [
            "row"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Hint: Link, files, images or digital signatures have to be added separately. These column types cannot be set with this node.",
      "name": "notice",
      "type": "notice",
      "default": "",
      "displayOptions": {
        "show": {
          "resource": [
            "row"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Simplify",
          "name": "simple",
          "type": "boolean",
          "default": true,
          "description": "Whether to return a simplified version of the response instead of the raw data"
        },
        {
          "displayName": "Return Column Names",
          "name": "convert",
          "type": "boolean",
          "default": true,
          "description": "Whether to return the column keys (false) or the column names (true)"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "row"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "View Name",
      "name": "viewName",
      "type": "options",
      "default": "",
      "description": "The name of SeaTable view to access, or specify by using an expression. Provide it in the way \"col.name:::col.type\".",
      "displayOptions": {
        "show": {
          "resource": [
            "row"
          ],
          "operation": [
            "list"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsDependsOn": [
          "tableName"
        ],
        "loadOptionsMethod": "getTableViews"
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Simplify",
          "name": "simple",
          "type": "boolean",
          "default": true,
          "description": "Whether to return a simplified version of the response instead of the raw data"
        },
        {
          "displayName": "Return Column Names",
          "name": "convert",
          "type": "boolean",
          "default": true,
          "description": "Whether to return the column keys (false) or the column names (true)"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "row"
          ],
          "operation": [
            "list"
          ]
        }
      }
    },
    {
      "displayName": "Column Name or ID",
      "name": "searchColumn",
      "type": "options",
      "default": "",
      "description": "Select the column to be searched. Not all column types are supported for search. Choose from the list, or specify a name using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>.",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "row"
          ],
          "operation": [
            "search"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsDependsOn": [
          "tableName"
        ],
        "loadOptionsMethod": "getSearchableColumns"
      }
    },
    {
      "displayName": "Search Term",
      "name": "searchTerm",
      "type": "string",
      "default": "",
      "description": "What to look for?",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "row"
          ],
          "operation": [
            "search"
          ]
        }
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Case Insensitive Search",
          "name": "insensitive",
          "type": "boolean",
          "default": false,
          "description": "Whether the search ignores case sensitivity (true). Otherwise, it distinguishes between uppercase and lowercase characters."
        },
        {
          "displayName": "Activate Wildcard Search",
          "name": "wildcard",
          "type": "boolean",
          "default": true,
          "description": "Whether the search only results perfect matches (true). Otherwise, it finds a row even if the search value is part of a string (false)."
        },
        {
          "displayName": "Simplify",
          "name": "simple",
          "type": "boolean",
          "default": true,
          "description": "Whether to return a simplified version of the response instead of the raw data"
        },
        {
          "displayName": "Return Column Names",
          "name": "convert",
          "type": "boolean",
          "default": true,
          "description": "Whether to return the column keys (false) or the column names (true)"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "row"
          ],
          "operation": [
            "search"
          ]
        }
      }
    },
    {
      "displayName": "Data to Send",
      "name": "fieldsToSend",
      "type": "options",
      "default": "defineBelow",
      "description": "Whether to insert the input data this node receives in the new row",
      "options": [
        {
          "name": "Auto-Map Input Data to Columns",
          "value": "autoMapInputData",
          "description": "Use when node input properties match destination column names"
        },
        {
          "name": "Define Below for Each Column",
          "value": "defineBelow",
          "description": "Set the value for each destination column"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "row"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Inputs to Ignore",
      "name": "inputsToIgnore",
      "type": "string",
      "default": "",
      "description": "List of input properties to avoid sending, separated by commas. Leave empty to send all properties.",
      "displayOptions": {
        "show": {
          "resource": [
            "row"
          ],
          "operation": [
            "update"
          ],
          "fieldsToSend": [
            "autoMapInputData"
          ]
        }
      }
    },
    {
      "displayName": "Columns to Send",
      "name": "columnsUi",
      "type": "fixedCollection",
      "default": {},
      "description": "Add destination column with its value. Provide the value in this way:Date: YYYY-MM-DD or YYYY-MM-DD hh:mmDuration: time in secondsCheckbox: true, on or 1Multi-Select: comma-separated list.",
      "options": [
        {
          "displayName": "Column",
          "name": "columnValues",
          "values": [
            {
              "displayName": "Column Name or ID",
              "name": "columnName",
              "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": [
                  "tableName"
                ],
                "loadOptionsMethod": "getTableUpdateAbleColumns"
              },
              "default": ""
            },
            {
              "displayName": "Column Value",
              "name": "columnValue",
              "type": "string",
              "default": ""
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "row"
          ],
          "operation": [
            "update"
          ],
          "fieldsToSend": [
            "defineBelow"
          ]
        }
      },
      "typeOptions": {
        "multipleValueButtonText": "Add Column to Send",
        "multipleValues": true
      }
    },
    {
      "displayName": "Hint: Link, files, images or digital signatures have to be added separately.",
      "name": "notice",
      "type": "notice",
      "default": "",
      "displayOptions": {
        "show": {
          "resource": [
            "row"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "snapshot",
      "options": [
        {
          "name": "Snapshot",
          "value": "snapshot",
          "description": "Create a snapshot of the base",
          "action": "Create a snapshot"
        },
        {
          "name": "Metadata",
          "value": "metadata",
          "description": "Get the complete metadata of the base",
          "action": "Get metadata of a base"
        },
        {
          "name": "Collaborator",
          "value": "collaborator",
          "description": "Get the username from the email or name of a collaborator",
          "action": "Get username from email or name"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "base"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Name or email of the collaborator",
      "name": "searchString",
      "type": "string",
      "default": "",
      "description": "SeaTable identifies users with a unique username like 244b43hr6fy54bb4afa2c2cb7369d244@auth.local. Get this username from an email or the name of a collaborator.",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "base"
          ],
          "operation": [
            "collaborator"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "add",
      "options": [
        {
          "name": "Add",
          "value": "add",
          "description": "Create a link between two rows in a link column",
          "action": "Add a row link"
        },
        {
          "name": "List",
          "value": "list",
          "description": "List all links of a specific row",
          "action": "List row links"
        },
        {
          "name": "Remove",
          "value": "remove",
          "description": "Remove a link between two rows from a link column",
          "action": "Remove a row link"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "link"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Table Name (Source)",
      "name": "tableName",
      "type": "options",
      "default": "",
      "description": "Choose from the list, of specify by using an expression. Provide it in the way \"table_name:::table_id\".",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "link"
          ],
          "operation": [
            "add"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getTableNameAndId"
      }
    },
    {
      "displayName": "Link Column",
      "name": "linkColumn",
      "type": "options",
      "default": "",
      "description": "Choose from the list of specify the Link Column by using an expression. You have to provide it in the way \"column_name:::link_id:::other_table_id\".",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "link"
          ],
          "operation": [
            "add"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsDependsOn": [
          "tableName"
        ],
        "loadOptionsMethod": "getLinkColumns"
      }
    },
    {
      "displayName": "Row ID From the Source Table",
      "name": "linkColumnSourceId",
      "type": "string",
      "default": "",
      "description": "Provide the row ID of table you selected",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "link"
          ],
          "operation": [
            "add"
          ]
        }
      }
    },
    {
      "displayName": "Row ID From the Target",
      "name": "linkColumnTargetId",
      "type": "string",
      "default": "",
      "description": "Provide the row ID of table you want to link",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "link"
          ],
          "operation": [
            "add"
          ]
        }
      }
    },
    {
      "displayName": "Table Name",
      "name": "tableName",
      "type": "options",
      "default": "",
      "description": "Choose from the list, of specify by using an expression. Provide it in the way \"table_name:::table_id\".",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "link"
          ],
          "operation": [
            "list"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getTableNameAndId"
      }
    },
    {
      "displayName": "Link Column",
      "name": "linkColumn",
      "type": "options",
      "default": "",
      "description": "Choose from the list of specify the Link Column by using an expression. You have to provide it in the way \"column_name:::link_id:::other_table_id:::column_key\".",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "link"
          ],
          "operation": [
            "list"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsDependsOn": [
          "tableName"
        ],
        "loadOptionsMethod": "getLinkColumnsWithColumnKey"
      }
    },
    {
      "displayName": "Row ID",
      "name": "rowId",
      "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": [
            "link"
          ],
          "operation": [
            "list"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsDependsOn": [
          "tableName"
        ],
        "loadOptionsMethod": "getRowIds"
      }
    },
    {
      "displayName": "Table Name (Source)",
      "name": "tableName",
      "type": "options",
      "default": "",
      "description": "Choose from the list, of specify by using an expression. Provide it in the way \"table_name:::table_id\".",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "link"
          ],
          "operation": [
            "remove"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getTableNameAndId"
      }
    },
    {
      "displayName": "Link Column",
      "name": "linkColumn",
      "type": "options",
      "default": "",
      "description": "Choose from the list of specify the Link Column by using an expression. You have to provide it in the way \"column_name:::link_id:::other_table_id\".",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "link"
          ],
          "operation": [
            "remove"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsDependsOn": [
          "tableName"
        ],
        "loadOptionsMethod": "getLinkColumns"
      }
    },
    {
      "displayName": "Row ID From the Source Table",
      "name": "linkColumnSourceId",
      "type": "string",
      "default": "",
      "description": "Provide the row ID of table you selected",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "link"
          ],
          "operation": [
            "remove"
          ]
        }
      }
    },
    {
      "displayName": "Row ID From the Target Table",
      "name": "linkColumnTargetId",
      "type": "string",
      "default": "",
      "description": "Provide the row ID of table you want to link",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "link"
          ],
          "operation": [
            "remove"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "upload",
      "options": [
        {
          "name": "Public URL",
          "value": "getPublicURL",
          "description": "Get the public URL from asset path",
          "action": "Get the public URL from asset path"
        },
        {
          "name": "Upload",
          "value": "upload",
          "description": "Add a file/image to an existing row",
          "action": "Upload a file or image"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "asset"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Table Name",
      "name": "tableName",
      "type": "options",
      "default": "",
      "description": "Choose from the list, or specify a name using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "asset"
          ],
          "operation": [
            "upload"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getTableNames"
      }
    },
    {
      "displayName": "Column Name",
      "name": "uploadColumn",
      "type": "options",
      "default": "",
      "description": "Choose from the list, or specify the name using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "asset"
          ],
          "operation": [
            "upload"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsDependsOn": [
          "tableName"
        ],
        "loadOptionsMethod": "getAssetColumns"
      }
    },
    {
      "displayName": "Row ID",
      "name": "rowId",
      "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": [
            "asset"
          ],
          "operation": [
            "upload"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsDependsOn": [
          "tableName"
        ],
        "loadOptionsMethod": "getRowIds"
      }
    },
    {
      "displayName": "Property Name",
      "name": "dataPropertyName",
      "type": "string",
      "default": "data",
      "description": "Name of the binary property which contains the data for the file to be written",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "asset"
          ],
          "operation": [
            "upload"
          ]
        }
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Replace Existing File",
          "name": "replace",
          "type": "boolean",
          "default": true,
          "description": "Whether to replace the existing asset with the same name (true). Otherwise, a new version with a different name (numeral in parentheses) will be uploaded (false)."
        },
        {
          "displayName": "Append to Column",
          "name": "append",
          "type": "boolean",
          "default": true,
          "description": "Whether to keep existing files/images in the column and append the new asset (true). Otherwise, the existing files/images are removed from the column (false)."
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "asset"
          ],
          "operation": [
            "upload"
          ]
        }
      }
    },
    {
      "displayName": "Asset Path",
      "name": "assetPath",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "asset"
          ],
          "operation": [
            "getPublicURL"
          ]
        }
      }
    }
  ]

operations:
  [
    {
      "operation": "create",
      "name": "Create",
      "description": "Create a new row",
      "resource": "row"
    },
    {
      "operation": "remove",
      "name": "Delete",
      "description": "Delete a row",
      "resource": "row"
    },
    {
      "operation": "get",
      "name": "Get",
      "description": "Get the content of a row",
      "resource": "row"
    },
    {
      "operation": "list",
      "name": "Get Many",
      "description": "Get many rows from a table or a table view",
      "resource": "row"
    },
    {
      "operation": "lock",
      "name": "Lock",
      "description": "Lock a row to prevent further changes",
      "resource": "row"
    },
    {
      "operation": "search",
      "name": "Search",
      "description": "Search one or multiple rows",
      "resource": "row"
    },
    {
      "operation": "unlock",
      "name": "Unlock",
      "description": "Remove the lock from a row",
      "resource": "row"
    },
    {
      "operation": "update",
      "name": "Update",
      "description": "Update the content of a row",
      "resource": "row"
    },
    {
      "operation": "snapshot",
      "name": "Snapshot",
      "description": "Create a snapshot of the base",
      "resource": "base"
    },
    {
      "operation": "metadata",
      "name": "Metadata",
      "description": "Get the complete metadata of the base",
      "resource": "base"
    },
    {
      "operation": "collaborator",
      "name": "Collaborator",
      "description": "Get the username from the email or name of a collaborator",
      "resource": "base"
    },
    {
      "operation": "add",
      "name": "Add",
      "description": "Create a link between two rows in a link column",
      "resource": "link"
    },
    {
      "operation": "list",
      "name": "List",
      "description": "List all links of a specific row",
      "resource": "link"
    },
    {
      "operation": "remove",
      "name": "Remove",
      "description": "Remove a link between two rows from a link column",
      "resource": "link"
    },
    {
      "operation": "getPublicURL",
      "name": "Public URL",
      "description": "Get the public URL from asset path",
      "resource": "asset"
    },
    {
      "operation": "upload",
      "name": "Upload",
      "description": "Add a file/image to an existing row",
      "resource": "asset"
    }
  ]


node_type: nodes-base.seaTable
package_name: n8n-nodes-base
display_name: SeaTable
description: Read, update, write and delete data from SeaTable
category: output
development_style: programmatic
version: 2
credentials_required:
  [
  {
  "name": "seaTableApi",
  "required": true
  }
  ]

outputs:
  [
  "main"
  ]

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

  # SeaTable node

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

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

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

  ## Operations

  * Row
      * Create
      * Delete
      * Get
      * Get All
      * Update

  ## Templates and examples

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

properties_schema:
  [
    {
      "displayName": "Resource",
      "name": "resource",
      "type": "options",
      "default": "row",
      "options": [
        {
          "name": "Row",
          "value": "row"
        },
        {
          "name": "Base",
          "value": "base"
        },
        {
          "name": "Link",
          "value": "link"
        },
        {
          "name": "Asset",
          "value": "asset"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create a new row",
          "action": "Create a row"
        },
        {
          "name": "Delete",
          "value": "remove",
          "description": "Delete a row",
          "action": "Delete a row"
        },
        {
          "name": "Get",
          "value": "get",
          "description": "Get the content of a row",
          "action": "Get a row"
        },
        {
          "name": "Get Many",
          "value": "list",
          "description": "Get many rows from a table or a table view",
          "action": "Get many rows"
        },
        {
          "name": "Lock",
          "value": "lock",
          "description": "Lock a row to prevent further changes",
          "action": "Add a row lock"
        },
        {
          "name": "Search",
          "value": "search",
          "description": "Search one or multiple rows",
          "action": "Search a row by keyword"
        },
        {
          "name": "Unlock",
          "value": "unlock",
          "description": "Remove the lock from a row",
          "action": "Remove a row lock"
        },
        {
          "name": "Update",
          "value": "update",
          "description": "Update the content of a row",
          "action": "Update a row"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "row"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Table Name",
      "name": "tableName",
      "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": [
            "row"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getTableNames"
      }
    },
    {
      "displayName": "Row ID",
      "name": "rowId",
      "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": [
            "row"
          ]
        },
        "hide": {
          "operation": [
            "create",
            "list",
            "search"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsDependsOn": [
          "tableName"
        ],
        "loadOptionsMethod": "getRowIds"
      }
    },
    {
      "displayName": "Data to Send",
      "name": "fieldsToSend",
      "type": "options",
      "default": "defineBelow",
      "description": "Whether to insert the input data this node receives in the new row",
      "options": [
        {
          "name": "Auto-Map Input Data to Columns",
          "value": "autoMapInputData",
          "description": "Use when node input properties match destination column names"
        },
        {
          "name": "Define Below for Each Column",
          "value": "defineBelow",
          "description": "Set the value for each destination column"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "row"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Apply Column Default Values",
      "name": "apply_default",
      "type": "boolean",
      "default": false,
      "description": "Whether to use the column default values to populate new rows during creation (only available for normal backend)",
      "displayOptions": {
        "show": {
          "bigdata": [
            false
          ],
          "resource": [
            "row"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "In this mode, make sure the incoming data fields are named the same as the columns in SeaTable. (Use an \"Edit Fields\" node before this node to change them if required.)",
      "name": "notice",
      "type": "notice",
      "default": "",
      "displayOptions": {
        "show": {
          "/fieldsToSend": [
            "autoMapInputData"
          ],
          "resource": [
            "row"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Inputs to Ignore",
      "name": "inputsToIgnore",
      "type": "string",
      "default": "",
      "description": "List of input properties to avoid sending, separated by commas. Leave empty to send all properties.",
      "displayOptions": {
        "show": {
          "/fieldsToSend": [
            "autoMapInputData"
          ],
          "resource": [
            "row"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Columns to Send",
      "name": "columnsUi",
      "type": "fixedCollection",
      "default": {},
      "description": "Add destination column with its value. Provide the value in this way. Date: YYYY-MM-DD or YYYY-MM-DD hh:mm. Duration: time in seconds. Checkbox: true, on or 1. Multi-Select: comma-separated list.",
      "options": [
        {
          "displayName": "Column",
          "name": "columnValues",
          "values": [
            {
              "displayName": "Column Name or ID",
              "name": "columnName",
              "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": [
                  "tableName"
                ],
                "loadOptionsMethod": "getTableUpdateAbleColumns"
              },
              "default": ""
            },
            {
              "displayName": "Column Value",
              "name": "columnValue",
              "type": "string",
              "default": ""
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "/fieldsToSend": [
            "defineBelow"
          ],
          "resource": [
            "row"
          ],
          "operation": [
            "create"
          ]
        }
      },
      "typeOptions": {
        "multipleValueButtonText": "Add Column to Send",
        "multipleValues": true
      }
    },
    {
      "displayName": "Save to \"Big Data\" Backend",
      "name": "bigdata",
      "type": "boolean",
      "default": false,
      "description": "Whether write to Big Data backend (true) or not (false). True requires the activation of the Big Data backend in the base.",
      "displayOptions": {
        "show": {
          "resource": [
            "row"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Hint: Link, files, images or digital signatures have to be added separately. These column types cannot be set with this node.",
      "name": "notice",
      "type": "notice",
      "default": "",
      "displayOptions": {
        "show": {
          "resource": [
            "row"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Simplify",
          "name": "simple",
          "type": "boolean",
          "default": true,
          "description": "Whether to return a simplified version of the response instead of the raw data"
        },
        {
          "displayName": "Return Column Names",
          "name": "convert",
          "type": "boolean",
          "default": true,
          "description": "Whether to return the column keys (false) or the column names (true)"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "row"
          ],
          "operation": [
            "get"
          ]
        }
      }
    },
    {
      "displayName": "View Name",
      "name": "viewName",
      "type": "options",
      "default": "",
      "description": "The name of SeaTable view to access, or specify by using an expression. Provide it in the way \"col.name:::col.type\".",
      "displayOptions": {
        "show": {
          "resource": [
            "row"
          ],
          "operation": [
            "list"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsDependsOn": [
          "tableName"
        ],
        "loadOptionsMethod": "getTableViews"
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Simplify",
          "name": "simple",
          "type": "boolean",
          "default": true,
          "description": "Whether to return a simplified version of the response instead of the raw data"
        },
        {
          "displayName": "Return Column Names",
          "name": "convert",
          "type": "boolean",
          "default": true,
          "description": "Whether to return the column keys (false) or the column names (true)"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "row"
          ],
          "operation": [
            "list"
          ]
        }
      }
    },
    {
      "displayName": "Column Name or ID",
      "name": "searchColumn",
      "type": "options",
      "default": "",
      "description": "Select the column to be searched. Not all column types are supported for search. Choose from the list, or specify a name using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>.",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "row"
          ],
          "operation": [
            "search"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsDependsOn": [
          "tableName"
        ],
        "loadOptionsMethod": "getSearchableColumns"
      }
    },
    {
      "displayName": "Search Term",
      "name": "searchTerm",
      "type": "string",
      "default": "",
      "description": "What to look for?",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "row"
          ],
          "operation": [
            "search"
          ]
        }
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Case Insensitive Search",
          "name": "insensitive",
          "type": "boolean",
          "default": false,
          "description": "Whether the search ignores case sensitivity (true). Otherwise, it distinguishes between uppercase and lowercase characters."
        },
        {
          "displayName": "Activate Wildcard Search",
          "name": "wildcard",
          "type": "boolean",
          "default": true,
          "description": "Whether the search only results perfect matches (true). Otherwise, it finds a row even if the search value is part of a string (false)."
        },
        {
          "displayName": "Simplify",
          "name": "simple",
          "type": "boolean",
          "default": true,
          "description": "Whether to return a simplified version of the response instead of the raw data"
        },
        {
          "displayName": "Return Column Names",
          "name": "convert",
          "type": "boolean",
          "default": true,
          "description": "Whether to return the column keys (false) or the column names (true)"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "row"
          ],
          "operation": [
            "search"
          ]
        }
      }
    },
    {
      "displayName": "Data to Send",
      "name": "fieldsToSend",
      "type": "options",
      "default": "defineBelow",
      "description": "Whether to insert the input data this node receives in the new row",
      "options": [
        {
          "name": "Auto-Map Input Data to Columns",
          "value": "autoMapInputData",
          "description": "Use when node input properties match destination column names"
        },
        {
          "name": "Define Below for Each Column",
          "value": "defineBelow",
          "description": "Set the value for each destination column"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "row"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Inputs to Ignore",
      "name": "inputsToIgnore",
      "type": "string",
      "default": "",
      "description": "List of input properties to avoid sending, separated by commas. Leave empty to send all properties.",
      "displayOptions": {
        "show": {
          "resource": [
            "row"
          ],
          "operation": [
            "update"
          ],
          "fieldsToSend": [
            "autoMapInputData"
          ]
        }
      }
    },
    {
      "displayName": "Columns to Send",
      "name": "columnsUi",
      "type": "fixedCollection",
      "default": {},
      "description": "Add destination column with its value. Provide the value in this way:Date: YYYY-MM-DD or YYYY-MM-DD hh:mmDuration: time in secondsCheckbox: true, on or 1Multi-Select: comma-separated list.",
      "options": [
        {
          "displayName": "Column",
          "name": "columnValues",
          "values": [
            {
              "displayName": "Column Name or ID",
              "name": "columnName",
              "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": [
                  "tableName"
                ],
                "loadOptionsMethod": "getTableUpdateAbleColumns"
              },
              "default": ""
            },
            {
              "displayName": "Column Value",
              "name": "columnValue",
              "type": "string",
              "default": ""
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "row"
          ],
          "operation": [
            "update"
          ],
          "fieldsToSend": [
            "defineBelow"
          ]
        }
      },
      "typeOptions": {
        "multipleValueButtonText": "Add Column to Send",
        "multipleValues": true
      }
    },
    {
      "displayName": "Hint: Link, files, images or digital signatures have to be added separately.",
      "name": "notice",
      "type": "notice",
      "default": "",
      "displayOptions": {
        "show": {
          "resource": [
            "row"
          ],
          "operation": [
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "snapshot",
      "options": [
        {
          "name": "Snapshot",
          "value": "snapshot",
          "description": "Create a snapshot of the base",
          "action": "Create a snapshot"
        },
        {
          "name": "Metadata",
          "value": "metadata",
          "description": "Get the complete metadata of the base",
          "action": "Get metadata of a base"
        },
        {
          "name": "Collaborator",
          "value": "collaborator",
          "description": "Get the username from the email or name of a collaborator",
          "action": "Get username from email or name"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "base"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Name or email of the collaborator",
      "name": "searchString",
      "type": "string",
      "default": "",
      "description": "SeaTable identifies users with a unique username like 244b43hr6fy54bb4afa2c2cb7369d244@auth.local. Get this username from an email or the name of a collaborator.",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "base"
          ],
          "operation": [
            "collaborator"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "add",
      "options": [
        {
          "name": "Add",
          "value": "add",
          "description": "Create a link between two rows in a link column",
          "action": "Add a row link"
        },
        {
          "name": "List",
          "value": "list",
          "description": "List all links of a specific row",
          "action": "List row links"
        },
        {
          "name": "Remove",
          "value": "remove",
          "description": "Remove a link between two rows from a link column",
          "action": "Remove a row link"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "link"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Table Name (Source)",
      "name": "tableName",
      "type": "options",
      "default": "",
      "description": "Choose from the list, of specify by using an expression. Provide it in the way \"table_name:::table_id\".",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "link"
          ],
          "operation": [
            "add"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getTableNameAndId"
      }
    },
    {
      "displayName": "Link Column",
      "name": "linkColumn",
      "type": "options",
      "default": "",
      "description": "Choose from the list of specify the Link Column by using an expression. You have to provide it in the way \"column_name:::link_id:::other_table_id\".",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "link"
          ],
          "operation": [
            "add"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsDependsOn": [
          "tableName"
        ],
        "loadOptionsMethod": "getLinkColumns"
      }
    },
    {
      "displayName": "Row ID From the Source Table",
      "name": "linkColumnSourceId",
      "type": "string",
      "default": "",
      "description": "Provide the row ID of table you selected",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "link"
          ],
          "operation": [
            "add"
          ]
        }
      }
    },
    {
      "displayName": "Row ID From the Target",
      "name": "linkColumnTargetId",
      "type": "string",
      "default": "",
      "description": "Provide the row ID of table you want to link",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "link"
          ],
          "operation": [
            "add"
          ]
        }
      }
    },
    {
      "displayName": "Table Name",
      "name": "tableName",
      "type": "options",
      "default": "",
      "description": "Choose from the list, of specify by using an expression. Provide it in the way \"table_name:::table_id\".",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "link"
          ],
          "operation": [
            "list"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getTableNameAndId"
      }
    },
    {
      "displayName": "Link Column",
      "name": "linkColumn",
      "type": "options",
      "default": "",
      "description": "Choose from the list of specify the Link Column by using an expression. You have to provide it in the way \"column_name:::link_id:::other_table_id:::column_key\".",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "link"
          ],
          "operation": [
            "list"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsDependsOn": [
          "tableName"
        ],
        "loadOptionsMethod": "getLinkColumnsWithColumnKey"
      }
    },
    {
      "displayName": "Row ID",
      "name": "rowId",
      "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": [
            "link"
          ],
          "operation": [
            "list"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsDependsOn": [
          "tableName"
        ],
        "loadOptionsMethod": "getRowIds"
      }
    },
    {
      "displayName": "Table Name (Source)",
      "name": "tableName",
      "type": "options",
      "default": "",
      "description": "Choose from the list, of specify by using an expression. Provide it in the way \"table_name:::table_id\".",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "link"
          ],
          "operation": [
            "remove"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getTableNameAndId"
      }
    },
    {
      "displayName": "Link Column",
      "name": "linkColumn",
      "type": "options",
      "default": "",
      "description": "Choose from the list of specify the Link Column by using an expression. You have to provide it in the way \"column_name:::link_id:::other_table_id\".",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "link"
          ],
          "operation": [
            "remove"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsDependsOn": [
          "tableName"
        ],
        "loadOptionsMethod": "getLinkColumns"
      }
    },
    {
      "displayName": "Row ID From the Source Table",
      "name": "linkColumnSourceId",
      "type": "string",
      "default": "",
      "description": "Provide the row ID of table you selected",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "link"
          ],
          "operation": [
            "remove"
          ]
        }
      }
    },
    {
      "displayName": "Row ID From the Target Table",
      "name": "linkColumnTargetId",
      "type": "string",
      "default": "",
      "description": "Provide the row ID of table you want to link",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "link"
          ],
          "operation": [
            "remove"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "upload",
      "options": [
        {
          "name": "Public URL",
          "value": "getPublicURL",
          "description": "Get the public URL from asset path",
          "action": "Get the public URL from asset path"
        },
        {
          "name": "Upload",
          "value": "upload",
          "description": "Add a file/image to an existing row",
          "action": "Upload a file or image"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "asset"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Table Name",
      "name": "tableName",
      "type": "options",
      "default": "",
      "description": "Choose from the list, or specify a name using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "asset"
          ],
          "operation": [
            "upload"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getTableNames"
      }
    },
    {
      "displayName": "Column Name",
      "name": "uploadColumn",
      "type": "options",
      "default": "",
      "description": "Choose from the list, or specify the name using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "asset"
          ],
          "operation": [
            "upload"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsDependsOn": [
          "tableName"
        ],
        "loadOptionsMethod": "getAssetColumns"
      }
    },
    {
      "displayName": "Row ID",
      "name": "rowId",
      "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": [
            "asset"
          ],
          "operation": [
            "upload"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsDependsOn": [
          "tableName"
        ],
        "loadOptionsMethod": "getRowIds"
      }
    },
    {
      "displayName": "Property Name",
      "name": "dataPropertyName",
      "type": "string",
      "default": "data",
      "description": "Name of the binary property which contains the data for the file to be written",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "asset"
          ],
          "operation": [
            "upload"
          ]
        }
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Replace Existing File",
          "name": "replace",
          "type": "boolean",
          "default": true,
          "description": "Whether to replace the existing asset with the same name (true). Otherwise, a new version with a different name (numeral in parentheses) will be uploaded (false)."
        },
        {
          "displayName": "Append to Column",
          "name": "append",
          "type": "boolean",
          "default": true,
          "description": "Whether to keep existing files/images in the column and append the new asset (true). Otherwise, the existing files/images are removed from the column (false)."
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "asset"
          ],
          "operation": [
            "upload"
          ]
        }
      }
    },
    {
      "displayName": "Asset Path",
      "name": "assetPath",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "asset"
          ],
          "operation": [
            "getPublicURL"
          ]
        }
      }
    }
  ]

operations:
  [
    {
      "operation": "create",
      "name": "Create",
      "description": "Create a new row",
      "resource": "row"
    },
    {
      "operation": "remove",
      "name": "Delete",
      "description": "Delete a row",
      "resource": "row"
    },
    {
      "operation": "get",
      "name": "Get",
      "description": "Get the content of a row",
      "resource": "row"
    },
    {
      "operation": "list",
      "name": "Get Many",
      "description": "Get many rows from a table or a table view",
      "resource": "row"
    },
    {
      "operation": "lock",
      "name": "Lock",
      "description": "Lock a row to prevent further changes",
      "resource": "row"
    },
    {
      "operation": "search",
      "name": "Search",
      "description": "Search one or multiple rows",
      "resource": "row"
    },
    {
      "operation": "unlock",
      "name": "Unlock",
      "description": "Remove the lock from a row",
      "resource": "row"
    },
    {
      "operation": "update",
      "name": "Update",
      "description": "Update the content of a row",
      "resource": "row"
    },
    {
      "operation": "snapshot",
      "name": "Snapshot",
      "description": "Create a snapshot of the base",
      "resource": "base"
    },
    {
      "operation": "metadata",
      "name": "Metadata",
      "description": "Get the complete metadata of the base",
      "resource": "base"
    },
    {
      "operation": "collaborator",
      "name": "Collaborator",
      "description": "Get the username from the email or name of a collaborator",
      "resource": "base"
    },
    {
      "operation": "add",
      "name": "Add",
      "description": "Create a link between two rows in a link column",
      "resource": "link"
    },
    {
      "operation": "list",
      "name": "List",
      "description": "List all links of a specific row",
      "resource": "link"
    },
    {
      "operation": "remove",
      "name": "Remove",
      "description": "Remove a link between two rows from a link column",
      "resource": "link"
    },
    {
      "operation": "getPublicURL",
      "name": "Public URL",
      "description": "Get the public URL from asset path",
      "resource": "asset"
    },
    {
      "operation": "upload",
      "name": "Upload",
      "description": "Add a file/image to an existing row",
      "resource": "asset"
    }
  ]


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

outputs:
  [
  "main"
  ]

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

  # SeaTable Trigger node

  [SeaTable](https://seatable.io/en){:target=_blank .external-link} is a collaborative database application with a spreadsheet interface.

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

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

properties_schema:
  [
    {
      "displayName": "Event",
      "name": "event",
      "type": "options",
      "default": "newRow",
      "options": [
        {
          "name": "New Row",
          "value": "newRow",
          "description": "Trigger on newly created rows"
        },
        {
          "name": "New or Updated Row",
          "value": "updatedRow",
          "description": "Trigger has recently created or modified rows"
        },
        {
          "name": "New Signature",
          "value": "newAsset",
          "description": "Trigger on new signatures"
        }
      ]
    },
    {
      "displayName": "Table Name",
      "name": "tableName",
      "type": "options",
      "default": "",
      "description": "The name of SeaTable table to access. Choose from the list, or specify the name using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>.",
      "required": true,
      "typeOptions": {
        "loadOptionsMethod": "getTableNames"
      }
    },
    {
      "displayName": "View Name",
      "name": "viewName",
      "type": "options",
      "default": "",
      "description": "The name of SeaTable view to access. Choose from the list, or specify the name using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>.",
      "displayOptions": {
        "show": {
          "event": [
            "newRow",
            "updatedRow"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsDependsOn": [
          "tableName"
        ],
        "loadOptionsMethod": "getTableViews"
      }
    },
    {
      "displayName": "Signature Column",
      "name": "assetColumn",
      "type": "options",
      "default": "",
      "description": "Select the digital-signature column that should be tracked. Choose from the list, or specify the name using an <a href=\"https://docs.n8n.io/code-examples/expressions/\">expression</a>.",
      "required": true,
      "displayOptions": {
        "show": {
          "event": [
            "newAsset"
          ]
        }
      },
      "typeOptions": {
        "loadOptionsDependsOn": [
          "tableName"
        ],
        "loadOptionsMethod": "getSignatureColumns"
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Simplify",
          "name": "simple",
          "type": "boolean",
          "default": true,
          "description": "Whether to return a simplified version of the response instead of the raw data"
        },
        {
          "displayName": "Return Column Names",
          "name": "convert",
          "type": "boolean",
          "default": true,
          "description": "Whether to return the column keys (false) or the column names (true)",
          "displayOptions": {
            "show": {
              "/event": [
                "newRow",
                "updatedRow"
              ]
            }
          }
        }
      ]
    },
    {
      "displayName": "\"Fetch Test Event\" returns max. three items of the last hour.",
      "name": "notice",
      "type": "notice",
      "default": ""
    }
  ]


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

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

output_names:
  [
  "Tool"
  ]

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

  # SecurityScorecard node

  Use the SecurityScorecard node to automate work in SecurityScorecard, and integrate SecurityScorecard with other applications. n8n has built-in support for a wide range of SecurityScorecard features, including creating, updating, deleting, and getting portfolio, as well as getting a company's data.

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

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

  ## Operations

  * Company
      * Get company factor scores and issue counts
      * Get company's historical factor scores
      * Get company's historical scores
      * Get company information and summary of their scorecard
      * Get company's score improvement plan
  * Industry
      * Get Factor Scores
      * Get Historical Factor Scores
      * Get Score
  * Invite
      * Create an invite for a company/user
  * Portfolio
      * Create a portfolio
      * Delete a portfolio
      * Get all portfolios
      * Update a portfolio
  * Portfolio Company
      * Add a company to portfolio
      * Get all companies in a portfolio
      * Remove a company from portfolio
  * Report
      * Download a generated report
      * Generate a report
      * Get list of recently generated report

  ## Templates and examples

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

properties_schema:
  [
    {
      "displayName": "Tool Description",
      "name": "toolDescription",
      "type": "string",
      "default": "",
      "required": false,
      "description": "Description for the AI to understand what this tool does and when to use it",
      "typeOptions": {
        "rows": 3
      },
      "placeholder": "e.g., Use this tool to interact with SecurityScorecard"
    },
    {
      "displayName": "Resource",
      "name": "resource",
      "type": "options",
      "default": "company",
      "options": [
        {
          "name": "Company",
          "value": "company"
        },
        {
          "name": "Industry",
          "value": "industry"
        },
        {
          "name": "Invite",
          "value": "invite"
        },
        {
          "name": "Portfolio",
          "value": "portfolio"
        },
        {
          "name": "Portfolio Company",
          "value": "portfolioCompany"
        },
        {
          "name": "Report",
          "value": "report"
        }
      ],
      "required": true,
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "getFactor",
      "options": [
        {
          "name": "Get Factor Scores",
          "value": "getFactor",
          "description": "Get company factor scores and issue counts",
          "action": "Get a company factor scores and issue counts"
        },
        {
          "name": "Get Historical Factor Scores",
          "value": "getFactorHistorical",
          "description": "Get company's historical factor scores",
          "action": "Get a company's historical factor scores"
        },
        {
          "name": "Get Historical Scores",
          "value": "getHistoricalScore",
          "description": "Get company's historical scores",
          "action": "Get a company's historical scores"
        },
        {
          "name": "Get Information and Scorecard",
          "value": "getScorecard",
          "description": "Get company information and summary of their scorecard",
          "action": "Get company information and a summary of their scorecard"
        },
        {
          "name": "Get Score Plan",
          "value": "getScorePlan",
          "description": "Get company's score improvement plan",
          "action": "Get a company's score improvement plan"
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "company"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Scorecard Identifier",
      "name": "scorecardIdentifier",
      "type": "string",
      "default": "",
      "description": "Primary identifier of a company or scorecard, i.e. domain.",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "company"
          ],
          "operation": [
            "getScorecard",
            "getFactor",
            "getFactorHistorical",
            "getHistoricalScore",
            "getScorePlan"
          ]
        }
      }
    },
    {
      "displayName": "Score",
      "name": "score",
      "type": "number",
      "default": 0,
      "description": "Score target",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "company"
          ],
          "operation": [
            "getScorePlan"
          ]
        }
      }
    },
    {
      "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": [
            "getFactor",
            "getFactorHistorical",
            "getHistoricalScore",
            "getScorePlan"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 100,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "company"
          ],
          "operation": [
            "getFactor",
            "getFactorHistorical",
            "getHistoricalScore",
            "getScorePlan"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 100
      }
    },
    {
      "displayName": "Simplify",
      "name": "simple",
      "type": "boolean",
      "default": true,
      "description": "Whether to return a simplified version of the response instead of the raw data",
      "displayOptions": {
        "show": {
          "resource": [
            "company"
          ],
          "operation": [
            "getFactorHistorical",
            "getHistoricalScore"
          ]
        }
      }
    },
    {
      "displayName": "Filters",
      "name": "filters",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Severity",
          "name": "severity",
          "type": "string",
          "default": "",
          "placeholder": ""
        },
        {
          "displayName": "Severity In",
          "description": "Filter issues by comma-separated severity list",
          "name": "severity_in",
          "type": "string",
          "default": "",
          "placeholder": ""
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "company"
          ],
          "operation": [
            "getFactor"
          ]
        }
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Date From",
          "description": "History start date",
          "name": "date_from",
          "type": "dateTime",
          "default": ""
        },
        {
          "displayName": "Date To",
          "description": "History end date",
          "name": "date_to",
          "type": "dateTime",
          "default": ""
        },
        {
          "displayName": "Timing",
          "description": "Date granularity",
          "name": "timing",
          "type": "options",
          "options": [
            {
              "name": "Daily",
              "value": "daily"
            },
            {
              "name": "Weekly",
              "value": "weekly"
            },
            {
              "name": "Monthly",
              "value": "monthly"
            }
          ],
          "default": "daily"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "company"
          ],
          "operation": [
            "getFactorHistorical",
            "getHistoricalScore"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "getFactor",
      "options": [
        {
          "name": "Get Factor Scores",
          "value": "getFactor",
          "action": "Get factor scores for an industry"
        },
        {
          "name": "Get Historical Factor Scores",
          "value": "getFactorHistorical",
          "action": "Get historical factor scores for an industry"
        },
        {
          "name": "Get Score",
          "value": "getScore",
          "action": "Get the score for an industry"
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "industry"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Industry",
      "name": "industry",
      "type": "options",
      "default": "food",
      "options": [
        {
          "name": "Food",
          "value": "food"
        },
        {
          "name": "Healthcare",
          "value": "healthcare"
        },
        {
          "name": "Manofacturing",
          "value": "manofacturing"
        },
        {
          "name": "Retail",
          "value": "retail"
        },
        {
          "name": "Technology",
          "value": "technology"
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "industry"
          ],
          "operation": [
            "getScore",
            "getFactor",
            "getFactorHistorical"
          ]
        }
      }
    },
    {
      "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": [
            "industry"
          ],
          "operation": [
            "getFactor",
            "getFactorHistorical"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 100,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "industry"
          ],
          "operation": [
            "getFactor",
            "getFactorHistorical"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 100
      }
    },
    {
      "displayName": "Simplify",
      "name": "simple",
      "type": "boolean",
      "default": true,
      "description": "Whether to return a simplified version of the response instead of the raw data",
      "displayOptions": {
        "show": {
          "resource": [
            "industry"
          ],
          "operation": [
            "getFactor",
            "getFactorHistorical"
          ]
        }
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Date From",
          "description": "History start date",
          "name": "from",
          "type": "dateTime",
          "default": ""
        },
        {
          "displayName": "Date To",
          "description": "History end date",
          "name": "to",
          "type": "dateTime",
          "default": ""
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "industry"
          ],
          "operation": [
            "getFactorHistorical"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create an invite for a company/user",
          "action": "Create an invite"
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "invite"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Email",
      "name": "email",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "invite"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "First Name",
      "name": "firstName",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "invite"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Last Name",
      "name": "lastName",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "invite"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Message",
      "name": "message",
      "type": "string",
      "default": "",
      "description": "Message for the invitee",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "invite"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Days to Resolve Issue",
          "description": "Minimum days to resolve a scorecard issue",
          "name": "days_to_resolve_issue",
          "type": "number",
          "default": 0
        },
        {
          "displayName": "Domain",
          "description": "Invitee company domain",
          "name": "domain",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Grade to Maintain",
          "description": "Request the invitee's organisation to maintain a minimum grade",
          "name": "grade_to_maintain",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Is Organisation Point of Contact",
          "description": "Is the invitee organisation's point of contact",
          "name": "is_organization_point_of_contact",
          "type": "boolean",
          "default": false
        },
        {
          "displayName": "Issue Description",
          "name": "issue_desc",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Issue Title",
          "name": "issue_title",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Issue Type",
          "name": "issue_type",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Send Me a Copy",
          "name": "sendme_copy",
          "description": "Whether to send a copy of the invite to the requesting user",
          "type": "boolean",
          "default": false
        },
        {
          "displayName": "Target URL",
          "name": "target_url",
          "type": "string",
          "description": "Optional URL to take the invitee to when arriving to the platform",
          "default": ""
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "invite"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create a portfolio",
          "action": "Create a portfolio"
        },
        {
          "name": "Delete",
          "value": "delete",
          "description": "Delete a portfolio",
          "action": "Delete a portfolio"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get many portfolios",
          "action": "Get many portfolios"
        },
        {
          "name": "Update",
          "value": "update",
          "description": "Update a portfolio",
          "action": "Update a portfolio"
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "portfolio"
          ]
        }
      },
      "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": [
            "portfolio"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 100,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "portfolio"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 100
      }
    },
    {
      "displayName": "Portfolio ID",
      "name": "portfolioId",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "portfolio"
          ],
          "operation": [
            "update",
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "Portfolio Name",
      "name": "name",
      "type": "string",
      "default": "",
      "description": "Name of the portfolio",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "portfolio"
          ],
          "operation": [
            "create",
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Description",
      "name": "description",
      "type": "string",
      "default": "",
      "displayOptions": {
        "show": {
          "resource": [
            "portfolio"
          ],
          "operation": [
            "create",
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Privacy",
      "name": "privacy",
      "type": "options",
      "default": "shared",
      "options": [
        {
          "name": "Private",
          "value": "private",
          "description": "Only visible to you"
        },
        {
          "name": "Shared",
          "value": "shared",
          "description": "Visible to everyone in your company"
        },
        {
          "name": "Team",
          "value": "team",
          "description": "Visible to the people on your team"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "portfolio"
          ],
          "operation": [
            "create",
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "add",
      "options": [
        {
          "name": "Add",
          "value": "add",
          "description": "Add a company to portfolio",
          "action": "Add a portfolio company"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get many companies in a portfolio",
          "action": "Get many portfolio companies"
        },
        {
          "name": "Remove",
          "value": "remove",
          "description": "Remove a company from portfolio",
          "action": "Remove a portfolio company"
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "portfolioCompany"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Portfolio ID",
      "name": "portfolioId",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "portfolioCompany"
          ],
          "operation": [
            "getAll",
            "add",
            "remove"
          ]
        }
      }
    },
    {
      "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": [
            "portfolioCompany"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 100,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "portfolioCompany"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 100
      }
    },
    {
      "displayName": "Filters",
      "name": "filters",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Grade",
          "name": "grade",
          "type": "string",
          "placeholder": "",
          "default": "",
          "description": "Company score grade filter"
        },
        {
          "displayName": "Industry",
          "name": "industry",
          "type": "string",
          "placeholder": "",
          "default": "",
          "description": "Industry filter"
        },
        {
          "displayName": "Issue Type",
          "name": "issueType",
          "type": "string",
          "placeholder": "",
          "description": "Issue type filter",
          "default": ""
        },
        {
          "displayName": "Status",
          "name": "status",
          "type": "options",
          "options": [
            {
              "name": "Active",
              "value": "active"
            },
            {
              "name": "Inactive",
              "value": "inactive"
            }
          ],
          "default": ""
        },
        {
          "displayName": "Vulnerability",
          "name": "vulnerability",
          "type": "string",
          "placeholder": "",
          "description": "CVE vulnerability filter",
          "default": ""
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "portfolioCompany"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Domain",
      "name": "domain",
      "type": "string",
      "default": "",
      "description": "Company's domain name",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "portfolioCompany"
          ],
          "operation": [
            "add",
            "remove"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "getAll",
      "options": [
        {
          "name": "Download",
          "value": "download",
          "description": "Download a generated report",
          "action": "Download a report"
        },
        {
          "name": "Generate",
          "value": "generate",
          "description": "Generate a report",
          "action": "Generate a report"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get list of recently generated report",
          "action": "Get many reports"
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "report"
          ]
        }
      },
      "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": [
            "report"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 100,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "report"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 100
      }
    },
    {
      "displayName": "Report",
      "name": "report",
      "type": "options",
      "default": "detailed",
      "options": [
        {
          "name": "Company Detailed",
          "value": "detailed"
        },
        {
          "name": "Company Events",
          "value": "events-json"
        },
        {
          "name": "Company Issues",
          "value": "issues"
        },
        {
          "name": "Company Partnership",
          "value": "partnership"
        },
        {
          "name": "Company Summary",
          "value": "summary"
        },
        {
          "name": "Full Scorecard",
          "value": "full-scorecard-json"
        },
        {
          "name": "Portfolio",
          "value": "portfolio"
        },
        {
          "name": "Scorecard Footprint",
          "value": "scorecard-footprint"
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "report"
          ],
          "operation": [
            "generate"
          ]
        }
      }
    },
    {
      "displayName": "Scorecard Identifier",
      "name": "scorecardIdentifier",
      "type": "string",
      "default": "",
      "description": "Primary identifier of a company or scorecard, i.e. domain.",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "report"
          ],
          "operation": [
            "generate"
          ],
          "report": [
            "detailed",
            "events-json",
            "full-scorecard-json",
            "issues",
            "partnership",
            "scorecard-footprint",
            "summary"
          ]
        }
      }
    },
    {
      "displayName": "Portfolio ID",
      "name": "portfolioId",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "report"
          ],
          "operation": [
            "generate"
          ],
          "report": [
            "portfolio"
          ]
        }
      }
    },
    {
      "displayName": "Branding",
      "name": "branding",
      "type": "options",
      "default": "securityscorecard",
      "options": [
        {
          "name": "SecurityScorecard",
          "value": "securityscorecard"
        },
        {
          "name": "Company and SecurityScorecard",
          "value": "company_and_securityscorecard"
        },
        {
          "name": "Company",
          "value": "company"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "report"
          ],
          "operation": [
            "generate"
          ],
          "report": [
            "detailed",
            "summary"
          ]
        }
      }
    },
    {
      "displayName": "Date",
      "name": "date",
      "type": "dateTime",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "report"
          ],
          "operation": [
            "generate"
          ],
          "report": [
            "events-json"
          ]
        }
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Format",
          "name": "format",
          "type": "options",
          "default": "pdf",
          "options": [
            {
              "name": "CSV",
              "value": "csv"
            },
            {
              "name": "PDF",
              "value": "pdf"
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "report"
          ],
          "operation": [
            "generate"
          ],
          "report": [
            "issues",
            "portfolio"
          ]
        }
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Countries",
          "name": "countries",
          "type": "string",
          "typeOptions": {
            "multipleValues": true
          },
          "default": []
        },
        {
          "displayName": "Format",
          "name": "format",
          "type": "options",
          "default": "pdf",
          "options": [
            {
              "name": "CSV",
              "value": "csv"
            },
            {
              "name": "PDF",
              "value": "pdf"
            }
          ]
        },
        {
          "displayName": "IPs",
          "name": "ips",
          "type": "string",
          "typeOptions": {
            "multipleValues": true
          },
          "default": []
        },
        {
          "displayName": "Subdomains",
          "name": "subdomains",
          "type": "string",
          "typeOptions": {
            "multipleValues": true
          },
          "default": []
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "report"
          ],
          "operation": [
            "generate"
          ],
          "report": [
            "scorecard-footprint"
          ]
        }
      }
    },
    {
      "displayName": "Report URL",
      "name": "url",
      "type": "string",
      "default": "",
      "description": "URL to a generated report",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "report"
          ],
          "operation": [
            "download"
          ]
        }
      }
    },
    {
      "displayName": "Put Output File in Field",
      "name": "binaryPropertyName",
      "type": "string",
      "default": "data",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "report"
          ],
          "operation": [
            "download"
          ]
        }
      }
    }
  ]

operations:
  [
    {
      "operation": "getFactor",
      "name": "Get Factor Scores",
      "description": "Get company factor scores and issue counts",
      "resource": "company"
    },
    {
      "operation": "getFactorHistorical",
      "name": "Get Historical Factor Scores",
      "description": "Get company's historical factor scores",
      "resource": "company"
    },
    {
      "operation": "getHistoricalScore",
      "name": "Get Historical Scores",
      "description": "Get company's historical scores",
      "resource": "company"
    },
    {
      "operation": "getScorecard",
      "name": "Get Information and Scorecard",
      "description": "Get company information and summary of their scorecard",
      "resource": "company"
    },
    {
      "operation": "getScorePlan",
      "name": "Get Score Plan",
      "description": "Get company's score improvement plan",
      "resource": "company"
    },
    {
      "operation": "getFactor",
      "name": "Get Factor Scores",
      "resource": "industry"
    },
    {
      "operation": "getFactorHistorical",
      "name": "Get Historical Factor Scores",
      "resource": "industry"
    },
    {
      "operation": "getScore",
      "name": "Get Score",
      "resource": "industry"
    },
    {
      "operation": "create",
      "name": "Create",
      "description": "Create an invite for a company/user",
      "resource": "invite"
    },
    {
      "operation": "create",
      "name": "Create",
      "description": "Create a portfolio",
      "resource": "portfolio"
    },
    {
      "operation": "delete",
      "name": "Delete",
      "description": "Delete a portfolio",
      "resource": "portfolio"
    },
    {
      "operation": "getAll",
      "name": "Get Many",
      "description": "Get many portfolios",
      "resource": "portfolio"
    },
    {
      "operation": "update",
      "name": "Update",
      "description": "Update a portfolio",
      "resource": "portfolio"
    },
    {
      "operation": "add",
      "name": "Add",
      "description": "Add a company to portfolio",
      "resource": "portfolioCompany"
    },
    {
      "operation": "getAll",
      "name": "Get Many",
      "description": "Get many companies in a portfolio",
      "resource": "portfolioCompany"
    },
    {
      "operation": "remove",
      "name": "Remove",
      "description": "Remove a company from portfolio",
      "resource": "portfolioCompany"
    },
    {
      "operation": "download",
      "name": "Download",
      "description": "Download a generated report",
      "resource": "report"
    },
    {
      "operation": "generate",
      "name": "Generate",
      "description": "Generate a report",
      "resource": "report"
    },
    {
      "operation": "getAll",
      "name": "Get Many",
      "description": "Get list of recently generated report",
      "resource": "report"
    }
  ]


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

outputs:
  [
  "main"
  ]

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

  # SecurityScorecard node

  Use the SecurityScorecard node to automate work in SecurityScorecard, and integrate SecurityScorecard with other applications. n8n has built-in support for a wide range of SecurityScorecard features, including creating, updating, deleting, and getting portfolio, as well as getting a company's data.

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

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

  ## Operations

  * Company
      * Get company factor scores and issue counts
      * Get company's historical factor scores
      * Get company's historical scores
      * Get company information and summary of their scorecard
      * Get company's score improvement plan
  * Industry
      * Get Factor Scores
      * Get Historical Factor Scores
      * Get Score
  * Invite
      * Create an invite for a company/user
  * Portfolio
      * Create a portfolio
      * Delete a portfolio
      * Get all portfolios
      * Update a portfolio
  * Portfolio Company
      * Add a company to portfolio
      * Get all companies in a portfolio
      * Remove a company from portfolio
  * Report
      * Download a generated report
      * Generate a report
      * Get list of recently generated report

  ## Templates and examples

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

properties_schema:
  [
    {
      "displayName": "Resource",
      "name": "resource",
      "type": "options",
      "default": "company",
      "options": [
        {
          "name": "Company",
          "value": "company"
        },
        {
          "name": "Industry",
          "value": "industry"
        },
        {
          "name": "Invite",
          "value": "invite"
        },
        {
          "name": "Portfolio",
          "value": "portfolio"
        },
        {
          "name": "Portfolio Company",
          "value": "portfolioCompany"
        },
        {
          "name": "Report",
          "value": "report"
        }
      ],
      "required": true,
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "getFactor",
      "options": [
        {
          "name": "Get Factor Scores",
          "value": "getFactor",
          "description": "Get company factor scores and issue counts",
          "action": "Get a company factor scores and issue counts"
        },
        {
          "name": "Get Historical Factor Scores",
          "value": "getFactorHistorical",
          "description": "Get company's historical factor scores",
          "action": "Get a company's historical factor scores"
        },
        {
          "name": "Get Historical Scores",
          "value": "getHistoricalScore",
          "description": "Get company's historical scores",
          "action": "Get a company's historical scores"
        },
        {
          "name": "Get Information and Scorecard",
          "value": "getScorecard",
          "description": "Get company information and summary of their scorecard",
          "action": "Get company information and a summary of their scorecard"
        },
        {
          "name": "Get Score Plan",
          "value": "getScorePlan",
          "description": "Get company's score improvement plan",
          "action": "Get a company's score improvement plan"
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "company"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Scorecard Identifier",
      "name": "scorecardIdentifier",
      "type": "string",
      "default": "",
      "description": "Primary identifier of a company or scorecard, i.e. domain.",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "company"
          ],
          "operation": [
            "getScorecard",
            "getFactor",
            "getFactorHistorical",
            "getHistoricalScore",
            "getScorePlan"
          ]
        }
      }
    },
    {
      "displayName": "Score",
      "name": "score",
      "type": "number",
      "default": 0,
      "description": "Score target",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "company"
          ],
          "operation": [
            "getScorePlan"
          ]
        }
      }
    },
    {
      "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": [
            "getFactor",
            "getFactorHistorical",
            "getHistoricalScore",
            "getScorePlan"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 100,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "company"
          ],
          "operation": [
            "getFactor",
            "getFactorHistorical",
            "getHistoricalScore",
            "getScorePlan"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 100
      }
    },
    {
      "displayName": "Simplify",
      "name": "simple",
      "type": "boolean",
      "default": true,
      "description": "Whether to return a simplified version of the response instead of the raw data",
      "displayOptions": {
        "show": {
          "resource": [
            "company"
          ],
          "operation": [
            "getFactorHistorical",
            "getHistoricalScore"
          ]
        }
      }
    },
    {
      "displayName": "Filters",
      "name": "filters",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Severity",
          "name": "severity",
          "type": "string",
          "default": "",
          "placeholder": ""
        },
        {
          "displayName": "Severity In",
          "description": "Filter issues by comma-separated severity list",
          "name": "severity_in",
          "type": "string",
          "default": "",
          "placeholder": ""
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "company"
          ],
          "operation": [
            "getFactor"
          ]
        }
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Date From",
          "description": "History start date",
          "name": "date_from",
          "type": "dateTime",
          "default": ""
        },
        {
          "displayName": "Date To",
          "description": "History end date",
          "name": "date_to",
          "type": "dateTime",
          "default": ""
        },
        {
          "displayName": "Timing",
          "description": "Date granularity",
          "name": "timing",
          "type": "options",
          "options": [
            {
              "name": "Daily",
              "value": "daily"
            },
            {
              "name": "Weekly",
              "value": "weekly"
            },
            {
              "name": "Monthly",
              "value": "monthly"
            }
          ],
          "default": "daily"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "company"
          ],
          "operation": [
            "getFactorHistorical",
            "getHistoricalScore"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "getFactor",
      "options": [
        {
          "name": "Get Factor Scores",
          "value": "getFactor",
          "action": "Get factor scores for an industry"
        },
        {
          "name": "Get Historical Factor Scores",
          "value": "getFactorHistorical",
          "action": "Get historical factor scores for an industry"
        },
        {
          "name": "Get Score",
          "value": "getScore",
          "action": "Get the score for an industry"
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "industry"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Industry",
      "name": "industry",
      "type": "options",
      "default": "food",
      "options": [
        {
          "name": "Food",
          "value": "food"
        },
        {
          "name": "Healthcare",
          "value": "healthcare"
        },
        {
          "name": "Manofacturing",
          "value": "manofacturing"
        },
        {
          "name": "Retail",
          "value": "retail"
        },
        {
          "name": "Technology",
          "value": "technology"
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "industry"
          ],
          "operation": [
            "getScore",
            "getFactor",
            "getFactorHistorical"
          ]
        }
      }
    },
    {
      "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": [
            "industry"
          ],
          "operation": [
            "getFactor",
            "getFactorHistorical"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 100,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "industry"
          ],
          "operation": [
            "getFactor",
            "getFactorHistorical"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 100
      }
    },
    {
      "displayName": "Simplify",
      "name": "simple",
      "type": "boolean",
      "default": true,
      "description": "Whether to return a simplified version of the response instead of the raw data",
      "displayOptions": {
        "show": {
          "resource": [
            "industry"
          ],
          "operation": [
            "getFactor",
            "getFactorHistorical"
          ]
        }
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Date From",
          "description": "History start date",
          "name": "from",
          "type": "dateTime",
          "default": ""
        },
        {
          "displayName": "Date To",
          "description": "History end date",
          "name": "to",
          "type": "dateTime",
          "default": ""
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "industry"
          ],
          "operation": [
            "getFactorHistorical"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create an invite for a company/user",
          "action": "Create an invite"
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "invite"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Email",
      "name": "email",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "invite"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "First Name",
      "name": "firstName",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "invite"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Last Name",
      "name": "lastName",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "invite"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Message",
      "name": "message",
      "type": "string",
      "default": "",
      "description": "Message for the invitee",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "invite"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Days to Resolve Issue",
          "description": "Minimum days to resolve a scorecard issue",
          "name": "days_to_resolve_issue",
          "type": "number",
          "default": 0
        },
        {
          "displayName": "Domain",
          "description": "Invitee company domain",
          "name": "domain",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Grade to Maintain",
          "description": "Request the invitee's organisation to maintain a minimum grade",
          "name": "grade_to_maintain",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Is Organisation Point of Contact",
          "description": "Is the invitee organisation's point of contact",
          "name": "is_organization_point_of_contact",
          "type": "boolean",
          "default": false
        },
        {
          "displayName": "Issue Description",
          "name": "issue_desc",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Issue Title",
          "name": "issue_title",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Issue Type",
          "name": "issue_type",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Send Me a Copy",
          "name": "sendme_copy",
          "description": "Whether to send a copy of the invite to the requesting user",
          "type": "boolean",
          "default": false
        },
        {
          "displayName": "Target URL",
          "name": "target_url",
          "type": "string",
          "description": "Optional URL to take the invitee to when arriving to the platform",
          "default": ""
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "invite"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create a portfolio",
          "action": "Create a portfolio"
        },
        {
          "name": "Delete",
          "value": "delete",
          "description": "Delete a portfolio",
          "action": "Delete a portfolio"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get many portfolios",
          "action": "Get many portfolios"
        },
        {
          "name": "Update",
          "value": "update",
          "description": "Update a portfolio",
          "action": "Update a portfolio"
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "portfolio"
          ]
        }
      },
      "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": [
            "portfolio"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 100,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "portfolio"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 100
      }
    },
    {
      "displayName": "Portfolio ID",
      "name": "portfolioId",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "portfolio"
          ],
          "operation": [
            "update",
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "Portfolio Name",
      "name": "name",
      "type": "string",
      "default": "",
      "description": "Name of the portfolio",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "portfolio"
          ],
          "operation": [
            "create",
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Description",
      "name": "description",
      "type": "string",
      "default": "",
      "displayOptions": {
        "show": {
          "resource": [
            "portfolio"
          ],
          "operation": [
            "create",
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Privacy",
      "name": "privacy",
      "type": "options",
      "default": "shared",
      "options": [
        {
          "name": "Private",
          "value": "private",
          "description": "Only visible to you"
        },
        {
          "name": "Shared",
          "value": "shared",
          "description": "Visible to everyone in your company"
        },
        {
          "name": "Team",
          "value": "team",
          "description": "Visible to the people on your team"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "portfolio"
          ],
          "operation": [
            "create",
            "update"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "add",
      "options": [
        {
          "name": "Add",
          "value": "add",
          "description": "Add a company to portfolio",
          "action": "Add a portfolio company"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get many companies in a portfolio",
          "action": "Get many portfolio companies"
        },
        {
          "name": "Remove",
          "value": "remove",
          "description": "Remove a company from portfolio",
          "action": "Remove a portfolio company"
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "portfolioCompany"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Portfolio ID",
      "name": "portfolioId",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "portfolioCompany"
          ],
          "operation": [
            "getAll",
            "add",
            "remove"
          ]
        }
      }
    },
    {
      "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": [
            "portfolioCompany"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 100,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "portfolioCompany"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 100
      }
    },
    {
      "displayName": "Filters",
      "name": "filters",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Grade",
          "name": "grade",
          "type": "string",
          "placeholder": "",
          "default": "",
          "description": "Company score grade filter"
        },
        {
          "displayName": "Industry",
          "name": "industry",
          "type": "string",
          "placeholder": "",
          "default": "",
          "description": "Industry filter"
        },
        {
          "displayName": "Issue Type",
          "name": "issueType",
          "type": "string",
          "placeholder": "",
          "description": "Issue type filter",
          "default": ""
        },
        {
          "displayName": "Status",
          "name": "status",
          "type": "options",
          "options": [
            {
              "name": "Active",
              "value": "active"
            },
            {
              "name": "Inactive",
              "value": "inactive"
            }
          ],
          "default": ""
        },
        {
          "displayName": "Vulnerability",
          "name": "vulnerability",
          "type": "string",
          "placeholder": "",
          "description": "CVE vulnerability filter",
          "default": ""
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "portfolioCompany"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Domain",
      "name": "domain",
      "type": "string",
      "default": "",
      "description": "Company's domain name",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "portfolioCompany"
          ],
          "operation": [
            "add",
            "remove"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "getAll",
      "options": [
        {
          "name": "Download",
          "value": "download",
          "description": "Download a generated report",
          "action": "Download a report"
        },
        {
          "name": "Generate",
          "value": "generate",
          "description": "Generate a report",
          "action": "Generate a report"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get list of recently generated report",
          "action": "Get many reports"
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "report"
          ]
        }
      },
      "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": [
            "report"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 100,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "report"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 100
      }
    },
    {
      "displayName": "Report",
      "name": "report",
      "type": "options",
      "default": "detailed",
      "options": [
        {
          "name": "Company Detailed",
          "value": "detailed"
        },
        {
          "name": "Company Events",
          "value": "events-json"
        },
        {
          "name": "Company Issues",
          "value": "issues"
        },
        {
          "name": "Company Partnership",
          "value": "partnership"
        },
        {
          "name": "Company Summary",
          "value": "summary"
        },
        {
          "name": "Full Scorecard",
          "value": "full-scorecard-json"
        },
        {
          "name": "Portfolio",
          "value": "portfolio"
        },
        {
          "name": "Scorecard Footprint",
          "value": "scorecard-footprint"
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "report"
          ],
          "operation": [
            "generate"
          ]
        }
      }
    },
    {
      "displayName": "Scorecard Identifier",
      "name": "scorecardIdentifier",
      "type": "string",
      "default": "",
      "description": "Primary identifier of a company or scorecard, i.e. domain.",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "report"
          ],
          "operation": [
            "generate"
          ],
          "report": [
            "detailed",
            "events-json",
            "full-scorecard-json",
            "issues",
            "partnership",
            "scorecard-footprint",
            "summary"
          ]
        }
      }
    },
    {
      "displayName": "Portfolio ID",
      "name": "portfolioId",
      "type": "string",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "report"
          ],
          "operation": [
            "generate"
          ],
          "report": [
            "portfolio"
          ]
        }
      }
    },
    {
      "displayName": "Branding",
      "name": "branding",
      "type": "options",
      "default": "securityscorecard",
      "options": [
        {
          "name": "SecurityScorecard",
          "value": "securityscorecard"
        },
        {
          "name": "Company and SecurityScorecard",
          "value": "company_and_securityscorecard"
        },
        {
          "name": "Company",
          "value": "company"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "report"
          ],
          "operation": [
            "generate"
          ],
          "report": [
            "detailed",
            "summary"
          ]
        }
      }
    },
    {
      "displayName": "Date",
      "name": "date",
      "type": "dateTime",
      "default": "",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "report"
          ],
          "operation": [
            "generate"
          ],
          "report": [
            "events-json"
          ]
        }
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Format",
          "name": "format",
          "type": "options",
          "default": "pdf",
          "options": [
            {
              "name": "CSV",
              "value": "csv"
            },
            {
              "name": "PDF",
              "value": "pdf"
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "report"
          ],
          "operation": [
            "generate"
          ],
          "report": [
            "issues",
            "portfolio"
          ]
        }
      }
    },
    {
      "displayName": "Options",
      "name": "options",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Countries",
          "name": "countries",
          "type": "string",
          "typeOptions": {
            "multipleValues": true
          },
          "default": []
        },
        {
          "displayName": "Format",
          "name": "format",
          "type": "options",
          "default": "pdf",
          "options": [
            {
              "name": "CSV",
              "value": "csv"
            },
            {
              "name": "PDF",
              "value": "pdf"
            }
          ]
        },
        {
          "displayName": "IPs",
          "name": "ips",
          "type": "string",
          "typeOptions": {
            "multipleValues": true
          },
          "default": []
        },
        {
          "displayName": "Subdomains",
          "name": "subdomains",
          "type": "string",
          "typeOptions": {
            "multipleValues": true
          },
          "default": []
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "report"
          ],
          "operation": [
            "generate"
          ],
          "report": [
            "scorecard-footprint"
          ]
        }
      }
    },
    {
      "displayName": "Report URL",
      "name": "url",
      "type": "string",
      "default": "",
      "description": "URL to a generated report",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "report"
          ],
          "operation": [
            "download"
          ]
        }
      }
    },
    {
      "displayName": "Put Output File in Field",
      "name": "binaryPropertyName",
      "type": "string",
      "default": "data",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "report"
          ],
          "operation": [
            "download"
          ]
        }
      }
    }
  ]

operations:
  [
    {
      "operation": "getFactor",
      "name": "Get Factor Scores",
      "description": "Get company factor scores and issue counts",
      "resource": "company"
    },
    {
      "operation": "getFactorHistorical",
      "name": "Get Historical Factor Scores",
      "description": "Get company's historical factor scores",
      "resource": "company"
    },
    {
      "operation": "getHistoricalScore",
      "name": "Get Historical Scores",
      "description": "Get company's historical scores",
      "resource": "company"
    },
    {
      "operation": "getScorecard",
      "name": "Get Information and Scorecard",
      "description": "Get company information and summary of their scorecard",
      "resource": "company"
    },
    {
      "operation": "getScorePlan",
      "name": "Get Score Plan",
      "description": "Get company's score improvement plan",
      "resource": "company"
    },
    {
      "operation": "getFactor",
      "name": "Get Factor Scores",
      "resource": "industry"
    },
    {
      "operation": "getFactorHistorical",
      "name": "Get Historical Factor Scores",
      "resource": "industry"
    },
    {
      "operation": "getScore",
      "name": "Get Score",
      "resource": "industry"
    },
    {
      "operation": "create",
      "name": "Create",
      "description": "Create an invite for a company/user",
      "resource": "invite"
    },
    {
      "operation": "create",
      "name": "Create",
      "description": "Create a portfolio",
      "resource": "portfolio"
    },
    {
      "operation": "delete",
      "name": "Delete",
      "description": "Delete a portfolio",
      "resource": "portfolio"
    },
    {
      "operation": "getAll",
      "name": "Get Many",
      "description": "Get many portfolios",
      "resource": "portfolio"
    },
    {
      "operation": "update",
      "name": "Update",
      "description": "Update a portfolio",
      "resource": "portfolio"
    },
    {
      "operation": "add",
      "name": "Add",
      "description": "Add a company to portfolio",
      "resource": "portfolioCompany"
    },
    {
      "operation": "getAll",
      "name": "Get Many",
      "description": "Get many companies in a portfolio",
      "resource": "portfolioCompany"
    },
    {
      "operation": "remove",
      "name": "Remove",
      "description": "Remove a company from portfolio",
      "resource": "portfolioCompany"
    },
    {
      "operation": "download",
      "name": "Download",
      "description": "Download a generated report",
      "resource": "report"
    },
    {
      "operation": "generate",
      "name": "Generate",
      "description": "Generate a report",
      "resource": "report"
    },
    {
      "operation": "getAll",
      "name": "Get Many",
      "description": "Get list of recently generated report",
      "resource": "report"
    }
  ]


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

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

output_names:
  [
  "Tool"
  ]

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

  # Segment node

  Use the Segment node to automate work in Segment, and integrate Segment with other applications. n8n has built-in support for a wide range of Segment features, including adding users to groups, creating identities, and tracking activities. 

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

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

  ## Operations

  * Group
      * Add a user to a group
  * Identify
      * Create an identity
  * Track
      * Record the actions your users perform. Every action triggers an event, which can also have associated properties.
      * Record page views on your website, along with optional extra information about the page being viewed.

  ## Templates and examples

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

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

properties_schema:
  [
    {
      "displayName": "Tool Description",
      "name": "toolDescription",
      "type": "string",
      "default": "",
      "required": false,
      "description": "Description for the AI to understand what this tool does and when to use it",
      "typeOptions": {
        "rows": 3
      },
      "placeholder": "e.g., Use this tool to interact with Segment"
    },
    {
      "displayName": "Resource",
      "name": "resource",
      "type": "options",
      "default": "identify",
      "options": [
        {
          "name": "Group",
          "value": "group",
          "description": "Group lets you associate an identified user with a group"
        },
        {
          "name": "Identify",
          "value": "identify",
          "description": "Identify lets you tie a user to their actions"
        },
        {
          "name": "Track",
          "value": "track",
          "description": "Track lets you record events"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "add",
      "options": [
        {
          "name": "Add",
          "value": "add",
          "description": "Add a user to a group",
          "action": "Add a user to a group"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "group"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "User ID",
      "name": "userId",
      "type": "string",
      "default": "",
      "displayOptions": {
        "show": {
          "resource": [
            "group"
          ],
          "operation": [
            "add"
          ]
        }
      }
    },
    {
      "displayName": "Group ID",
      "name": "groupId",
      "type": "string",
      "default": "",
      "description": "A Group ID is the unique identifier which you recognize a group by in your own database",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "group"
          ],
          "operation": [
            "add"
          ]
        }
      }
    },
    {
      "displayName": "Traits",
      "name": "traits",
      "type": "fixedCollection",
      "default": {},
      "options": [
        {
          "name": "traitsUi",
          "displayName": "Trait",
          "values": [
            {
              "displayName": "Key",
              "name": "key",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "Value",
              "name": "value",
              "type": "string",
              "default": ""
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "group"
          ],
          "operation": [
            "add"
          ]
        }
      },
      "typeOptions": {
        "multipleValues": true
      }
    },
    {
      "displayName": "Context",
      "name": "context",
      "type": "fixedCollection",
      "default": {},
      "options": [
        {
          "name": "contextUi",
          "displayName": "Context",
          "values": [
            {
              "displayName": "Active",
              "name": "active",
              "type": "boolean",
              "default": false,
              "description": "Whether a user is active"
            },
            {
              "displayName": "IP",
              "name": "ip",
              "type": "string",
              "default": "",
              "description": "Current user’s IP address"
            },
            {
              "displayName": "Locale",
              "name": "locate",
              "type": "string",
              "default": "",
              "description": "Locale string for the current user, for example en-US"
            },
            {
              "displayName": "Page",
              "name": "page",
              "type": "string",
              "default": "",
              "description": "Dictionary of information about the current page in the browser, containing hash, path, referrer, search, title and URL"
            },
            {
              "displayName": "Timezone",
              "name": "timezone",
              "type": "string",
              "default": "",
              "description": "Timezones are sent as tzdata strings to add user timezone information which might be stripped from the timestamp, for example America/New_York"
            },
            {
              "displayName": "App",
              "name": "app",
              "placeholder": "Add App",
              "type": "fixedCollection",
              "typeOptions": {
                "multipleValues": false
              },
              "default": {},
              "options": [
                {
                  "name": "appUi",
                  "displayName": "App",
                  "values": [
                    {
                      "displayName": "Name",
                      "name": "name",
                      "type": "string",
                      "default": ""
                    },
                    {
                      "displayName": "Version",
                      "name": "version",
                      "type": "string",
                      "default": ""
                    },
                    {
                      "displayName": "Build",
                      "name": "build",
                      "type": "string",
                      "default": ""
                    }
                  ]
                }
              ]
            },
            {
              "displayName": "Campaign",
              "name": "campaign",
              "placeholder": "Campaign App",
              "type": "fixedCollection",
              "typeOptions": {
                "multipleValues": false
              },
              "default": {},
              "options": [
                {
                  "name": "campaignUi",
                  "displayName": "Campaign",
                  "values": [
                    {
                      "displayName": "Name",
                      "name": "name",
                      "type": "string",
                      "default": ""
                    },
                    {
                      "displayName": "Source",
                      "name": "source",
                      "type": "string",
                      "default": ""
                    },
                    {
                      "displayName": "Medium",
                      "name": "medium",
                      "type": "string",
                      "default": ""
                    },
                    {
                      "displayName": "Term",
                      "name": "term",
                      "type": "string",
                      "default": ""
                    },
                    {
                      "displayName": "Content",
                      "name": "content",
                      "type": "string",
                      "default": ""
                    }
                  ]
                }
              ]
            },
            {
              "displayName": "Device",
              "name": "device",
              "placeholder": "Add Device",
              "type": "fixedCollection",
              "typeOptions": {
                "multipleValues": false
              },
              "default": {},
              "options": [
                {
                  "name": "deviceUi",
                  "displayName": "Device",
                  "values": [
                    {
                      "displayName": "ID",
                      "name": "id",
                      "type": "string",
                      "default": ""
                    },
                    {
                      "displayName": "Manufacturer",
                      "name": "manufacturer",
                      "type": "string",
                      "default": ""
                    },
                    {
                      "displayName": "Model",
                      "name": "model",
                      "type": "string",
                      "default": ""
                    },
                    {
                      "displayName": "Name",
                      "name": "name",
                      "type": "string",
                      "default": ""
                    },
                    {
                      "displayName": "Type",
                      "name": "type",
                      "type": "string",
                      "default": ""
                    },
                    {
                      "displayName": "Version",
                      "name": "version",
                      "type": "string",
                      "default": ""
                    }
                  ]
                }
              ]
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "group"
          ],
          "operation": [
            "add"
          ]
        }
      },
      "typeOptions": {
        "multipleValues": false
      }
    },
    {
      "displayName": "Integration",
      "name": "integrations",
      "type": "fixedCollection",
      "default": {},
      "options": [
        {
          "name": "integrationsUi",
          "displayName": "Integration",
          "values": [
            {
              "displayName": "All",
              "name": "all",
              "type": "boolean",
              "default": true
            },
            {
              "displayName": "Salesforce",
              "name": "salesforce",
              "type": "boolean",
              "default": false
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "group"
          ],
          "operation": [
            "add"
          ]
        }
      },
      "typeOptions": {
        "multipleValues": false
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create an identity",
          "action": "Create an identity"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "identify"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "event",
      "options": [
        {
          "name": "Event",
          "value": "event",
          "description": "Record the actions your users perform. Every action triggers an event, which can also have associated properties.",
          "action": "Track an event"
        },
        {
          "name": "Page",
          "value": "page",
          "description": "Record page views on your website, along with optional extra information about the page being viewed",
          "action": "Track a page"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "track"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "User ID",
      "name": "userId",
      "type": "string",
      "default": "",
      "displayOptions": {
        "show": {
          "resource": [
            "identify"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Traits",
      "name": "traits",
      "type": "fixedCollection",
      "default": {},
      "options": [
        {
          "name": "traitsUi",
          "displayName": "Trait",
          "values": [
            {
              "displayName": "Key",
              "name": "key",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "Value",
              "name": "value",
              "type": "string",
              "default": ""
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "identify"
          ],
          "operation": [
            "create"
          ]
        }
      },
      "typeOptions": {
        "multipleValues": true
      }
    },
    {
      "displayName": "Context",
      "name": "context",
      "type": "fixedCollection",
      "default": {},
      "options": [
        {
          "name": "contextUi",
          "displayName": "Context",
          "values": [
            {
              "displayName": "Active",
              "name": "active",
              "type": "boolean",
              "default": false,
              "description": "Whether a user is active"
            },
            {
              "displayName": "IP",
              "name": "ip",
              "type": "string",
              "default": "",
              "description": "Current user’s IP address"
            },
            {
              "displayName": "Locale",
              "name": "locate",
              "type": "string",
              "default": "",
              "description": "Locale string for the current user, for example en-US"
            },
            {
              "displayName": "Page",
              "name": "page",
              "type": "string",
              "default": "",
              "description": "Dictionary of information about the current page in the browser, containing hash, path, referrer, search, title and URL"
            },
            {
              "displayName": "Timezone",
              "name": "timezone",
              "type": "string",
              "default": "",
              "description": "Timezones are sent as tzdata strings to add user timezone information which might be stripped from the timestamp, for example America/New_York"
            },
            {
              "displayName": "App",
              "name": "app",
              "placeholder": "Add App",
              "type": "fixedCollection",
              "typeOptions": {
                "multipleValues": false
              },
              "default": {},
              "options": [
                {
                  "name": "appUi",
                  "displayName": "App",
                  "values": [
                    {
                      "displayName": "Name",
                      "name": "name",
                      "type": "string",
                      "default": ""
                    },
                    {
                      "displayName": "Version",
                      "name": "version",
                      "type": "string",
                      "default": ""
                    },
                    {
                      "displayName": "Build",
                      "name": "build",
                      "type": "string",
                      "default": ""
                    }
                  ]
                }
              ]
            },
            {
              "displayName": "Campaign",
              "name": "campaign",
              "placeholder": "Campaign App",
              "type": "fixedCollection",
              "typeOptions": {
                "multipleValues": false
              },
              "default": {},
              "options": [
                {
                  "name": "campaignUi",
                  "displayName": "Campaign",
                  "values": [
                    {
                      "displayName": "Name",
                      "name": "name",
                      "type": "string",
                      "default": ""
                    },
                    {
                      "displayName": "Source",
                      "name": "source",
                      "type": "string",
                      "default": ""
                    },
                    {
                      "displayName": "Medium",
                      "name": "medium",
                      "type": "string",
                      "default": ""
                    },
                    {
                      "displayName": "Term",
                      "name": "term",
                      "type": "string",
                      "default": ""
                    },
                    {
                      "displayName": "Content",
                      "name": "content",
                      "type": "string",
                      "default": ""
                    }
                  ]
                }
              ]
            },
            {
              "displayName": "Device",
              "name": "device",
              "placeholder": "Add Device",
              "type": "fixedCollection",
              "typeOptions": {
                "multipleValues": false
              },
              "default": {},
              "options": [
                {
                  "name": "deviceUi",
                  "displayName": "Device",
                  "values": [
                    {
                      "displayName": "ID",
                      "name": "id",
                      "type": "string",
                      "default": ""
                    },
                    {
                      "displayName": "Manufacturer",
                      "name": "manufacturer",
                      "type": "string",
                      "default": ""
                    },
                    {
                      "displayName": "Model",
                      "name": "model",
                      "type": "string",
                      "default": ""
                    },
                    {
                      "displayName": "Name",
                      "name": "name",
                      "type": "string",
                      "default": ""
                    },
                    {
                      "displayName": "Type",
                      "name": "type",
                      "type": "string",
                      "default": ""
                    },
                    {
                      "displayName": "Version",
                      "name": "version",
                      "type": "string",
                      "default": ""
                    }
                  ]
                }
              ]
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "identify"
          ],
          "operation": [
            "create"
          ]
        }
      },
      "typeOptions": {
        "multipleValues": false
      }
    },
    {
      "displayName": "Integration",
      "name": "integrations",
      "type": "fixedCollection",
      "default": {},
      "options": [
        {
          "name": "integrationsUi",
          "displayName": "Integration",
          "values": [
            {
              "displayName": "All",
              "name": "all",
              "type": "boolean",
              "default": true
            },
            {
              "displayName": "Salesforce",
              "name": "salesforce",
              "type": "boolean",
              "default": false
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "identify"
          ],
          "operation": [
            "create"
          ]
        }
      },
      "typeOptions": {
        "multipleValues": false
      }
    },
    {
      "displayName": "User ID",
      "name": "userId",
      "type": "string",
      "default": "",
      "displayOptions": {
        "show": {
          "resource": [
            "track"
          ],
          "operation": [
            "event"
          ]
        }
      }
    },
    {
      "displayName": "Event",
      "name": "event",
      "type": "string",
      "default": "",
      "description": "Name of the action that a user has performed",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "track"
          ],
          "operation": [
            "event"
          ]
        }
      }
    },
    {
      "displayName": "Context",
      "name": "context",
      "type": "fixedCollection",
      "default": {},
      "options": [
        {
          "name": "contextUi",
          "displayName": "Context",
          "values": [
            {
              "displayName": "Active",
              "name": "active",
              "type": "boolean",
              "default": false,
              "description": "Whether a user is active"
            },
            {
              "displayName": "IP",
              "name": "ip",
              "type": "string",
              "default": "",
              "description": "Current user’s IP address"
            },
            {
              "displayName": "Locale",
              "name": "locate",
              "type": "string",
              "default": "",
              "description": "Locale string for the current user, for example en-US"
            },
            {
              "displayName": "Page",
              "name": "page",
              "type": "string",
              "default": "",
              "description": "Dictionary of information about the current page in the browser, containing hash, path, referrer, search, title and URL"
            },
            {
              "displayName": "Timezone",
              "name": "timezone",
              "type": "string",
              "default": "",
              "description": "Timezones are sent as tzdata strings to add user timezone information which might be stripped from the timestamp, for example America/New_York"
            },
            {
              "displayName": "App",
              "name": "app",
              "placeholder": "Add App",
              "type": "fixedCollection",
              "typeOptions": {
                "multipleValues": false
              },
              "default": {},
              "options": [
                {
                  "name": "appUi",
                  "displayName": "App",
                  "values": [
                    {
                      "displayName": "Name",
                      "name": "name",
                      "type": "string",
                      "default": ""
                    },
                    {
                      "displayName": "Version",
                      "name": "version",
                      "type": "string",
                      "default": ""
                    },
                    {
                      "displayName": "Build",
                      "name": "build",
                      "type": "string",
                      "default": ""
                    }
                  ]
                }
              ]
            },
            {
              "displayName": "Campaign",
              "name": "campaign",
              "placeholder": "Campaign App",
              "type": "fixedCollection",
              "typeOptions": {
                "multipleValues": false
              },
              "default": {},
              "options": [
                {
                  "name": "campaignUi",
                  "displayName": "Campaign",
                  "values": [
                    {
                      "displayName": "Name",
                      "name": "name",
                      "type": "string",
                      "default": ""
                    },
                    {
                      "displayName": "Source",
                      "name": "source",
                      "type": "string",
                      "default": ""
                    },
                    {
                      "displayName": "Medium",
                      "name": "medium",
                      "type": "string",
                      "default": ""
                    },
                    {
                      "displayName": "Term",
                      "name": "term",
                      "type": "string",
                      "default": ""
                    },
                    {
                      "displayName": "Content",
                      "name": "content",
                      "type": "string",
                      "default": ""
                    }
                  ]
                }
              ]
            },
            {
              "displayName": "Device",
              "name": "device",
              "placeholder": "Add Device",
              "type": "fixedCollection",
              "typeOptions": {
                "multipleValues": false
              },
              "default": {},
              "options": [
                {
                  "name": "deviceUi",
                  "displayName": "Device",
                  "values": [
                    {
                      "displayName": "ID",
                      "name": "id",
                      "type": "string",
                      "default": ""
                    },
                    {
                      "displayName": "Manufacturer",
                      "name": "manufacturer",
                      "type": "string",
                      "default": ""
                    },
                    {
                      "displayName": "Model",
                      "name": "model",
                      "type": "string",
                      "default": ""
                    },
                    {
                      "displayName": "Name",
                      "name": "name",
                      "type": "string",
                      "default": ""
                    },
                    {
                      "displayName": "Type",
                      "name": "type",
                      "type": "string",
                      "default": ""
                    },
                    {
                      "displayName": "Version",
                      "name": "version",
                      "type": "string",
                      "default": ""
                    }
                  ]
                }
              ]
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "track"
          ],
          "operation": [
            "event"
          ]
        }
      },
      "typeOptions": {
        "multipleValues": false
      }
    },
    {
      "displayName": "Integration",
      "name": "integrations",
      "type": "fixedCollection",
      "default": {},
      "options": [
        {
          "name": "integrationsUi",
          "displayName": "Integration",
          "values": [
            {
              "displayName": "All",
              "name": "all",
              "type": "boolean",
              "default": true
            },
            {
              "displayName": "Salesforce",
              "name": "salesforce",
              "type": "boolean",
              "default": false
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "track"
          ],
          "operation": [
            "event"
          ]
        }
      },
      "typeOptions": {
        "multipleValues": false
      }
    },
    {
      "displayName": "Properties",
      "name": "properties",
      "type": "fixedCollection",
      "default": {},
      "options": [
        {
          "name": "propertiesUi",
          "displayName": "Property",
          "values": [
            {
              "displayName": "Key",
              "name": "key",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "Value",
              "name": "value",
              "type": "string",
              "default": ""
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "track"
          ],
          "operation": [
            "event"
          ]
        }
      },
      "typeOptions": {
        "multipleValues": true
      }
    },
    {
      "displayName": "User ID",
      "name": "userId",
      "type": "string",
      "default": "",
      "displayOptions": {
        "show": {
          "resource": [
            "track"
          ],
          "operation": [
            "page"
          ]
        }
      }
    },
    {
      "displayName": "Name",
      "name": "name",
      "type": "string",
      "default": "",
      "description": "Name of the page For example, most sites have a “Signup” page that can be useful to tag, so you can see users as they move through your funnel",
      "displayOptions": {
        "show": {
          "resource": [
            "track"
          ],
          "operation": [
            "page"
          ]
        }
      }
    },
    {
      "displayName": "Context",
      "name": "context",
      "type": "fixedCollection",
      "default": {},
      "options": [
        {
          "name": "contextUi",
          "displayName": "Context",
          "values": [
            {
              "displayName": "Active",
              "name": "active",
              "type": "boolean",
              "default": false,
              "description": "Whether a user is active"
            },
            {
              "displayName": "IP",
              "name": "ip",
              "type": "string",
              "default": "",
              "description": "Current user’s IP address"
            },
            {
              "displayName": "Locale",
              "name": "locate",
              "type": "string",
              "default": "",
              "description": "Locale string for the current user, for example en-US"
            },
            {
              "displayName": "Page",
              "name": "page",
              "type": "string",
              "default": "",
              "description": "Dictionary of information about the current page in the browser, containing hash, path, referrer, search, title and URL"
            },
            {
              "displayName": "Timezone",
              "name": "timezone",
              "type": "string",
              "default": "",
              "description": "Timezones are sent as tzdata strings to add user timezone information which might be stripped from the timestamp, for example America/New_York"
            },
            {
              "displayName": "App",
              "name": "app",
              "placeholder": "Add App",
              "type": "fixedCollection",
              "typeOptions": {
                "multipleValues": false
              },
              "default": {},
              "options": [
                {
                  "name": "appUi",
                  "displayName": "App",
                  "values": [
                    {
                      "displayName": "Name",
                      "name": "name",
                      "type": "string",
                      "default": ""
                    },
                    {
                      "displayName": "Version",
                      "name": "version",
                      "type": "string",
                      "default": ""
                    },
                    {
                      "displayName": "Build",
                      "name": "build",
                      "type": "string",
                      "default": ""
                    }
                  ]
                }
              ]
            },
            {
              "displayName": "Campaign",
              "name": "campaign",
              "placeholder": "Campaign App",
              "type": "fixedCollection",
              "typeOptions": {
                "multipleValues": false
              },
              "default": {},
              "options": [
                {
                  "name": "campaignUi",
                  "displayName": "Campaign",
                  "values": [
                    {
                      "displayName": "Name",
                      "name": "name",
                      "type": "string",
                      "default": ""
                    },
                    {
                      "displayName": "Source",
                      "name": "source",
                      "type": "string",
                      "default": ""
                    },
                    {
                      "displayName": "Medium",
                      "name": "medium",
                      "type": "string",
                      "default": ""
                    },
                    {
                      "displayName": "Term",
                      "name": "term",
                      "type": "string",
                      "default": ""
                    },
                    {
                      "displayName": "Content",
                      "name": "content",
                      "type": "string",
                      "default": ""
                    }
                  ]
                }
              ]
            },
            {
              "displayName": "Device",
              "name": "device",
              "placeholder": "Add Device",
              "type": "fixedCollection",
              "typeOptions": {
                "multipleValues": false
              },
              "default": {},
              "options": [
                {
                  "name": "deviceUi",
                  "displayName": "Device",
                  "values": [
                    {
                      "displayName": "ID",
                      "name": "id",
                      "type": "string",
                      "default": ""
                    },
                    {
                      "displayName": "Manufacturer",
                      "name": "manufacturer",
                      "type": "string",
                      "default": ""
                    },
                    {
                      "displayName": "Model",
                      "name": "model",
                      "type": "string",
                      "default": ""
                    },
                    {
                      "displayName": "Name",
                      "name": "name",
                      "type": "string",
                      "default": ""
                    },
                    {
                      "displayName": "Type",
                      "name": "type",
                      "type": "string",
                      "default": ""
                    },
                    {
                      "displayName": "Version",
                      "name": "version",
                      "type": "string",
                      "default": ""
                    }
                  ]
                }
              ]
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "track"
          ],
          "operation": [
            "page"
          ]
        }
      },
      "typeOptions": {
        "multipleValues": false
      }
    },
    {
      "displayName": "Integration",
      "name": "integrations",
      "type": "fixedCollection",
      "default": {},
      "options": [
        {
          "name": "integrationsUi",
          "displayName": "Integration",
          "values": [
            {
              "displayName": "All",
              "name": "all",
              "type": "boolean",
              "default": true
            },
            {
              "displayName": "Salesforce",
              "name": "salesforce",
              "type": "boolean",
              "default": false
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "track"
          ],
          "operation": [
            "page"
          ]
        }
      },
      "typeOptions": {
        "multipleValues": false
      }
    },
    {
      "displayName": "Properties",
      "name": "properties",
      "type": "fixedCollection",
      "default": {},
      "options": [
        {
          "name": "propertiesUi",
          "displayName": "Property",
          "values": [
            {
              "displayName": "Key",
              "name": "key",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "Value",
              "name": "value",
              "type": "string",
              "default": ""
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "track"
          ],
          "operation": [
            "page"
          ]
        }
      },
      "typeOptions": {
        "multipleValues": true
      }
    }
  ]

operations:
  [
    {
      "operation": "add",
      "name": "Add",
      "description": "Add a user to a group",
      "resource": "group"
    },
    {
      "operation": "create",
      "name": "Create",
      "description": "Create an identity",
      "resource": "identify"
    },
    {
      "operation": "event",
      "name": "Event",
      "description": "Record the actions your users perform. Every action triggers an event, which can also have associated properties.",
      "resource": "track"
    },
    {
      "operation": "page",
      "name": "Page",
      "description": "Record page views on your website, along with optional extra information about the page being viewed",
      "resource": "track"
    }
  ]


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

outputs:
  [
  "main"
  ]

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

  # Segment node

  Use the Segment node to automate work in Segment, and integrate Segment with other applications. n8n has built-in support for a wide range of Segment features, including adding users to groups, creating identities, and tracking activities. 

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

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

  ## Operations

  * Group
      * Add a user to a group
  * Identify
      * Create an identity
  * Track
      * Record the actions your users perform. Every action triggers an event, which can also have associated properties.
      * Record page views on your website, along with optional extra information about the page being viewed.

  ## Templates and examples

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

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

properties_schema:
  [
    {
      "displayName": "Resource",
      "name": "resource",
      "type": "options",
      "default": "identify",
      "options": [
        {
          "name": "Group",
          "value": "group",
          "description": "Group lets you associate an identified user with a group"
        },
        {
          "name": "Identify",
          "value": "identify",
          "description": "Identify lets you tie a user to their actions"
        },
        {
          "name": "Track",
          "value": "track",
          "description": "Track lets you record events"
        }
      ],
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "add",
      "options": [
        {
          "name": "Add",
          "value": "add",
          "description": "Add a user to a group",
          "action": "Add a user to a group"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "group"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "User ID",
      "name": "userId",
      "type": "string",
      "default": "",
      "displayOptions": {
        "show": {
          "resource": [
            "group"
          ],
          "operation": [
            "add"
          ]
        }
      }
    },
    {
      "displayName": "Group ID",
      "name": "groupId",
      "type": "string",
      "default": "",
      "description": "A Group ID is the unique identifier which you recognize a group by in your own database",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "group"
          ],
          "operation": [
            "add"
          ]
        }
      }
    },
    {
      "displayName": "Traits",
      "name": "traits",
      "type": "fixedCollection",
      "default": {},
      "options": [
        {
          "name": "traitsUi",
          "displayName": "Trait",
          "values": [
            {
              "displayName": "Key",
              "name": "key",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "Value",
              "name": "value",
              "type": "string",
              "default": ""
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "group"
          ],
          "operation": [
            "add"
          ]
        }
      },
      "typeOptions": {
        "multipleValues": true
      }
    },
    {
      "displayName": "Context",
      "name": "context",
      "type": "fixedCollection",
      "default": {},
      "options": [
        {
          "name": "contextUi",
          "displayName": "Context",
          "values": [
            {
              "displayName": "Active",
              "name": "active",
              "type": "boolean",
              "default": false,
              "description": "Whether a user is active"
            },
            {
              "displayName": "IP",
              "name": "ip",
              "type": "string",
              "default": "",
              "description": "Current user’s IP address"
            },
            {
              "displayName": "Locale",
              "name": "locate",
              "type": "string",
              "default": "",
              "description": "Locale string for the current user, for example en-US"
            },
            {
              "displayName": "Page",
              "name": "page",
              "type": "string",
              "default": "",
              "description": "Dictionary of information about the current page in the browser, containing hash, path, referrer, search, title and URL"
            },
            {
              "displayName": "Timezone",
              "name": "timezone",
              "type": "string",
              "default": "",
              "description": "Timezones are sent as tzdata strings to add user timezone information which might be stripped from the timestamp, for example America/New_York"
            },
            {
              "displayName": "App",
              "name": "app",
              "placeholder": "Add App",
              "type": "fixedCollection",
              "typeOptions": {
                "multipleValues": false
              },
              "default": {},
              "options": [
                {
                  "name": "appUi",
                  "displayName": "App",
                  "values": [
                    {
                      "displayName": "Name",
                      "name": "name",
                      "type": "string",
                      "default": ""
                    },
                    {
                      "displayName": "Version",
                      "name": "version",
                      "type": "string",
                      "default": ""
                    },
                    {
                      "displayName": "Build",
                      "name": "build",
                      "type": "string",
                      "default": ""
                    }
                  ]
                }
              ]
            },
            {
              "displayName": "Campaign",
              "name": "campaign",
              "placeholder": "Campaign App",
              "type": "fixedCollection",
              "typeOptions": {
                "multipleValues": false
              },
              "default": {},
              "options": [
                {
                  "name": "campaignUi",
                  "displayName": "Campaign",
                  "values": [
                    {
                      "displayName": "Name",
                      "name": "name",
                      "type": "string",
                      "default": ""
                    },
                    {
                      "displayName": "Source",
                      "name": "source",
                      "type": "string",
                      "default": ""
                    },
                    {
                      "displayName": "Medium",
                      "name": "medium",
                      "type": "string",
                      "default": ""
                    },
                    {
                      "displayName": "Term",
                      "name": "term",
                      "type": "string",
                      "default": ""
                    },
                    {
                      "displayName": "Content",
                      "name": "content",
                      "type": "string",
                      "default": ""
                    }
                  ]
                }
              ]
            },
            {
              "displayName": "Device",
              "name": "device",
              "placeholder": "Add Device",
              "type": "fixedCollection",
              "typeOptions": {
                "multipleValues": false
              },
              "default": {},
              "options": [
                {
                  "name": "deviceUi",
                  "displayName": "Device",
                  "values": [
                    {
                      "displayName": "ID",
                      "name": "id",
                      "type": "string",
                      "default": ""
                    },
                    {
                      "displayName": "Manufacturer",
                      "name": "manufacturer",
                      "type": "string",
                      "default": ""
                    },
                    {
                      "displayName": "Model",
                      "name": "model",
                      "type": "string",
                      "default": ""
                    },
                    {
                      "displayName": "Name",
                      "name": "name",
                      "type": "string",
                      "default": ""
                    },
                    {
                      "displayName": "Type",
                      "name": "type",
                      "type": "string",
                      "default": ""
                    },
                    {
                      "displayName": "Version",
                      "name": "version",
                      "type": "string",
                      "default": ""
                    }
                  ]
                }
              ]
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "group"
          ],
          "operation": [
            "add"
          ]
        }
      },
      "typeOptions": {
        "multipleValues": false
      }
    },
    {
      "displayName": "Integration",
      "name": "integrations",
      "type": "fixedCollection",
      "default": {},
      "options": [
        {
          "name": "integrationsUi",
          "displayName": "Integration",
          "values": [
            {
              "displayName": "All",
              "name": "all",
              "type": "boolean",
              "default": true
            },
            {
              "displayName": "Salesforce",
              "name": "salesforce",
              "type": "boolean",
              "default": false
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "group"
          ],
          "operation": [
            "add"
          ]
        }
      },
      "typeOptions": {
        "multipleValues": false
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create an identity",
          "action": "Create an identity"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "identify"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "event",
      "options": [
        {
          "name": "Event",
          "value": "event",
          "description": "Record the actions your users perform. Every action triggers an event, which can also have associated properties.",
          "action": "Track an event"
        },
        {
          "name": "Page",
          "value": "page",
          "description": "Record page views on your website, along with optional extra information about the page being viewed",
          "action": "Track a page"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "track"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "User ID",
      "name": "userId",
      "type": "string",
      "default": "",
      "displayOptions": {
        "show": {
          "resource": [
            "identify"
          ],
          "operation": [
            "create"
          ]
        }
      }
    },
    {
      "displayName": "Traits",
      "name": "traits",
      "type": "fixedCollection",
      "default": {},
      "options": [
        {
          "name": "traitsUi",
          "displayName": "Trait",
          "values": [
            {
              "displayName": "Key",
              "name": "key",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "Value",
              "name": "value",
              "type": "string",
              "default": ""
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "identify"
          ],
          "operation": [
            "create"
          ]
        }
      },
      "typeOptions": {
        "multipleValues": true
      }
    },
    {
      "displayName": "Context",
      "name": "context",
      "type": "fixedCollection",
      "default": {},
      "options": [
        {
          "name": "contextUi",
          "displayName": "Context",
          "values": [
            {
              "displayName": "Active",
              "name": "active",
              "type": "boolean",
              "default": false,
              "description": "Whether a user is active"
            },
            {
              "displayName": "IP",
              "name": "ip",
              "type": "string",
              "default": "",
              "description": "Current user’s IP address"
            },
            {
              "displayName": "Locale",
              "name": "locate",
              "type": "string",
              "default": "",
              "description": "Locale string for the current user, for example en-US"
            },
            {
              "displayName": "Page",
              "name": "page",
              "type": "string",
              "default": "",
              "description": "Dictionary of information about the current page in the browser, containing hash, path, referrer, search, title and URL"
            },
            {
              "displayName": "Timezone",
              "name": "timezone",
              "type": "string",
              "default": "",
              "description": "Timezones are sent as tzdata strings to add user timezone information which might be stripped from the timestamp, for example America/New_York"
            },
            {
              "displayName": "App",
              "name": "app",
              "placeholder": "Add App",
              "type": "fixedCollection",
              "typeOptions": {
                "multipleValues": false
              },
              "default": {},
              "options": [
                {
                  "name": "appUi",
                  "displayName": "App",
                  "values": [
                    {
                      "displayName": "Name",
                      "name": "name",
                      "type": "string",
                      "default": ""
                    },
                    {
                      "displayName": "Version",
                      "name": "version",
                      "type": "string",
                      "default": ""
                    },
                    {
                      "displayName": "Build",
                      "name": "build",
                      "type": "string",
                      "default": ""
                    }
                  ]
                }
              ]
            },
            {
              "displayName": "Campaign",
              "name": "campaign",
              "placeholder": "Campaign App",
              "type": "fixedCollection",
              "typeOptions": {
                "multipleValues": false
              },
              "default": {},
              "options": [
                {
                  "name": "campaignUi",
                  "displayName": "Campaign",
                  "values": [
                    {
                      "displayName": "Name",
                      "name": "name",
                      "type": "string",
                      "default": ""
                    },
                    {
                      "displayName": "Source",
                      "name": "source",
                      "type": "string",
                      "default": ""
                    },
                    {
                      "displayName": "Medium",
                      "name": "medium",
                      "type": "string",
                      "default": ""
                    },
                    {
                      "displayName": "Term",
                      "name": "term",
                      "type": "string",
                      "default": ""
                    },
                    {
                      "displayName": "Content",
                      "name": "content",
                      "type": "string",
                      "default": ""
                    }
                  ]
                }
              ]
            },
            {
              "displayName": "Device",
              "name": "device",
              "placeholder": "Add Device",
              "type": "fixedCollection",
              "typeOptions": {
                "multipleValues": false
              },
              "default": {},
              "options": [
                {
                  "name": "deviceUi",
                  "displayName": "Device",
                  "values": [
                    {
                      "displayName": "ID",
                      "name": "id",
                      "type": "string",
                      "default": ""
                    },
                    {
                      "displayName": "Manufacturer",
                      "name": "manufacturer",
                      "type": "string",
                      "default": ""
                    },
                    {
                      "displayName": "Model",
                      "name": "model",
                      "type": "string",
                      "default": ""
                    },
                    {
                      "displayName": "Name",
                      "name": "name",
                      "type": "string",
                      "default": ""
                    },
                    {
                      "displayName": "Type",
                      "name": "type",
                      "type": "string",
                      "default": ""
                    },
                    {
                      "displayName": "Version",
                      "name": "version",
                      "type": "string",
                      "default": ""
                    }
                  ]
                }
              ]
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "identify"
          ],
          "operation": [
            "create"
          ]
        }
      },
      "typeOptions": {
        "multipleValues": false
      }
    },
    {
      "displayName": "Integration",
      "name": "integrations",
      "type": "fixedCollection",
      "default": {},
      "options": [
        {
          "name": "integrationsUi",
          "displayName": "Integration",
          "values": [
            {
              "displayName": "All",
              "name": "all",
              "type": "boolean",
              "default": true
            },
            {
              "displayName": "Salesforce",
              "name": "salesforce",
              "type": "boolean",
              "default": false
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "identify"
          ],
          "operation": [
            "create"
          ]
        }
      },
      "typeOptions": {
        "multipleValues": false
      }
    },
    {
      "displayName": "User ID",
      "name": "userId",
      "type": "string",
      "default": "",
      "displayOptions": {
        "show": {
          "resource": [
            "track"
          ],
          "operation": [
            "event"
          ]
        }
      }
    },
    {
      "displayName": "Event",
      "name": "event",
      "type": "string",
      "default": "",
      "description": "Name of the action that a user has performed",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "track"
          ],
          "operation": [
            "event"
          ]
        }
      }
    },
    {
      "displayName": "Context",
      "name": "context",
      "type": "fixedCollection",
      "default": {},
      "options": [
        {
          "name": "contextUi",
          "displayName": "Context",
          "values": [
            {
              "displayName": "Active",
              "name": "active",
              "type": "boolean",
              "default": false,
              "description": "Whether a user is active"
            },
            {
              "displayName": "IP",
              "name": "ip",
              "type": "string",
              "default": "",
              "description": "Current user’s IP address"
            },
            {
              "displayName": "Locale",
              "name": "locate",
              "type": "string",
              "default": "",
              "description": "Locale string for the current user, for example en-US"
            },
            {
              "displayName": "Page",
              "name": "page",
              "type": "string",
              "default": "",
              "description": "Dictionary of information about the current page in the browser, containing hash, path, referrer, search, title and URL"
            },
            {
              "displayName": "Timezone",
              "name": "timezone",
              "type": "string",
              "default": "",
              "description": "Timezones are sent as tzdata strings to add user timezone information which might be stripped from the timestamp, for example America/New_York"
            },
            {
              "displayName": "App",
              "name": "app",
              "placeholder": "Add App",
              "type": "fixedCollection",
              "typeOptions": {
                "multipleValues": false
              },
              "default": {},
              "options": [
                {
                  "name": "appUi",
                  "displayName": "App",
                  "values": [
                    {
                      "displayName": "Name",
                      "name": "name",
                      "type": "string",
                      "default": ""
                    },
                    {
                      "displayName": "Version",
                      "name": "version",
                      "type": "string",
                      "default": ""
                    },
                    {
                      "displayName": "Build",
                      "name": "build",
                      "type": "string",
                      "default": ""
                    }
                  ]
                }
              ]
            },
            {
              "displayName": "Campaign",
              "name": "campaign",
              "placeholder": "Campaign App",
              "type": "fixedCollection",
              "typeOptions": {
                "multipleValues": false
              },
              "default": {},
              "options": [
                {
                  "name": "campaignUi",
                  "displayName": "Campaign",
                  "values": [
                    {
                      "displayName": "Name",
                      "name": "name",
                      "type": "string",
                      "default": ""
                    },
                    {
                      "displayName": "Source",
                      "name": "source",
                      "type": "string",
                      "default": ""
                    },
                    {
                      "displayName": "Medium",
                      "name": "medium",
                      "type": "string",
                      "default": ""
                    },
                    {
                      "displayName": "Term",
                      "name": "term",
                      "type": "string",
                      "default": ""
                    },
                    {
                      "displayName": "Content",
                      "name": "content",
                      "type": "string",
                      "default": ""
                    }
                  ]
                }
              ]
            },
            {
              "displayName": "Device",
              "name": "device",
              "placeholder": "Add Device",
              "type": "fixedCollection",
              "typeOptions": {
                "multipleValues": false
              },
              "default": {},
              "options": [
                {
                  "name": "deviceUi",
                  "displayName": "Device",
                  "values": [
                    {
                      "displayName": "ID",
                      "name": "id",
                      "type": "string",
                      "default": ""
                    },
                    {
                      "displayName": "Manufacturer",
                      "name": "manufacturer",
                      "type": "string",
                      "default": ""
                    },
                    {
                      "displayName": "Model",
                      "name": "model",
                      "type": "string",
                      "default": ""
                    },
                    {
                      "displayName": "Name",
                      "name": "name",
                      "type": "string",
                      "default": ""
                    },
                    {
                      "displayName": "Type",
                      "name": "type",
                      "type": "string",
                      "default": ""
                    },
                    {
                      "displayName": "Version",
                      "name": "version",
                      "type": "string",
                      "default": ""
                    }
                  ]
                }
              ]
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "track"
          ],
          "operation": [
            "event"
          ]
        }
      },
      "typeOptions": {
        "multipleValues": false
      }
    },
    {
      "displayName": "Integration",
      "name": "integrations",
      "type": "fixedCollection",
      "default": {},
      "options": [
        {
          "name": "integrationsUi",
          "displayName": "Integration",
          "values": [
            {
              "displayName": "All",
              "name": "all",
              "type": "boolean",
              "default": true
            },
            {
              "displayName": "Salesforce",
              "name": "salesforce",
              "type": "boolean",
              "default": false
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "track"
          ],
          "operation": [
            "event"
          ]
        }
      },
      "typeOptions": {
        "multipleValues": false
      }
    },
    {
      "displayName": "Properties",
      "name": "properties",
      "type": "fixedCollection",
      "default": {},
      "options": [
        {
          "name": "propertiesUi",
          "displayName": "Property",
          "values": [
            {
              "displayName": "Key",
              "name": "key",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "Value",
              "name": "value",
              "type": "string",
              "default": ""
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "track"
          ],
          "operation": [
            "event"
          ]
        }
      },
      "typeOptions": {
        "multipleValues": true
      }
    },
    {
      "displayName": "User ID",
      "name": "userId",
      "type": "string",
      "default": "",
      "displayOptions": {
        "show": {
          "resource": [
            "track"
          ],
          "operation": [
            "page"
          ]
        }
      }
    },
    {
      "displayName": "Name",
      "name": "name",
      "type": "string",
      "default": "",
      "description": "Name of the page For example, most sites have a “Signup” page that can be useful to tag, so you can see users as they move through your funnel",
      "displayOptions": {
        "show": {
          "resource": [
            "track"
          ],
          "operation": [
            "page"
          ]
        }
      }
    },
    {
      "displayName": "Context",
      "name": "context",
      "type": "fixedCollection",
      "default": {},
      "options": [
        {
          "name": "contextUi",
          "displayName": "Context",
          "values": [
            {
              "displayName": "Active",
              "name": "active",
              "type": "boolean",
              "default": false,
              "description": "Whether a user is active"
            },
            {
              "displayName": "IP",
              "name": "ip",
              "type": "string",
              "default": "",
              "description": "Current user’s IP address"
            },
            {
              "displayName": "Locale",
              "name": "locate",
              "type": "string",
              "default": "",
              "description": "Locale string for the current user, for example en-US"
            },
            {
              "displayName": "Page",
              "name": "page",
              "type": "string",
              "default": "",
              "description": "Dictionary of information about the current page in the browser, containing hash, path, referrer, search, title and URL"
            },
            {
              "displayName": "Timezone",
              "name": "timezone",
              "type": "string",
              "default": "",
              "description": "Timezones are sent as tzdata strings to add user timezone information which might be stripped from the timestamp, for example America/New_York"
            },
            {
              "displayName": "App",
              "name": "app",
              "placeholder": "Add App",
              "type": "fixedCollection",
              "typeOptions": {
                "multipleValues": false
              },
              "default": {},
              "options": [
                {
                  "name": "appUi",
                  "displayName": "App",
                  "values": [
                    {
                      "displayName": "Name",
                      "name": "name",
                      "type": "string",
                      "default": ""
                    },
                    {
                      "displayName": "Version",
                      "name": "version",
                      "type": "string",
                      "default": ""
                    },
                    {
                      "displayName": "Build",
                      "name": "build",
                      "type": "string",
                      "default": ""
                    }
                  ]
                }
              ]
            },
            {
              "displayName": "Campaign",
              "name": "campaign",
              "placeholder": "Campaign App",
              "type": "fixedCollection",
              "typeOptions": {
                "multipleValues": false
              },
              "default": {},
              "options": [
                {
                  "name": "campaignUi",
                  "displayName": "Campaign",
                  "values": [
                    {
                      "displayName": "Name",
                      "name": "name",
                      "type": "string",
                      "default": ""
                    },
                    {
                      "displayName": "Source",
                      "name": "source",
                      "type": "string",
                      "default": ""
                    },
                    {
                      "displayName": "Medium",
                      "name": "medium",
                      "type": "string",
                      "default": ""
                    },
                    {
                      "displayName": "Term",
                      "name": "term",
                      "type": "string",
                      "default": ""
                    },
                    {
                      "displayName": "Content",
                      "name": "content",
                      "type": "string",
                      "default": ""
                    }
                  ]
                }
              ]
            },
            {
              "displayName": "Device",
              "name": "device",
              "placeholder": "Add Device",
              "type": "fixedCollection",
              "typeOptions": {
                "multipleValues": false
              },
              "default": {},
              "options": [
                {
                  "name": "deviceUi",
                  "displayName": "Device",
                  "values": [
                    {
                      "displayName": "ID",
                      "name": "id",
                      "type": "string",
                      "default": ""
                    },
                    {
                      "displayName": "Manufacturer",
                      "name": "manufacturer",
                      "type": "string",
                      "default": ""
                    },
                    {
                      "displayName": "Model",
                      "name": "model",
                      "type": "string",
                      "default": ""
                    },
                    {
                      "displayName": "Name",
                      "name": "name",
                      "type": "string",
                      "default": ""
                    },
                    {
                      "displayName": "Type",
                      "name": "type",
                      "type": "string",
                      "default": ""
                    },
                    {
                      "displayName": "Version",
                      "name": "version",
                      "type": "string",
                      "default": ""
                    }
                  ]
                }
              ]
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "track"
          ],
          "operation": [
            "page"
          ]
        }
      },
      "typeOptions": {
        "multipleValues": false
      }
    },
    {
      "displayName": "Integration",
      "name": "integrations",
      "type": "fixedCollection",
      "default": {},
      "options": [
        {
          "name": "integrationsUi",
          "displayName": "Integration",
          "values": [
            {
              "displayName": "All",
              "name": "all",
              "type": "boolean",
              "default": true
            },
            {
              "displayName": "Salesforce",
              "name": "salesforce",
              "type": "boolean",
              "default": false
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "track"
          ],
          "operation": [
            "page"
          ]
        }
      },
      "typeOptions": {
        "multipleValues": false
      }
    },
    {
      "displayName": "Properties",
      "name": "properties",
      "type": "fixedCollection",
      "default": {},
      "options": [
        {
          "name": "propertiesUi",
          "displayName": "Property",
          "values": [
            {
              "displayName": "Key",
              "name": "key",
              "type": "string",
              "default": ""
            },
            {
              "displayName": "Value",
              "name": "value",
              "type": "string",
              "default": ""
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "track"
          ],
          "operation": [
            "page"
          ]
        }
      },
      "typeOptions": {
        "multipleValues": true
      }
    }
  ]

operations:
  [
    {
      "operation": "add",
      "name": "Add",
      "description": "Add a user to a group",
      "resource": "group"
    },
    {
      "operation": "create",
      "name": "Create",
      "description": "Create an identity",
      "resource": "identify"
    },
    {
      "operation": "event",
      "name": "Event",
      "description": "Record the actions your users perform. Every action triggers an event, which can also have associated properties.",
      "resource": "track"
    },
    {
      "operation": "page",
      "name": "Page",
      "description": "Record page views on your website, along with optional extra information about the page being viewed",
      "resource": "track"
    }
  ]


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

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

output_names:
  [
  "Tool"
  ]

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

  # SendGrid node

  Use the SendGrid node to automate work in SendGrid, and integrate SendGrid with other applications. n8n has built-in support for a wide range of SendGrid features, including creating, updating, deleting, and getting contacts, and lists, as well as sending emails. 

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

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

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

  ## Operations

  * Contact
      * Create/update a contact
      * Delete a contact
      * Get a contact by ID
      * Get all contacts
  * List
      * Create a list
      * Delete a list
      * Get a list
      * Get all lists
      * Update a list
  * Mail
      * Send an email.

  ## Templates and examples

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

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

properties_schema:
  [
    {
      "displayName": "Tool Description",
      "name": "toolDescription",
      "type": "string",
      "default": "",
      "required": false,
      "description": "Description for the AI to understand what this tool does and when to use it",
      "typeOptions": {
        "rows": 3
      },
      "placeholder": "e.g., Use this tool to interact with SendGrid"
    },
    {
      "displayName": "Resource",
      "name": "resource",
      "type": "options",
      "default": "list",
      "options": [
        {
          "name": "Contact",
          "value": "contact"
        },
        {
          "name": "List",
          "value": "list"
        },
        {
          "name": "Mail",
          "value": "mail"
        }
      ],
      "required": true,
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create a list",
          "action": "Create a list"
        },
        {
          "name": "Delete",
          "value": "delete",
          "description": "Delete a list",
          "action": "Delete a list"
        },
        {
          "name": "Get",
          "value": "get",
          "description": "Get a list",
          "action": "Get a list"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get many lists",
          "action": "Get many lists"
        },
        {
          "name": "Update",
          "value": "update",
          "description": "Update a list",
          "action": "Update a list"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "list"
          ]
        }
      },
      "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": [
            "list"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 100,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "list"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 1000
      }
    },
    {
      "displayName": "Name",
      "name": "name",
      "type": "string",
      "default": "",
      "description": "Name of the list",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "create"
          ],
          "resource": [
            "list"
          ]
        }
      }
    },
    {
      "displayName": "List ID",
      "name": "listId",
      "type": "string",
      "default": "",
      "description": "ID of the list",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "delete"
          ],
          "resource": [
            "list"
          ]
        }
      }
    },
    {
      "displayName": "Delete Contacts",
      "name": "deleteContacts",
      "type": "boolean",
      "default": false,
      "description": "Whether to delete all contacts on the list",
      "displayOptions": {
        "show": {
          "operation": [
            "delete"
          ],
          "resource": [
            "list"
          ]
        }
      }
    },
    {
      "displayName": "List ID",
      "name": "listId",
      "type": "string",
      "default": "",
      "description": "ID of the list",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "get"
          ],
          "resource": [
            "list"
          ]
        }
      }
    },
    {
      "displayName": "Contact Sample",
      "name": "contactSample",
      "type": "boolean",
      "default": false,
      "description": "Whether to return the contact sample",
      "displayOptions": {
        "show": {
          "operation": [
            "get"
          ],
          "resource": [
            "list"
          ]
        }
      }
    },
    {
      "displayName": "List ID",
      "name": "listId",
      "type": "string",
      "default": "",
      "description": "ID of the list",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "update"
          ],
          "resource": [
            "list"
          ]
        }
      }
    },
    {
      "displayName": "Name",
      "name": "name",
      "type": "string",
      "default": "",
      "description": "Name of the list",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "update"
          ],
          "resource": [
            "list"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "upsert",
      "options": [
        {
          "name": "Create or Update",
          "value": "upsert",
          "description": "Create a new contact, or update the current one if it already exists (upsert)",
          "action": "Create or update a contact"
        },
        {
          "name": "Delete",
          "value": "delete",
          "description": "Delete a contact",
          "action": "Delete a contact"
        },
        {
          "name": "Get",
          "value": "get",
          "description": "Get a contact by ID",
          "action": "Get a contact"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get many contacts",
          "action": "Get many contacts"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "contact"
          ]
        }
      },
      "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": [
            "contact"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 100,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "contact"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 1000
      }
    },
    {
      "displayName": "Filters",
      "name": "filters",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Query",
          "name": "query",
          "type": "string",
          "default": "",
          "description": "The query field accepts valid <a href=\"https://sendgrid.com/docs/for-developers/sending-email/segmentation-query-language/\">SGQL</a> for searching for a contact"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "contact"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Email",
      "name": "email",
      "type": "string",
      "default": "",
      "description": "Primary email for the contact",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "upsert"
          ],
          "resource": [
            "contact"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Address",
          "name": "addressUi",
          "placeholder": "Address",
          "type": "fixedCollection",
          "typeOptions": {
            "multipleValues": false
          },
          "default": {},
          "options": [
            {
              "name": "addressValues",
              "displayName": "Address",
              "values": [
                {
                  "displayName": "Address Line 1",
                  "name": "address1",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Address Line 2",
                  "name": "address2",
                  "type": "string",
                  "default": ""
                }
              ]
            }
          ]
        },
        {
          "displayName": "Alternate Emails",
          "name": "alternateEmails",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "City",
          "name": "city",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Country",
          "name": "country",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "First Name",
          "name": "firstName",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Last Name",
          "name": "lastName",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Postal Code",
          "name": "postalCode",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "State/Province/Region",
          "name": "stateProvinceRegion",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "List IDs",
          "name": "listIdsUi",
          "placeholder": "List IDs",
          "description": "Adds a custom field to set also values which have not been predefined",
          "type": "fixedCollection",
          "default": {},
          "options": [
            {
              "name": "listIdValues",
              "displayName": "List IDs",
              "values": [
                {
                  "displayName": "List Names or IDs",
                  "name": "listIds",
                  "type": "multiOptions",
                  "typeOptions": {
                    "loadOptionsMethod": "getListIds"
                  },
                  "default": [],
                  "description": "ID of the field to set. Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
                }
              ]
            }
          ]
        },
        {
          "displayName": "Custom Fields",
          "name": "customFieldsUi",
          "placeholder": "Add Custom Fields",
          "description": "Adds custom fields",
          "type": "fixedCollection",
          "typeOptions": {
            "multipleValues": true
          },
          "default": {},
          "options": [
            {
              "name": "customFieldValues",
              "displayName": "Field",
              "values": [
                {
                  "displayName": "Field Name or ID",
                  "name": "fieldId",
                  "type": "options",
                  "typeOptions": {
                    "loadOptionsMethod": "getCustomFields"
                  },
                  "default": "",
                  "description": "ID of the field. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
                },
                {
                  "displayName": "Field Value",
                  "name": "fieldValue",
                  "type": "string",
                  "default": "",
                  "description": "Value for the field"
                }
              ]
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "contact"
          ],
          "operation": [
            "upsert"
          ]
        }
      }
    },
    {
      "displayName": "Contact IDs",
      "name": "ids",
      "type": "string",
      "default": "",
      "description": "ID of the contact. Multiple can be added separated by comma.",
      "displayOptions": {
        "show": {
          "resource": [
            "contact"
          ],
          "operation": [
            "delete"
          ],
          "deleteAll": [
            false
          ]
        }
      }
    },
    {
      "displayName": "Delete All",
      "name": "deleteAll",
      "type": "boolean",
      "default": false,
      "description": "Whether all contacts will be deleted",
      "displayOptions": {
        "show": {
          "resource": [
            "contact"
          ],
          "operation": [
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "By",
      "name": "by",
      "type": "options",
      "default": "id",
      "description": "Search the user by ID or email",
      "options": [
        {
          "name": "ID",
          "value": "id"
        },
        {
          "name": "Email",
          "value": "email"
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "get"
          ],
          "resource": [
            "contact"
          ]
        }
      }
    },
    {
      "displayName": "Contact ID",
      "name": "contactId",
      "type": "string",
      "default": "",
      "description": "ID of the contact",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "get"
          ],
          "resource": [
            "contact"
          ],
          "by": [
            "id"
          ]
        }
      }
    },
    {
      "displayName": "Email",
      "name": "email",
      "type": "string",
      "default": "",
      "description": "Email of the contact",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "get"
          ],
          "resource": [
            "contact"
          ],
          "by": [
            "email"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "send",
      "options": [
        {
          "name": "Send",
          "value": "send",
          "description": "Send an email",
          "action": "Send an email"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "mail"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Sender Email",
      "name": "fromEmail",
      "type": "string",
      "default": "",
      "description": "Email address of the sender of the email",
      "displayOptions": {
        "show": {
          "resource": [
            "mail"
          ],
          "operation": [
            "send"
          ]
        }
      }
    },
    {
      "displayName": "Sender Name",
      "name": "fromName",
      "type": "string",
      "default": "",
      "description": "Name of the sender of the email",
      "displayOptions": {
        "show": {
          "resource": [
            "mail"
          ],
          "operation": [
            "send"
          ]
        }
      }
    },
    {
      "displayName": "Recipient Email",
      "name": "toEmail",
      "type": "string",
      "default": "",
      "description": "Comma-separated list of recipient email addresses",
      "displayOptions": {
        "show": {
          "resource": [
            "mail"
          ],
          "operation": [
            "send"
          ]
        }
      }
    },
    {
      "displayName": "Subject",
      "name": "subject",
      "type": "string",
      "default": "",
      "description": "Subject of the email to send",
      "displayOptions": {
        "show": {
          "resource": [
            "mail"
          ],
          "operation": [
            "send"
          ],
          "dynamicTemplate": [
            false
          ]
        }
      }
    },
    {
      "displayName": "Dynamic Template",
      "name": "dynamicTemplate",
      "type": "boolean",
      "default": false,
      "description": "Whether this email will contain a dynamic template",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "mail"
          ],
          "operation": [
            "send"
          ]
        }
      }
    },
    {
      "displayName": "MIME Type",
      "name": "contentType",
      "type": "options",
      "default": "text/plain",
      "description": "MIME type of the email to send",
      "options": [
        {
          "name": "Plain Text",
          "value": "text/plain"
        },
        {
          "name": "HTML",
          "value": "text/html"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "mail"
          ],
          "operation": [
            "send"
          ],
          "dynamicTemplate": [
            false
          ]
        }
      }
    },
    {
      "displayName": "Message Body",
      "name": "contentValue",
      "type": "string",
      "default": "",
      "description": "Message body of the email to send",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "mail"
          ],
          "operation": [
            "send"
          ],
          "dynamicTemplate": [
            false
          ]
        }
      }
    },
    {
      "displayName": "Template Name or ID",
      "name": "templateId",
      "type": "options",
      "default": [],
      "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
      "displayOptions": {
        "show": {
          "resource": [
            "mail"
          ],
          "operation": [
            "send"
          ],
          "dynamicTemplate": [
            true
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getTemplateIds"
      }
    },
    {
      "displayName": "Dynamic Template Fields",
      "name": "dynamicTemplateFields",
      "type": "fixedCollection",
      "default": {},
      "options": [
        {
          "displayName": "Fields",
          "name": "fields",
          "values": [
            {
              "displayName": "Key",
              "name": "key",
              "type": "string",
              "default": "",
              "description": "Key of the dynamic template field"
            },
            {
              "displayName": "Value",
              "name": "value",
              "type": "string",
              "default": "",
              "description": "Value for the field"
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "mail"
          ],
          "operation": [
            "send"
          ],
          "dynamicTemplate": [
            true
          ]
        }
      },
      "typeOptions": {
        "multipleValues": true
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Attachments",
          "name": "attachments",
          "type": "string",
          "default": "",
          "description": "Comma-separated list of binary properties"
        },
        {
          "displayName": "BCC Email",
          "name": "bccEmail",
          "type": "string",
          "default": "",
          "description": "Comma-separated list of emails of the recipients of a blind carbon copy of the email"
        },
        {
          "displayName": "Categories",
          "name": "categories",
          "type": "string",
          "default": "",
          "description": "Comma-separated list of categories. Each category name may not exceed 255 characters."
        },
        {
          "displayName": "CC Email",
          "name": "ccEmail",
          "type": "string",
          "default": "",
          "description": "Comma-separated list of emails of the recipients of a carbon copy of the email"
        },
        {
          "displayName": "Enable Sandbox",
          "name": "enableSandbox",
          "type": "boolean",
          "default": false,
          "description": "Whether to use to the sandbox for testing out email-sending functionality"
        },
        {
          "displayName": "IP Pool Name",
          "name": "ipPoolName",
          "type": "string",
          "default": "",
          "description": "The IP Pool that you would like to send this email from"
        },
        {
          "displayName": "Reply-To Email",
          "name": "replyToEmail",
          "type": "string",
          "default": "",
          "placeholder": "reply@domain.com",
          "description": "Comma-separated list of email addresses that will appear in the reply-to field of the email"
        },
        {
          "displayName": "Headers",
          "name": "headers",
          "placeholder": "Add Header",
          "type": "fixedCollection",
          "typeOptions": {
            "multipleValues": true
          },
          "default": {},
          "options": [
            {
              "displayName": "Details",
              "name": "details",
              "values": [
                {
                  "displayName": "Key",
                  "name": "key",
                  "type": "string",
                  "default": "",
                  "description": "Key to set in the header object"
                },
                {
                  "displayName": "Value",
                  "name": "value",
                  "type": "string",
                  "default": "",
                  "description": "Value to set in the header object"
                }
              ]
            }
          ]
        },
        {
          "displayName": "Send At",
          "name": "sendAt",
          "type": "dateTime",
          "default": "",
          "description": "When to deliver the email. Scheduling more than 72 hours in advance is forbidden."
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "mail"
          ],
          "operation": [
            "send"
          ]
        }
      }
    }
  ]

operations:
  [
    {
      "operation": "create",
      "name": "Create",
      "description": "Create a list",
      "resource": "list"
    },
    {
      "operation": "delete",
      "name": "Delete",
      "description": "Delete a list",
      "resource": "list"
    },
    {
      "operation": "get",
      "name": "Get",
      "description": "Get a list",
      "resource": "list"
    },
    {
      "operation": "getAll",
      "name": "Get Many",
      "description": "Get many lists",
      "resource": "list"
    },
    {
      "operation": "update",
      "name": "Update",
      "description": "Update a list",
      "resource": "list"
    },
    {
      "operation": "upsert",
      "name": "Create or Update",
      "description": "Create a new contact, or update the current one if it already exists (upsert)",
      "resource": "contact"
    },
    {
      "operation": "delete",
      "name": "Delete",
      "description": "Delete a contact",
      "resource": "contact"
    },
    {
      "operation": "get",
      "name": "Get",
      "description": "Get a contact by ID",
      "resource": "contact"
    },
    {
      "operation": "getAll",
      "name": "Get Many",
      "description": "Get many contacts",
      "resource": "contact"
    },
    {
      "operation": "send",
      "name": "Send",
      "description": "Send an email",
      "resource": "mail"
    }
  ]


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

outputs:
  [
  "main"
  ]

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

  # SendGrid node

  Use the SendGrid node to automate work in SendGrid, and integrate SendGrid with other applications. n8n has built-in support for a wide range of SendGrid features, including creating, updating, deleting, and getting contacts, and lists, as well as sending emails. 

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

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

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

  ## Operations

  * Contact
      * Create/update a contact
      * Delete a contact
      * Get a contact by ID
      * Get all contacts
  * List
      * Create a list
      * Delete a list
      * Get a list
      * Get all lists
      * Update a list
  * Mail
      * Send an email.

  ## Templates and examples

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

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

properties_schema:
  [
    {
      "displayName": "Resource",
      "name": "resource",
      "type": "options",
      "default": "list",
      "options": [
        {
          "name": "Contact",
          "value": "contact"
        },
        {
          "name": "List",
          "value": "list"
        },
        {
          "name": "Mail",
          "value": "mail"
        }
      ],
      "required": true,
      "noDataExpression": true
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "create",
      "options": [
        {
          "name": "Create",
          "value": "create",
          "description": "Create a list",
          "action": "Create a list"
        },
        {
          "name": "Delete",
          "value": "delete",
          "description": "Delete a list",
          "action": "Delete a list"
        },
        {
          "name": "Get",
          "value": "get",
          "description": "Get a list",
          "action": "Get a list"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get many lists",
          "action": "Get many lists"
        },
        {
          "name": "Update",
          "value": "update",
          "description": "Update a list",
          "action": "Update a list"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "list"
          ]
        }
      },
      "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": [
            "list"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 100,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "list"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 1000
      }
    },
    {
      "displayName": "Name",
      "name": "name",
      "type": "string",
      "default": "",
      "description": "Name of the list",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "create"
          ],
          "resource": [
            "list"
          ]
        }
      }
    },
    {
      "displayName": "List ID",
      "name": "listId",
      "type": "string",
      "default": "",
      "description": "ID of the list",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "delete"
          ],
          "resource": [
            "list"
          ]
        }
      }
    },
    {
      "displayName": "Delete Contacts",
      "name": "deleteContacts",
      "type": "boolean",
      "default": false,
      "description": "Whether to delete all contacts on the list",
      "displayOptions": {
        "show": {
          "operation": [
            "delete"
          ],
          "resource": [
            "list"
          ]
        }
      }
    },
    {
      "displayName": "List ID",
      "name": "listId",
      "type": "string",
      "default": "",
      "description": "ID of the list",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "get"
          ],
          "resource": [
            "list"
          ]
        }
      }
    },
    {
      "displayName": "Contact Sample",
      "name": "contactSample",
      "type": "boolean",
      "default": false,
      "description": "Whether to return the contact sample",
      "displayOptions": {
        "show": {
          "operation": [
            "get"
          ],
          "resource": [
            "list"
          ]
        }
      }
    },
    {
      "displayName": "List ID",
      "name": "listId",
      "type": "string",
      "default": "",
      "description": "ID of the list",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "update"
          ],
          "resource": [
            "list"
          ]
        }
      }
    },
    {
      "displayName": "Name",
      "name": "name",
      "type": "string",
      "default": "",
      "description": "Name of the list",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "update"
          ],
          "resource": [
            "list"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "upsert",
      "options": [
        {
          "name": "Create or Update",
          "value": "upsert",
          "description": "Create a new contact, or update the current one if it already exists (upsert)",
          "action": "Create or update a contact"
        },
        {
          "name": "Delete",
          "value": "delete",
          "description": "Delete a contact",
          "action": "Delete a contact"
        },
        {
          "name": "Get",
          "value": "get",
          "description": "Get a contact by ID",
          "action": "Get a contact"
        },
        {
          "name": "Get Many",
          "value": "getAll",
          "description": "Get many contacts",
          "action": "Get many contacts"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "contact"
          ]
        }
      },
      "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": [
            "contact"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Limit",
      "name": "limit",
      "type": "number",
      "default": 100,
      "description": "Max number of results to return",
      "displayOptions": {
        "show": {
          "resource": [
            "contact"
          ],
          "operation": [
            "getAll"
          ],
          "returnAll": [
            false
          ]
        }
      },
      "typeOptions": {
        "minValue": 1,
        "maxValue": 1000
      }
    },
    {
      "displayName": "Filters",
      "name": "filters",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Query",
          "name": "query",
          "type": "string",
          "default": "",
          "description": "The query field accepts valid <a href=\"https://sendgrid.com/docs/for-developers/sending-email/segmentation-query-language/\">SGQL</a> for searching for a contact"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "contact"
          ],
          "operation": [
            "getAll"
          ]
        }
      }
    },
    {
      "displayName": "Email",
      "name": "email",
      "type": "string",
      "default": "",
      "description": "Primary email for the contact",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "upsert"
          ],
          "resource": [
            "contact"
          ]
        }
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Address",
          "name": "addressUi",
          "placeholder": "Address",
          "type": "fixedCollection",
          "typeOptions": {
            "multipleValues": false
          },
          "default": {},
          "options": [
            {
              "name": "addressValues",
              "displayName": "Address",
              "values": [
                {
                  "displayName": "Address Line 1",
                  "name": "address1",
                  "type": "string",
                  "default": ""
                },
                {
                  "displayName": "Address Line 2",
                  "name": "address2",
                  "type": "string",
                  "default": ""
                }
              ]
            }
          ]
        },
        {
          "displayName": "Alternate Emails",
          "name": "alternateEmails",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "City",
          "name": "city",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Country",
          "name": "country",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "First Name",
          "name": "firstName",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Last Name",
          "name": "lastName",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "Postal Code",
          "name": "postalCode",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "State/Province/Region",
          "name": "stateProvinceRegion",
          "type": "string",
          "default": ""
        },
        {
          "displayName": "List IDs",
          "name": "listIdsUi",
          "placeholder": "List IDs",
          "description": "Adds a custom field to set also values which have not been predefined",
          "type": "fixedCollection",
          "default": {},
          "options": [
            {
              "name": "listIdValues",
              "displayName": "List IDs",
              "values": [
                {
                  "displayName": "List Names or IDs",
                  "name": "listIds",
                  "type": "multiOptions",
                  "typeOptions": {
                    "loadOptionsMethod": "getListIds"
                  },
                  "default": [],
                  "description": "ID of the field to set. Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
                }
              ]
            }
          ]
        },
        {
          "displayName": "Custom Fields",
          "name": "customFieldsUi",
          "placeholder": "Add Custom Fields",
          "description": "Adds custom fields",
          "type": "fixedCollection",
          "typeOptions": {
            "multipleValues": true
          },
          "default": {},
          "options": [
            {
              "name": "customFieldValues",
              "displayName": "Field",
              "values": [
                {
                  "displayName": "Field Name or ID",
                  "name": "fieldId",
                  "type": "options",
                  "typeOptions": {
                    "loadOptionsMethod": "getCustomFields"
                  },
                  "default": "",
                  "description": "ID of the field. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>."
                },
                {
                  "displayName": "Field Value",
                  "name": "fieldValue",
                  "type": "string",
                  "default": "",
                  "description": "Value for the field"
                }
              ]
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "contact"
          ],
          "operation": [
            "upsert"
          ]
        }
      }
    },
    {
      "displayName": "Contact IDs",
      "name": "ids",
      "type": "string",
      "default": "",
      "description": "ID of the contact. Multiple can be added separated by comma.",
      "displayOptions": {
        "show": {
          "resource": [
            "contact"
          ],
          "operation": [
            "delete"
          ],
          "deleteAll": [
            false
          ]
        }
      }
    },
    {
      "displayName": "Delete All",
      "name": "deleteAll",
      "type": "boolean",
      "default": false,
      "description": "Whether all contacts will be deleted",
      "displayOptions": {
        "show": {
          "resource": [
            "contact"
          ],
          "operation": [
            "delete"
          ]
        }
      }
    },
    {
      "displayName": "By",
      "name": "by",
      "type": "options",
      "default": "id",
      "description": "Search the user by ID or email",
      "options": [
        {
          "name": "ID",
          "value": "id"
        },
        {
          "name": "Email",
          "value": "email"
        }
      ],
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "get"
          ],
          "resource": [
            "contact"
          ]
        }
      }
    },
    {
      "displayName": "Contact ID",
      "name": "contactId",
      "type": "string",
      "default": "",
      "description": "ID of the contact",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "get"
          ],
          "resource": [
            "contact"
          ],
          "by": [
            "id"
          ]
        }
      }
    },
    {
      "displayName": "Email",
      "name": "email",
      "type": "string",
      "default": "",
      "description": "Email of the contact",
      "required": true,
      "displayOptions": {
        "show": {
          "operation": [
            "get"
          ],
          "resource": [
            "contact"
          ],
          "by": [
            "email"
          ]
        }
      }
    },
    {
      "displayName": "Operation",
      "name": "operation",
      "type": "options",
      "default": "send",
      "options": [
        {
          "name": "Send",
          "value": "send",
          "description": "Send an email",
          "action": "Send an email"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "mail"
          ]
        }
      },
      "noDataExpression": true
    },
    {
      "displayName": "Sender Email",
      "name": "fromEmail",
      "type": "string",
      "default": "",
      "description": "Email address of the sender of the email",
      "displayOptions": {
        "show": {
          "resource": [
            "mail"
          ],
          "operation": [
            "send"
          ]
        }
      }
    },
    {
      "displayName": "Sender Name",
      "name": "fromName",
      "type": "string",
      "default": "",
      "description": "Name of the sender of the email",
      "displayOptions": {
        "show": {
          "resource": [
            "mail"
          ],
          "operation": [
            "send"
          ]
        }
      }
    },
    {
      "displayName": "Recipient Email",
      "name": "toEmail",
      "type": "string",
      "default": "",
      "description": "Comma-separated list of recipient email addresses",
      "displayOptions": {
        "show": {
          "resource": [
            "mail"
          ],
          "operation": [
            "send"
          ]
        }
      }
    },
    {
      "displayName": "Subject",
      "name": "subject",
      "type": "string",
      "default": "",
      "description": "Subject of the email to send",
      "displayOptions": {
        "show": {
          "resource": [
            "mail"
          ],
          "operation": [
            "send"
          ],
          "dynamicTemplate": [
            false
          ]
        }
      }
    },
    {
      "displayName": "Dynamic Template",
      "name": "dynamicTemplate",
      "type": "boolean",
      "default": false,
      "description": "Whether this email will contain a dynamic template",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "mail"
          ],
          "operation": [
            "send"
          ]
        }
      }
    },
    {
      "displayName": "MIME Type",
      "name": "contentType",
      "type": "options",
      "default": "text/plain",
      "description": "MIME type of the email to send",
      "options": [
        {
          "name": "Plain Text",
          "value": "text/plain"
        },
        {
          "name": "HTML",
          "value": "text/html"
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "mail"
          ],
          "operation": [
            "send"
          ],
          "dynamicTemplate": [
            false
          ]
        }
      }
    },
    {
      "displayName": "Message Body",
      "name": "contentValue",
      "type": "string",
      "default": "",
      "description": "Message body of the email to send",
      "required": true,
      "displayOptions": {
        "show": {
          "resource": [
            "mail"
          ],
          "operation": [
            "send"
          ],
          "dynamicTemplate": [
            false
          ]
        }
      }
    },
    {
      "displayName": "Template Name or ID",
      "name": "templateId",
      "type": "options",
      "default": [],
      "description": "Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>",
      "displayOptions": {
        "show": {
          "resource": [
            "mail"
          ],
          "operation": [
            "send"
          ],
          "dynamicTemplate": [
            true
          ]
        }
      },
      "typeOptions": {
        "loadOptionsMethod": "getTemplateIds"
      }
    },
    {
      "displayName": "Dynamic Template Fields",
      "name": "dynamicTemplateFields",
      "type": "fixedCollection",
      "default": {},
      "options": [
        {
          "displayName": "Fields",
          "name": "fields",
          "values": [
            {
              "displayName": "Key",
              "name": "key",
              "type": "string",
              "default": "",
              "description": "Key of the dynamic template field"
            },
            {
              "displayName": "Value",
              "name": "value",
              "type": "string",
              "default": "",
              "description": "Value for the field"
            }
          ]
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "mail"
          ],
          "operation": [
            "send"
          ],
          "dynamicTemplate": [
            true
          ]
        }
      },
      "typeOptions": {
        "multipleValues": true
      }
    },
    {
      "displayName": "Additional Fields",
      "name": "additionalFields",
      "type": "collection",
      "default": {},
      "options": [
        {
          "displayName": "Attachments",
          "name": "attachments",
          "type": "string",
          "default": "",
          "description": "Comma-separated list of binary properties"
        },
        {
          "displayName": "BCC Email",
          "name": "bccEmail",
          "type": "string",
          "default": "",
          "description": "Comma-separated list of emails of the recipients of a blind carbon copy of the email"
        },
        {
          "displayName": "Categories",
          "name": "categories",
          "type": "string",
          "default": "",
          "description": "Comma-separated list of categories. Each category name may not exceed 255 characters."
        },
        {
          "displayName": "CC Email",
          "name": "ccEmail",
          "type": "string",
          "default": "",
          "description": "Comma-separated list of emails of the recipients of a carbon copy of the email"
        },
        {
          "displayName": "Enable Sandbox",
          "name": "enableSandbox",
          "type": "boolean",
          "default": false,
          "description": "Whether to use to the sandbox for testing out email-sending functionality"
        },
        {
          "displayName": "IP Pool Name",
          "name": "ipPoolName",
          "type": "string",
          "default": "",
          "description": "The IP Pool that you would like to send this email from"
        },
        {
          "displayName": "Reply-To Email",
          "name": "replyToEmail",
          "type": "string",
          "default": "",
          "placeholder": "reply@domain.com",
          "description": "Comma-separated list of email addresses that will appear in the reply-to field of the email"
        },
        {
          "displayName": "Headers",
          "name": "headers",
          "placeholder": "Add Header",
          "type": "fixedCollection",
          "typeOptions": {
            "multipleValues": true
          },
          "default": {},
          "options": [
            {
              "displayName": "Details",
              "name": "details",
              "values": [
                {
                  "displayName": "Key",
                  "name": "key",
                  "type": "string",
                  "default": "",
                  "description": "Key to set in the header object"
                },
                {
                  "displayName": "Value",
                  "name": "value",
                  "type": "string",
                  "default": "",
                  "description": "Value to set in the header object"
                }
              ]
            }
          ]
        },
        {
          "displayName": "Send At",
          "name": "sendAt",
          "type": "dateTime",
          "default": "",
          "description": "When to deliver the email. Scheduling more than 72 hours in advance is forbidden."
        }
      ],
      "displayOptions": {
        "show": {
          "resource": [
            "mail"
          ],
          "operation": [
            "send"
          ]
        }
      }
    }
  ]

operations:
  [
    {
      "operation": "create",
      "name": "Create",
      "description": "Create a list",
      "resource": "list"
    },
    {
      "operation": "delete",
      "name": "Delete",
      "description": "Delete a list",
      "resource": "list"
    },
    {
      "operation": "get",
      "name": "Get",
      "description": "Get a list",
      "resource": "list"
    },
    {
      "operation": "getAll",
      "name": "Get Many",
      "description": "Get many lists",
      "resource": "list"
    },
    {
      "operation": "update",
      "name": "Update",
      "description": "Update a list",
      "resource": "list"
    },
    {
      "operation": "upsert",
      "name": "Create or Update",
      "description": "Create a new contact, or update the current one if it already exists (upsert)",
      "resource": "contact"
    },
    {
      "operation": "delete",
      "name": "Delete",
      "description": "Delete a contact",
      "resource": "contact"
    },
    {
      "operation": "get",
      "name": "Get",
      "description": "Get a contact by ID",
      "resource": "contact"
    },
    {
      "operation": "getAll",
      "name": "Get Many",
      "description": "Get many contacts",
      "resource": "contact"
    },
    {
      "operation": "send",
      "name": "Send",
      "description": "Send an email",
      "resource": "mail"
    }
  ]


