Search Contacts

Find contacts that match the provided search criteria.

To narrow your search results, choose All Matching Contacts for your result set and search using a single field (for example, Email). You can follow this card with a Filter or Filter Custom function card to further filter the search results.

Note

Search results may exclude newly created and updated HubSpot CRM objects. For best results, wait 10 seconds after using a Create card before calling this card, and 60 seconds after using an Update card. Archived HubSpot CRM objects do not appear in search results. This card returns a maximum of 10,000 results.

Options

Field Definition Type Required
Result Set

Choose whether to return one or all matching contacts by selecting from:

  • First Matching Contact

  • All Matching Contacts

Dropdown TRUE
Use Filters? Indicates whether to use filters. If you select No, then select -- No Filters -- from the Filters Operator drop-down box. Dropdown TRUE
Filters Operator

Type of filter to use. If Use Filters? is set to No, then select -- No Filters --. Otherwise, choose from:

  • Equal to

  • Not equal to

  • Less than

  • Less than or equal to

  • Greater than

  • Greater than or equal to

  • Has property value

  • Does not have property value

  • Contains word

  • Does not contain word

Note

The Less than, Less than or equal to, Greater than, and Greater than or equal to operators are best used with numeric properties (for example, Days To Close, Number of employees, and so on).

Dropdown TRUE
Show Hidden Properties? Select Yes to show properties that are hidden fields in HubSpot CRM. Dropdown TRUE

Input

Field Definition Type Required

The available input fields are dynamically generated based on the properties that are defined for contacts in HubSpot CRM. The list available of available properties includes any custom properties that you created for contacts. Select the fields on which to base your search.

Note

This card supports filtering search results using a maximum of three input fields (excluding Custom Filters). Selecting more than three fields will result in an error.

Tip

The type for a date field can be either Number or Date & Time. When the field type is Number, you must enter the date in Unix time (milliseconds). When the field type is Date & Time, enter the date in a standard format (for example, March 26 2021 or 03-26-2021).

Custom Filters HubSpot CRM lets you create up to three filter groups, each of which can contain up to three filters.

For example, a filter checking for entries whose first name is Alice would be written as:

{

    "propertyName": "firstname",

    "operator": "EQ",

    "value": "Alice"

}

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

{

    "propertyName": "enum1",

    "operator": "HAS_PROPERTY",

}

or filter entries that don't have a specific property:

{

    "propertyName": "enum2",

    "operator": "NOT_HAS_PROPERTY",

}

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

{

    "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 contact ID is 123 AND deal ID is 456. If you have multiple filter groups, then a logical OR group is used to combine their results. For example, suppose you have three filter groups: filtergrp1, filtergrp2, and filtergrp3. The filters within each group are combined using the AND operator, as discussed previously. The resulting entries are compiled by combining the groups using the expression filtergrp1 OR filtergrp2 OR filtergrp3.

Alternatively, suppose your card has two input properies, input1 and input2, and has a filtergroup, filtergrp1. Then the resulting set is created by combining the results of: (input1 AND input2) OR filtergrp1.

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

Note

This card supports a maximum of three custom filter groups. This is possible when no other input fields are selected. For each input that's selected, you can have one fewer filter group.

List of Objects FALSE

Output

Your output is either a single contact or a list of contacts, based on the Result Set option that you chose.

Each contact contains a list of property fields which are dynamically generated based on the properties that are defined for contacts in HubSpot CRM. This includes any custom properties that you created for contacts.

Related topics

HubSpot CRM connector

About the elements of Okta Workflows

HubSpot API Docs