Search Contacts

This is an example of a filter checking for entries whose first name is Alice:

1
2
3
4
5
{
    "propertyName": "firstname",
    "operator": "EQ",
    "value": "Alice"
}

Similarly, you can filter entries by whether they have a property:

1
2
3
4
{
    "propertyName": "enum1",
    "operator": "HAS_PROPERTY",
}

You can filter entries that don't have a specific property:

1
2
3
4
{
    "propertyName": "enum2",
    "operator": "NOT_HAS_PROPERTY",
}

Multiple entries in a filter group are combined using a logical AND operator. Consider the following example:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
{
    "propertyName": "associations.company",
    "operator": "EQ",
    "value": "Example"
},
{
    "propertyName": "associations.contact",
    "operator": "EQ",
    "value": "123"
},
{
    "propertyName": "associations.deal",
    "operator": "EQ",
    "value": "456"
}

The results of the preceding filter group would match all entries whose company is Example and the contact ID is 123 and the deal ID is 456.

If you have multiple filter groups, then a logical OR grouping is used to combine their results. As an example, you have three filter groups: filtergrp1, filtergrp2, and filtergrp3. The filters within each group are combined using the AND operator. The resulting entries are compiled by combining the groups using the expression filtergrp1 OR filtergrp2 OR filtergrp3.

Alternatively, suppose that your card has two input properties, input1 and input2, and has a filter group, filtergrp1. Then the resulting set combines the results of: (input1 AND input2) OR filtergrp1.

See the HubSpot CRM Search API for a complete list of supported object types, properties, and operators for use with custom filters.