StyloDocs
Workflow blocks

Search Contacts

Search contacts in Intercom

View as Markdown

intercom/search-contacts — Search contacts in Intercom.

Where it appears

The Search Contacts block lives in the Integrations group of the Workflow Builder. Connect the Intercom integration before adding it.

Fields

FieldTypeRequiredDefaultDescription
queryJsoncodeYesIntercom Search Contacts API request body as JSON, using a query object with field, operator, and value (and optional nested AND/OR groups).

Inputs and outputs

Inputs are the configurable fields above. The block produces these outputs:

Outputs

Reference an output downstream with <Search Contacts.field>.

NameTypeDescription
successbooleanOperation succeeded
resultsjsonSearch results
pagesjsonPagination info
errorstringError message if failed

Example

A minimal configuration for this block:

{
  "type": "intercom/search-contacts",
  "config": {
    "queryJson": "..."
  }
}

Limits and failure modes

  • Requires a connected Intercom integration. Calls fail if that integration is disconnected or its authorization has expired.
  • Required field (queryJson) must be set, or the block fails validation before it runs.
  • On failure the error output is populated; downstream blocks that reference other outputs may not receive values.

On this page