Intercom – Method Usage

“Search Contacts” Method

There are two processes for sending a search request in the “Search Contacts” Method:

• Basic search: This allows you to use an operator to search for values within a single field.
• Multiple filters: This allows you to use multiple operators to search for values in multiple fields.

Basic search

Use the first three fields to send a basic search:

1. Enter a single field.
2. Enter an operator that isn’t AND or OR.
3. Enter the value you want to search for.

Note: You can search for multiple values in a comma separated list if you use an ‘IN’ or ‘NIN’ operator.

Multiple filters

You can use multiple filters for a search:

1. In the Field and Value fields, enter Multiple.
2. Enter either an AND or an OR operator in the Operator field.
3. Enter the multiple filter operator(s) in the Multiple Filters Operator field.
4. Enter the field(s) in the Multiple Filters Field field.
5. Enter the value(s) in the Multiple Filters Value field.

Search for a single value

To use multiple operators or multiple fields to search for a single value, repeat the value in the Multiple Filters Value field to match the number of filters.

For example, if you use two fields to filter the search, enter the value twice:

Field	Provided values
Operator	AND
Multiple Filters Operator	~
Multiple Filters Field	name, email
Multiple Filters Value	Smith, Smith

The above fields produce the following request:

{
    "query": {
        "operator": "AND",
        "value": [
            {
                "value": "Smith",
                "field": "name",
                "operator": "~"
            },
            {
                "value": "Smith",
                "field": "email",
                "operator": "~"
            }
        ]
    }
}

Search for multiple values

To search for multiple values with multiple operators or multiple fields, specify the operator or field for each value in a comma separated list.

If you use a smaller number of operators or fields than values, the search request uses the last item in the list for the subsequent values. For example, if you use two operators to search for three values, the search request uses the second operator in the list for both the second and third value:

Provided request fields with less Operators and Fields than values:

Field	Provided values
Operator	OR
Multiple Filters Operator	~, =
Multiple Filters Field	location.city
Multiple Filters Value	Brighton, Eastbourne, Hove

The above fields produce the following request:

{
    "query": {
        "operator": "OR",
        "value": [
            {
                "value": "Brighton",
                "field": "location.city",
                "operator": "~"
            },
            {
                "value": "Eastbourne",
                "field": "location.city",
                "operator": "="
            },
            {
                "value": "Hove",
                "field": "location.city",
                "operator": "="
            }
        ]
    }
}

For more information on Intercom’s fields, operators and values, see their Search for contacts documentation.

“List Tickets” Method

“List Tickets” has a parameter called Query JSON. You can create complex queries to filter the returned results. This can best be done by using inline merge fields along with your search query.

See this article from Intercom, see the heading “3: JSON-based query language”, which explains more on the building blocks for your query.