agileCrm.json•10.9 kB
{
"nodeType": "n8n-nodes-base.agileCrm",
"displayName": "Agile CRM",
"description": "Consume Agile CRM API",
"version": 1,
"properties": [
{
"name": "companyId",
"displayName": "Company ID",
"type": "string",
"default": "",
"description": "Unique identifier for a particular company",
"required": true,
"displayOptions": {
"show": {
"resource": [
"company"
],
"operation": [
"get"
]
}
}
},
{
"name": "returnAll",
"displayName": "Return All",
"type": "boolean",
"default": false,
"description": "Whether to return all results or only up to a given limit",
"displayOptions": {
"show": {
"resource": [
"company"
],
"operation": [
"getAll"
]
}
}
},
{
"name": "limit",
"displayName": "Limit",
"type": "number",
"default": 20,
"description": "Max number of results to return",
"typeOptions": {
"minValue": 1
},
"displayOptions": {
"show": {
"resource": [
"company"
],
"operation": [
"getAll"
],
"returnAll": [
false
]
}
}
},
{
"name": "filterType",
"displayName": "Filter",
"type": "options",
"default": "none",
"options": [
{
"name": "None",
"value": "none"
},
{
"name": "Build Manually",
"value": "manual"
},
{
"name": "JSON",
"value": "json"
}
],
"displayOptions": {
"show": {
"resource": [
"company"
],
"operation": [
"getAll"
]
}
}
},
{
"name": "matchType",
"displayName": "Must Match",
"type": "options",
"default": "anyFilter",
"options": [
{
"name": "Any Filter",
"value": "anyFilter"
},
{
"name": "All Filters",
"value": "allFilters"
}
],
"displayOptions": {
"show": {
"resource": [
"company"
],
"operation": [
"getAll"
],
"filterType": [
"manual"
]
}
}
},
{
"name": "simple",
"displayName": "Simplify",
"type": "boolean",
"default": false,
"description": "Whether to return a simplified version of the response instead of the raw data",
"displayOptions": {
"show": {
"resource": [
"company"
],
"operation": [
"getAll"
]
}
}
},
{
"name": "filters",
"displayName": "Filters",
"type": "fixedCollection",
"default": {},
"description": "Any searchable field",
"placeholder": "Add Condition",
"typeOptions": {
"multipleValues": true
},
"displayOptions": {
"show": {
"resource": [
"company"
],
"operation": [
"getAll"
],
"filterType": [
"manual"
]
}
}
},
{
"name": "jsonNotice",
"displayName": "See <a href=\"https://github.com/agilecrm/rest-api#121-get-contacts-by-dynamic-filter\" target=\"_blank\">Agile CRM guide</a> to creating filters",
"type": "notice",
"default": "",
"displayOptions": {
"show": {
"resource": [
"company"
],
"operation": [
"getAll"
],
"filterType": [
"json"
]
}
}
},
{
"name": "filterJson",
"displayName": "Filters (JSON)",
"type": "string",
"default": "",
"displayOptions": {
"show": {
"resource": [
"company"
],
"operation": [
"getAll"
],
"filterType": [
"json"
]
}
}
},
{
"name": "options",
"displayName": "Options",
"type": "collection",
"default": {},
"description": "The sorting direction",
"placeholder": "Add option",
"displayOptions": {
"show": {
"resource": [
"company"
],
"operation": [
"getAll"
]
}
}
},
{
"name": "jsonParameters",
"displayName": "JSON Parameters",
"type": "boolean",
"default": false,
"displayOptions": {
"show": {
"resource": [
"company"
],
"operation": [
"create"
]
}
}
},
{
"name": "additionalFieldsJson",
"displayName": "Additional Fields",
"type": "json",
"default": "",
"description": "Object of values to set as described <a href=\"https://github.com/agilecrm/rest-api#1-companys---companies-api\">here</a>",
"displayOptions": {
"show": {
"resource": [
"company"
],
"operation": [
"create"
],
"jsonParameters": [
true
]
}
}
},
{
"name": "additionalFields",
"displayName": "Additional Fields",
"type": "collection",
"default": {},
"description": "Company address",
"placeholder": "Add Field",
"required": true,
"typeOptions": {
"multipleValues": true
},
"displayOptions": {
"show": {
"resource": [
"company"
],
"operation": [
"create"
],
"jsonParameters": [
false
]
}
}
},
{
"name": "operation",
"displayName": "Operation",
"type": "options",
"default": "get",
"description": "Create a new company",
"options": [
{
"name": "Create",
"value": "create",
"description": "Create a new company"
},
{
"name": "Delete",
"value": "delete",
"description": "Delete a company"
},
{
"name": "Get",
"value": "get",
"description": "Get a company"
},
{
"name": "Get Many",
"value": "getAll",
"description": "Get many companies"
},
{
"name": "Update",
"value": "update",
"description": "Update company properties"
}
],
"displayOptions": {
"show": {
"resource": [
"company"
]
}
}
},
{
"name": "contactId",
"displayName": "Contact ID",
"type": "string",
"default": "",
"description": "Unique identifier for a particular contact",
"required": true,
"displayOptions": {
"show": {
"resource": [
"contact"
],
"operation": [
"get"
]
}
}
},
{
"name": "dealId",
"displayName": "Deal ID",
"type": "string",
"default": "",
"description": "Unique identifier for a particular deal",
"required": true,
"displayOptions": {
"show": {
"resource": [
"deal"
],
"operation": [
"get"
]
}
}
},
{
"name": "closeDate",
"displayName": "Close Date",
"type": "dateTime",
"default": "",
"description": "Closing date of deal",
"required": true,
"displayOptions": {
"show": {
"resource": [
"deal"
],
"operation": [
"create"
],
"jsonParameters": [
false
]
}
}
},
{
"name": "expectedValue",
"displayName": "Expected Value",
"type": "number",
"default": 1,
"description": "Expected Value of deal",
"required": true,
"typeOptions": {
"minValue": 0,
"maxValue": 1000000000000
},
"displayOptions": {
"show": {
"resource": [
"deal"
],
"operation": [
"create"
],
"jsonParameters": [
false
]
}
}
},
{
"name": "milestone",
"displayName": "Milestone",
"type": "string",
"default": "",
"description": "Milestone of deal",
"required": true,
"displayOptions": {
"show": {
"resource": [
"deal"
],
"operation": [
"create"
],
"jsonParameters": [
false
]
}
}
},
{
"name": "name",
"displayName": "Name",
"type": "string",
"default": "",
"description": "Name of deal",
"required": true,
"displayOptions": {
"show": {
"resource": [
"deal"
],
"operation": [
"create"
],
"jsonParameters": [
false
]
}
}
},
{
"name": "probability",
"displayName": "Probability",
"type": "number",
"default": 50,
"description": "Expected probability",
"required": true,
"typeOptions": {
"minValue": 0,
"maxValue": 100
},
"displayOptions": {
"show": {
"resource": [
"deal"
],
"operation": [
"create"
],
"jsonParameters": [
false
]
}
}
},
{
"name": "resource",
"displayName": "Resource",
"type": "options",
"default": "contact",
"options": [
{
"name": "Company",
"value": "company"
},
{
"name": "Contact",
"value": "contact"
},
{
"name": "Deal",
"value": "deal"
}
]
}
],
"credentialsConfig": [
{
"name": "agileCrmApi",
"required": true
},
{
"name": "resource",
"required": false
}
],
"io": {
"inputs": [
"Main"
],
"outputs": [
"Main"
],
"outputNames": [],
"hints": {}
},
"wiring": {
"role": "generic",
"requires": [],
"optional": [],
"consumedBy": [],
"consumes": [
"Main"
],
"produces": [
"Main"
]
}
}