Skip to content
Home/
REST API Reference
/
/
filter

filter

Any of:

Search using Intercoms Search APIs with a single filter.

fieldstring

The accepted field that you want to search on.

Enum:"id""role""name""avatar""owner_id""email""email_domain""phone""external_id""created_at"
Example:"custom_attributes.favorite_color"
operatorstring

The accepted operators you can use to define how you want to search for the value. Operator support depends on the field's data type. The breakdown below is for Contacts search; the other search endpoints that share this schema accept a different set per field:

  • string fields: =, !=, IN, NIN, ~, !~, ^, $
  • tag_id: = and != only. Every other operator returns an error.
  • boolean fields: =, !=, IN, NIN
  • integer fields: =, !=, IN, NIN, <, >, <=, >=
  • date fields (all standard timestamp attributes and date custom attributes): =, <, > only. !=, <=, >=, IN, and NIN are not supported and return an error.
Enum:"=""!=""IN""NIN""<""<="">"">=""~""!~"
Example:">"
valuestring or integer or Array of any
Example:"73732934"
One of:

The value that you want to search on.

string
{
  "field": "custom_attributes.favorite_color",
  "operator": ">",
  "value": "73732934"
}