Intercom: Search Contacts

Search Intercom contacts by their attributes, such as email, name or custom fields.

Tool ID: intercom_search_contacts

Run this action

Use the TypeScript SDK for one call. Use ctx.tools.execute(...) inside a Play for durable calls, scheduled calls, or CSV processing.

import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'intercom_search_contacts',
  {
    "query": {}
  },
);

console.log(result.toolResponse.raw);

CLI

deepline tools execute intercom_search_contacts --input '{
  "query": {}
}' --json

Example response

The SDK returns this shape at result.toolResponse.raw. The example values illustrate the response.

{
  "data": {
    "type": "list",
    "data": [
      {
        "type": "example",
        "id": "id_123",
        "external_id": "external_123"
      }
    ],
    "total_count": 123
  }
}

Use deepline describe intercom_search_contacts --json for the latest machine-readable contract.

Input reference

Search using Intercoms Search APIs.

Name	Type	Required	Default	Details
`payload.query`	`object`	Yes	—	—
`payload.pagination`	`object`	No	—	—

Output reference

Standard tool result payload.

Name	Type	Required	Default	Details
`result.data`	`object`	Yes	—	Contacts are your users in Intercom.
`result.data.type`	`"list"`	No	—	Always list Allowed: `list`.
`result.data.data`	`array`	No	—	The list of contact objects
`result.data.data[].type`	`string`	No	—	The type of object.
`result.data.data[].id`	`string`	No	—	The unique identifier for the contact which is given by Intercom.
`result.data.data[].external_id`	`string \| null`	No	—	The unique identifier for the contact which is provided by the Client.
`result.data.data[].workspace_id`	`string`	No	—	The id of the workspace which the contact belongs to.
`result.data.data[].role`	`string`	No	—	The role of the contact.
`result.data.data[].email`	`string`	No	—	The contact’s email.
`result.data.data[].email_domain`	`string`	No	—	The contact’s email domain.
`result.data.data[].phone`	`string \| null`	No	—	The contacts phone.
`result.data.data[].name`	`string \| null`	No	—	The contacts name.
`result.data.data[].owner_id`	`integer \| null`	No	—	The id of an admin that has been assigned account ownership of the contact.
`result.data.data[].has_hard_bounced`	`boolean`	No	—	Whether the contact has had an email sent to them hard bounce.
`result.data.data[].marked_email_as_spam`	`boolean`	No	—	Whether the contact has marked an email sent to them as spam.
`result.data.data[].unsubscribed_from_emails`	`boolean`	No	—	Whether the contact is unsubscribed from emails.
`result.data.data[].created_at`	`integer`	No	—	(Unix timestamp in seconds) The time when the contact was created. Format: `date-time`.
`result.data.data[].updated_at`	`integer`	No	—	(Unix timestamp in seconds) The time when the contact was last updated. Format: `date-time`.
`result.data.data[].signed_up_at`	`integer \| null`	No	—	(Unix timestamp in seconds) The time specified for when a contact signed up. Format: `date-time`.
`result.data.data[].last_seen_at`	`integer \| null`	No	—	(Unix timestamp in seconds) The time when the contact was last seen (either where the Intercom Messenger was installed or when specified manually). Format: `date-time`.
`result.data.data[].last_replied_at`	`integer \| null`	No	—	(Unix timestamp in seconds) The time when the contact last messaged in. Format: `date-time`.
`result.data.data[].last_contacted_at`	`integer \| null`	No	—	(Unix timestamp in seconds) The time when the contact was last messaged. Format: `date-time`.
`result.data.data[].last_email_opened_at`	`integer \| null`	No	—	(Unix timestamp in seconds) The time when the contact last opened an email. Format: `date-time`.
`result.data.data[].last_email_clicked_at`	`integer \| null`	No	—	(Unix timestamp in seconds) The time when the contact last clicked a link in an email. Format: `date-time`.
`result.data.data[].language_override`	`string \| null`	No	—	A preferred language setting for the contact, used by the Intercom Messenger even if their browser settings change.
`result.data.data[].browser`	`string \| null`	No	—	The name of the browser which the contact is using.
`result.data.data[].browser_version`	`string \| null`	No	—	The version of the browser which the contact is using.
`result.data.data[].browser_language`	`string \| null`	No	—	The language set by the browser which the contact is using.
`result.data.data[].os`	`string \| null`	No	—	The operating system which the contact is using.
`result.data.data[].android_app_name`	`string \| null`	No	—	The name of the Android app which the contact is using.
`result.data.data[].android_app_version`	`string \| null`	No	—	The version of the Android app which the contact is using.
`result.data.data[].android_device`	`string \| null`	No	—	The Android device which the contact is using.
`result.data.data[].android_os_version`	`string \| null`	No	—	The version of the Android OS which the contact is using.
`result.data.data[].android_sdk_version`	`string \| null`	No	—	The version of the Android SDK which the contact is using.
`result.data.data[].android_last_seen_at`	`integer \| null`	No	—	(Unix timestamp in seconds) The time when the contact was last seen on an Android device. Format: `date-time`.
`result.data.data[].ios_app_name`	`string \| null`	No	—	The name of the iOS app which the contact is using.
`result.data.data[].ios_app_version`	`string \| null`	No	—	The version of the iOS app which the contact is using.
`result.data.data[].ios_device`	`string \| null`	No	—	The iOS device which the contact is using.
`result.data.data[].ios_os_version`	`string \| null`	No	—	The version of iOS which the contact is using.
`result.data.data[].ios_sdk_version`	`string \| null`	No	—	The version of the iOS SDK which the contact is using.
`result.data.data[].ios_last_seen_at`	`integer \| null`	No	—	(Unix timestamp in seconds) The last time the contact used the iOS app. Format: `date-time`.
`result.data.data[].custom_attributes`	`record`	No	—	The custom attributes which are set for the contact.
`result.data.data[].avatar`	`object \| null`	No	—	—
`result.data.data[].avatar.type`	`string`	No	—	The type of object
`result.data.data[].avatar.image_url`	`string \| null`	No	—	An image URL containing the avatar of a contact. Format: `uri`.
`result.data.data[].tags`	`object \| null`	No	—	An object containing tags meta data about the tags that a contact has. Up to 10 will be displayed here. Use the url to get more.
`result.data.data[].tags.data`	`array`	No	—	This object represents the tags attached to a contact.
`result.data.data[].tags.data[].type`	`string`	No	—	The addressable object type Format: `uri`.
`result.data.data[].tags.data[].id`	`string`	No	—	The id of the addressable object
`result.data.data[].tags.data[].url`	`string`	No	—	Url to get more company resources for this contact Format: `uri`.

The table shows the first 50 fields. Expand the raw schema below for every field.

This output schema is too large for an inline display. Read the complete live contract with deepline describe intercom_search_contacts --json.

Deepline cost

Pricing model: fixed (per call).
Estimated Deepline credits: 0 per pricing unit.
Provider-native pricing may still exist outside Deepline credit billing.

​Run this action

​CLI

​Example response

​Input reference

​Output reference

​Deepline cost

​Related documentation

Run this action

CLI

Example response

Input reference

Output reference

Deepline cost

Related documentation