crm_search_objects
Search HubSpot CRM objects by applying filters, sorting, and property selection to retrieve specific records like contacts, companies, or deals.
Instructions
Search CRM objects using filters
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| after | No | ||
| filterGroups | Yes | ||
| limit | No | ||
| objectType | Yes | ||
| properties | No | ||
| sorts | No |
Input Schema (JSON Schema)
{
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"after": {
"type": "string"
},
"filterGroups": {
"items": {
"additionalProperties": false,
"properties": {
"filters": {
"items": {
"additionalProperties": false,
"properties": {
"operator": {
"enum": [
"EQ",
"NEQ",
"LT",
"LTE",
"GT",
"GTE",
"BETWEEN",
"IN",
"NOT_IN",
"HAS_PROPERTY",
"NOT_HAS_PROPERTY",
"CONTAINS_TOKEN",
"NOT_CONTAINS_TOKEN"
],
"type": "string"
},
"propertyName": {
"type": "string"
},
"value": {}
},
"required": [
"propertyName",
"operator"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"filters"
],
"type": "object"
},
"type": "array"
},
"limit": {
"maximum": 100,
"minimum": 1,
"type": "number"
},
"objectType": {
"enum": [
"companies",
"contacts",
"deals",
"tickets",
"products",
"line_items",
"quotes",
"custom"
],
"type": "string"
},
"properties": {
"items": {
"type": "string"
},
"type": "array"
},
"sorts": {
"items": {
"additionalProperties": false,
"properties": {
"direction": {
"enum": [
"ASCENDING",
"DESCENDING"
],
"type": "string"
},
"propertyName": {
"type": "string"
}
},
"required": [
"propertyName",
"direction"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"objectType",
"filterGroups"
],
"type": "object"
}