> ## Documentation Index
> Fetch the complete documentation index at: https://docs.morf.health/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Search Contacts

> Documentation for the Search Contacts action for Intercom

![images/intercom.svg](https://mintcdn.com/morfhealth/EU2WCxuXGIUQcziR/images/intercom.svg?fit=max\&auto=format\&n=EU2WCxuXGIUQcziR\&q=85\&s=9da8767a0b421cfaadbfd9eef6bf6adf)

# Parameters

**Action** `Parameters`

**parameters**

**Properties** `Map\<Contact Property,string\>` *required*

`HI` `ID` `PII`
This field maps to the destination API `properties` field.

```json Result Object Example theme={null}
{
  "$result_object_key": [
    {
      "android_app_name": "Intercom",
      "android_app_version": "5.0.0",
      "android_device": "Pixel 3",
      "android_last_seen_at": "2024-07-12T16:00:00Z",
      "android_os_version": "10",
      "android_sdk_version": "28",
      "avatar": "https://example.org/128Wash.jpg",
      "browser": "Chrome",
      "browser_language": "en-US",
      "browser_version": "80.0.3987.132",
      "companies": {
        "data": [
          {
            "id": "123",
            "type": "company",
            "url": "/contacts/5ba682d23d7cf92bef87bfd4/companies"
          }
        ],
        "has_more": true,
        "total_count": 100,
        "url": "/contacts/5ba682d23d7cf92bef87bfd4/companies"
      },
      "created_at": "2024-07-12T16:00:00Z",
      "custom_attributes": {
        "contact_preference": "email",
        "name": "John Doe"
      },
      "email": "joe@example.com",
      "email_domain": "example.com",
      "external_id": "f3b87a2e09d514c6c2e79b9a",
      "formatted_phone": "+1123456789",
      "has_hard_bounced": true,
      "id": "5ba682d23d7cf92bef87bfd4",
      "ios_app_name": "Intercom",
      "ios_app_version": "5.0.0",
      "ios_device": "iPhone 11",
      "ios_last_seen_at": "2024-07-12T16:00:00Z",
      "ios_os_version": "13.3.1",
      "ios_sdk_version": "13.3.1",
      "language_override": "en",
      "last_contacted_at": "2024-07-12T16:00:00Z",
      "last_email_clicked_at": "2024-07-12T16:00:00Z",
      "last_email_opened_at": "2024-07-12T16:00:00Z",
      "last_replied_at": "2024-07-12T16:00:00Z",
      "last_seen_at": "2024-07-12T16:00:00Z",
      "location": {
        "city": "Dublin",
        "country": "Ireland",
        "region": "Dublin",
        "type": "location"
      },
      "marked_email_as_spam": true,
      "name": "John Doe",
      "notes": {
        "data": [
          {
            "id": "123",
            "type": "note",
            "url": "/contacts/5ba682d23d7cf92bef87bfd4/notes"
          }
        ],
        "has_more": true,
        "total_count": 100,
        "url": "/contacts/5ba682d23d7cf92bef87bfd4/notes"
      },
      "os": "Mac OS X",
      "owner_id": 123,
      "phone": "+1123456789",
      "role": "user",
      "signed_up_at": "2024-07-12T16:00:00Z",
      "social_profiles": {
        "data": [
          {
            "name": "Facebook",
            "type": "social_profile",
            "url": "http://x.com/foo"
          }
        ]
      },
      "tags": {
        "data": [
          {
            "id": "123",
            "name": "Managed by Morf",
            "type": "tag",
            "url": "/contacts/5ba682d23d7cf92bef87bfd4/tags"
          }
        ],
        "has_more": true,
        "total_count": 100,
        "url": "/contacts/5ba682d23d7cf92bef87bfd4/tags"
      },
      "type": "contact",
      "unsubscribed_from_emails": true,
      "updated_at": "2024-07-12T16:00:00Z",
      "workspace_id": "ecahpwf5"
    }
  ]
}
```

```json Result Object Description theme={null}
{
  "$result_object_key": [
    {
      "android_app_name": "The name of the Android app which the contact is using.",
      "android_app_version": "The version of the Android app which the contact is using.",
      "android_device": "The Android device which the contact is using.",
      "android_last_seen_at": "The time when the contact was last seen on an Android device.",
      "android_os_version": "The version of the Android OS which the contact is using.",
      "android_sdk_version": "The version of the Android SDK which the contact is using.",
      "avatar": "URL of the avatar",
      "browser": "The name of the browser which the contact is using.",
      "browser_language": "The language set by the browser which the contact is using.",
      "browser_version": "The version of the browser which the contact is using.",
      "companies": {
        "data": {
          "id": "ID of object",
          "type": "Type of object",
          "url": "URL to get more"
        },
        "has_more": "Has more companies",
        "total_count": "Count of companies",
        "url": "URL to get more"
      },
      "created_at": "The time when the contact was created.",
      "custom_attributes": "The custom attributes which are set for the contact.",
      "email": "The contact's email.",
      "email_domain": "The contact's email domain.",
      "external_id": "The unique identifier for the contact which is provided by the Client.",
      "formatted_phone": "The contacts phone number normalized to the E164 format",
      "has_hard_bounced": "Whether the contact has had an email sent to them hard bounce.",
      "id": "The unique identifier for the contact which is given by Intercom.",
      "ios_app_name": "The name of the iOS app which the contact is using.",
      "ios_app_version": "The version of the iOS app which the contact is using.",
      "ios_device": "The iOS device which the contact is using.",
      "ios_last_seen_at": "The last time the contact used the iOS app.",
      "ios_os_version": "The version of iOS which the contact is using.",
      "ios_sdk_version": "The version of the iOS SDK which the contact is using.",
      "language_override": "A preferred language setting for the contact used by the Intercom Messenger even if their browser settings change.",
      "last_contacted_at": "The time when the contact was last messaged.",
      "last_email_clicked_at": "The time when the contact last clicked a link in an email.",
      "last_email_opened_at": "The time when the contact last opened an email.",
      "last_replied_at": "The time when the contact last messaged in.",
      "last_seen_at": "The time when the contact was last seen (either where the Intercom Messenger was installed or when specified manually).",
      "location": {
        "city": "City",
        "country": "Country",
        "region": "Region",
        "type": "Type of object"
      },
      "marked_email_as_spam": "Whether the contact has marked an email sent to them as spam.",
      "name": "The contacts name.",
      "notes": {
        "data": {
          "id": "ID of object",
          "type": "Type of object",
          "url": "URL to get more"
        },
        "has_more": "Has more notes",
        "total_count": "Count of notes",
        "url": "URL to get more"
      },
      "os": "The operating system which the contact is using.",
      "owner_id": "The id of an admin that has been assigned account ownership of the contact.",
      "phone": "The contacts phone.",
      "role": "The role of the contact.",
      "signed_up_at": "The time specified for when a contact signed up.",
      "social_profiles": {
        "data": {
          "name": "Type of social media",
          "type": "Type of object",
          "url": "Profile URL"
        }
      },
      "tags": {
        "data": {
          "id": "ID of object",
          "name": "Name of tag",
          "type": "Type of object",
          "url": "URL to get more"
        },
        "has_more": "Has more tags",
        "total_count": "Count of tags",
        "url": "URL to get more"
      },
      "type": "The type of object.",
      "unsubscribed_from_emails": "Whether the contact is unsubscribed from emails.",
      "updated_at": "The time when the contact was last updated.",
      "workspace_id": "The id of the workspace which the contact belongs to."
    }
  ]
}
```

### Result Object Field Details

You can use the result of the action's data as inputs to downstream workflow actions.

Each fetch action requires an object name, which nests the action's result data inside the downstream data context in the workflow. See [Passing Data Between Actions](https://docs.morf.health/docs/knowledge_base/passing_data_between_actions.md) for how to set it and reference the result from downstream nodes.

Here we demonstrate how to refer to this data using the prefix `$result_object_key`.

**\[]Contact** `Fetch Action Response Object`

**fields**

**type** `string` *required*

The type of object.

```json CEL theme={null}
$result_object_key[*].type
```

```json Example theme={null}
"contact"
```

**id** `string` *required*

The unique identifier for the contact which is given by Intercom.

```json CEL theme={null}
$result_object_key[*].id
```

```json Example theme={null}
"5ba682d23d7cf92bef87bfd4"
```

**external\_id** `string`

The unique identifier for the contact which is provided by the Client.

```json CEL theme={null}
$result_object_key[*].external_id
```

```json Example theme={null}
"f3b87a2e09d514c6c2e79b9a"
```

**workspace\_id** `string` *required*

The id of the workspace which the contact belongs to.

```json CEL theme={null}
$result_object_key[*].workspace_id
```

```json Example theme={null}
"ecahpwf5"
```

**role** `string` *required*

The role of the contact.

```json CEL theme={null}
$result_object_key[*].role
```

```json Example theme={null}
"user"
```

**email** `string` *required*

The contact's email.

```json CEL theme={null}
$result_object_key[*].email
```

```json Example theme={null}
"joe@example.com"
```

**email\_domain** `string` *required*

The contact's email domain.

```json CEL theme={null}
$result_object_key[*].email_domain
```

```json Example theme={null}
"example.com"
```

**phone** `string`

The contacts phone.

```json CEL theme={null}
$result_object_key[*].phone
```

```json Example theme={null}
"+1123456789"
```

**formatted\_phone** `string`

The contacts phone number normalized to the E164 format

```json CEL theme={null}
$result_object_key[*].formatted_phone
```

```json Example theme={null}
"+1123456789"
```

**name** `string`

The contacts name.

```json CEL theme={null}
$result_object_key[*].name
```

```json Example theme={null}
"John Doe"
```

**owner\_id** `int64`

The id of an admin that has been assigned account ownership of the contact.

```json CEL theme={null}
$result_object_key[*].owner_id
```

```json Example theme={null}
123
```

**has\_hard\_bounced** `bool` *required*

Whether the contact has had an email sent to them hard bounce.

```json CEL theme={null}
$result_object_key[*].has_hard_bounced
```

```json Example theme={null}
true
```

**marked\_email\_as\_spam** `bool` *required*

Whether the contact has marked an email sent to them as spam.

```json CEL theme={null}
$result_object_key[*].marked_email_as_spam
```

```json Example theme={null}
true
```

**unsubscribed\_from\_emails** `bool` *required*

Whether the contact is unsubscribed from emails.

```json CEL theme={null}
$result_object_key[*].unsubscribed_from_emails
```

```json Example theme={null}
true
```

**created\_at** `timing.v1.Timestamp` *required*

The time when the contact was created.

```json CEL theme={null}
$result_object_key[*].created_at
```

```json Example theme={null}
"2024-07-12T16:00:00Z"
```

**updated\_at** `timing.v1.Timestamp` *required*

The time when the contact was last updated.

```json CEL theme={null}
$result_object_key[*].updated_at
```

```json Example theme={null}
"2024-07-12T16:00:00Z"
```

**signed\_up\_at** `timing.v1.Timestamp`

The time specified for when a contact signed up.

```json CEL theme={null}
$result_object_key[*].signed_up_at
```

```json Example theme={null}
"2024-07-12T16:00:00Z"
```

**last\_seen\_at** `timing.v1.Timestamp`

The time when the contact was last seen (either where the Intercom Messenger was installed or when specified manually).

```json CEL theme={null}
$result_object_key[*].last_seen_at
```

```json Example theme={null}
"2024-07-12T16:00:00Z"
```

**last\_replied\_at** `timing.v1.Timestamp`

The time when the contact last messaged in.

```json CEL theme={null}
$result_object_key[*].last_replied_at
```

```json Example theme={null}
"2024-07-12T16:00:00Z"
```

**last\_contacted\_at** `timing.v1.Timestamp`

The time when the contact was last messaged.

```json CEL theme={null}
$result_object_key[*].last_contacted_at
```

```json Example theme={null}
"2024-07-12T16:00:00Z"
```

**last\_email\_opened\_at** `timing.v1.Timestamp`

The time when the contact last opened an email.

```json CEL theme={null}
$result_object_key[*].last_email_opened_at
```

```json Example theme={null}
"2024-07-12T16:00:00Z"
```

**last\_email\_clicked\_at** `timing.v1.Timestamp`

The time when the contact last clicked a link in an email.

```json CEL theme={null}
$result_object_key[*].last_email_clicked_at
```

```json Example theme={null}
"2024-07-12T16:00:00Z"
```

**language\_override** `string`

A preferred language setting for the contact used by the Intercom Messenger even if their browser settings change.

```json CEL theme={null}
$result_object_key[*].language_override
```

```json Example theme={null}
"en"
```

**browser** `string`

The name of the browser which the contact is using.

```json CEL theme={null}
$result_object_key[*].browser
```

```json Example theme={null}
"Chrome"
```

**browser\_version** `string`

The version of the browser which the contact is using.

```json CEL theme={null}
$result_object_key[*].browser_version
```

```json Example theme={null}
"80.0.3987.132"
```

**browser\_language** `string`

The language set by the browser which the contact is using.

```json CEL theme={null}
$result_object_key[*].browser_language
```

```json Example theme={null}
"en-US"
```

**os** `string`

The operating system which the contact is using.

```json CEL theme={null}
$result_object_key[*].os
```

```json Example theme={null}
"Mac OS X"
```

**android\_app\_name** `string`

The name of the Android app which the contact is using.

```json CEL theme={null}
$result_object_key[*].android_app_name
```

```json Example theme={null}
"Intercom"
```

**android\_app\_version** `string`

The version of the Android app which the contact is using.

```json CEL theme={null}
$result_object_key[*].android_app_version
```

```json Example theme={null}
"5.0.0"
```

**android\_device** `string`

The Android device which the contact is using.

```json CEL theme={null}
$result_object_key[*].android_device
```

```json Example theme={null}
"Pixel 3"
```

**android\_os\_version** `string`

The version of the Android OS which the contact is using.

```json CEL theme={null}
$result_object_key[*].android_os_version
```

```json Example theme={null}
"10"
```

**android\_sdk\_version** `string`

The version of the Android SDK which the contact is using.

```json CEL theme={null}
$result_object_key[*].android_sdk_version
```

```json Example theme={null}
"28"
```

**android\_last\_seen\_at** `timing.v1.Timestamp`

The time when the contact was last seen on an Android device.

```json CEL theme={null}
$result_object_key[*].android_last_seen_at
```

```json Example theme={null}
"2024-07-12T16:00:00Z"
```

**ios\_app\_name** `string`

The name of the iOS app which the contact is using.

```json CEL theme={null}
$result_object_key[*].ios_app_name
```

```json Example theme={null}
"Intercom"
```

**ios\_app\_version** `string`

The version of the iOS app which the contact is using.

```json CEL theme={null}
$result_object_key[*].ios_app_version
```

```json Example theme={null}
"5.0.0"
```

**ios\_device** `string`

The iOS device which the contact is using.

```json CEL theme={null}
$result_object_key[*].ios_device
```

```json Example theme={null}
"iPhone 11"
```

**ios\_os\_version** `string`

The version of iOS which the contact is using.

```json CEL theme={null}
$result_object_key[*].ios_os_version
```

```json Example theme={null}
"13.3.1"
```

**ios\_sdk\_version** `string`

The version of the iOS SDK which the contact is using.

```json CEL theme={null}
$result_object_key[*].ios_sdk_version
```

```json Example theme={null}
"13.3.1"
```

**ios\_last\_seen\_at** `timing.v1.Timestamp`

The last time the contact used the iOS app.

```json CEL theme={null}
$result_object_key[*].ios_last_seen_at
```

```json Example theme={null}
"2024-07-12T16:00:00Z"
```

**custom\_attributes** `object` *required*

The custom attributes which are set for the contact.

```json CEL theme={null}
$result_object_key[*].custom_attributes
```

```json Example theme={null}
{
"contact_preference": "email",
"name": "John Doe"
}
```

**avatar** `string`

URL of the avatar

```json CEL theme={null}
$result_object_key[*].avatar
```

```json Example theme={null}
"https://example.org/128Wash.jpg"
```

**tags** `object`

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.

```json CEL theme={null}
$result_object_key[*].tags
```

```json Example theme={null}
{
"data": [
{
"id": "123",
"name": "Managed by Morf",
"type": "tag",
"url": "/contacts/5ba682d23d7cf92bef87bfd4/tags"
}
],
"has_more": true,
"total_count": 100,
"url": "/contacts/5ba682d23d7cf92bef87bfd4/tags"
}
```

**tags.data** `[]object`

Array of objects

```json CEL theme={null}
$result_object_key[*].tags.data
```

```json Example theme={null}
[
{
"id": "123",
"name": "Managed by Morf",
"type": "tag",
"url": "/contacts/5ba682d23d7cf92bef87bfd4/tags"
}
]
```

**tags.data.map(x, x.type)** `[]string` *required*

Mapped array of: Type of object

```json CEL theme={null}
$result_object_key[*].tags.data.map(x, x.type)
```

```json Example theme={null}
[
"tag"
]
```

**tags.data.map(x, x.id)** `[]string` *required*

Mapped array of: ID of object

```json CEL theme={null}
$result_object_key[*].tags.data.map(x, x.id)
```

```json Example theme={null}
[
"123"
]
```

**tags.data.map(x, x.url)** `[]string` *required*

Mapped array of: URL to get more

```json CEL theme={null}
$result_object_key[*].tags.data.map(x, x.url)
```

```json Example theme={null}
[
"/contacts/5ba682d23d7cf92bef87bfd4/tags"
]
```

**tags.data.map(x, x.name)** `[]string` *required*

Mapped array of: Name of tag

```json CEL theme={null}
$result_object_key[*].tags.data.map(x, x.name)
```

```json Example theme={null}
[
"Managed by Morf"
]
```

**tags.url** `string`

URL to get more

```json CEL theme={null}
$result_object_key[*].tags.url
```

```json Example theme={null}
"/contacts/5ba682d23d7cf92bef87bfd4/tags"
```

**tags.total\_count** `int64`

Count of tags

```json CEL theme={null}
$result_object_key[*].tags.total_count
```

```json Example theme={null}
100
```

**tags.has\_more** `bool`

Has more tags

```json CEL theme={null}
$result_object_key[*].tags.has_more
```

```json Example theme={null}
true
```

**notes** `object`

An object containing notes meta data about the notes that a contact has. Up to 10 will be displayed here. Use the url to get more.

```json CEL theme={null}
$result_object_key[*].notes
```

```json Example theme={null}
{
"data": [
{
"id": "123",
"type": "note",
"url": "/contacts/5ba682d23d7cf92bef87bfd4/notes"
}
],
"has_more": true,
"total_count": 100,
"url": "/contacts/5ba682d23d7cf92bef87bfd4/notes"
}
```

**notes.data** `[]object`

Array of objects

```json CEL theme={null}
$result_object_key[*].notes.data
```

```json Example theme={null}
[
{
"id": "123",
"type": "note",
"url": "/contacts/5ba682d23d7cf92bef87bfd4/notes"
}
]
```

**notes.data.map(x, x.type)** `[]string` *required*

Mapped array of: Type of object

```json CEL theme={null}
$result_object_key[*].notes.data.map(x, x.type)
```

```json Example theme={null}
[
"note"
]
```

**notes.data.map(x, x.id)** `[]string` *required*

Mapped array of: ID of object

```json CEL theme={null}
$result_object_key[*].notes.data.map(x, x.id)
```

```json Example theme={null}
[
"123"
]
```

**notes.data.map(x, x.url)** `[]string` *required*

Mapped array of: URL to get more

```json CEL theme={null}
$result_object_key[*].notes.data.map(x, x.url)
```

```json Example theme={null}
[
"/contacts/5ba682d23d7cf92bef87bfd4/notes"
]
```

**notes.url** `string`

URL to get more

```json CEL theme={null}
$result_object_key[*].notes.url
```

```json Example theme={null}
"/contacts/5ba682d23d7cf92bef87bfd4/notes"
```

**notes.total\_count** `int64`

Count of notes

```json CEL theme={null}
$result_object_key[*].notes.total_count
```

```json Example theme={null}
100
```

**notes.has\_more** `bool`

Has more notes

```json CEL theme={null}
$result_object_key[*].notes.has_more
```

```json Example theme={null}
true
```

**companies** `object` *required*

An object containing companies meta data about the companies that a contact has. Up to 10 will be displayed here. Use the url to get more.

```json CEL theme={null}
$result_object_key[*].companies
```

```json Example theme={null}
{
"data": [
{
"id": "123",
"type": "company",
"url": "/contacts/5ba682d23d7cf92bef87bfd4/companies"
}
],
"has_more": true,
"total_count": 100,
"url": "/contacts/5ba682d23d7cf92bef87bfd4/companies"
}
```

**companies.data** `[]object` *required*

Array of objects

```json CEL theme={null}
$result_object_key[*].companies.data
```

```json Example theme={null}
[
{
"id": "123",
"type": "company",
"url": "/contacts/5ba682d23d7cf92bef87bfd4/companies"
}
]
```

**companies.data.map(x, x.type)** `[]string` *required*

Mapped array of: Type of object

```json CEL theme={null}
$result_object_key[*].companies.data.map(x, x.type)
```

```json Example theme={null}
[
"company"
]
```

**companies.data.map(x, x.id)** `[]string` *required*

Mapped array of: ID of object

```json CEL theme={null}
$result_object_key[*].companies.data.map(x, x.id)
```

```json Example theme={null}
[
"123"
]
```

**companies.data.map(x, x.url)** `[]string` *required*

Mapped array of: URL to get more

```json CEL theme={null}
$result_object_key[*].companies.data.map(x, x.url)
```

```json Example theme={null}
[
"/contacts/5ba682d23d7cf92bef87bfd4/companies"
]
```

**companies.url** `string`

URL to get more

```json CEL theme={null}
$result_object_key[*].companies.url
```

```json Example theme={null}
"/contacts/5ba682d23d7cf92bef87bfd4/companies"
```

**companies.total\_count** `int64` *required*

Count of companies

```json CEL theme={null}
$result_object_key[*].companies.total_count
```

```json Example theme={null}
100
```

**companies.has\_more** `bool` *required*

Has more companies

```json CEL theme={null}
$result_object_key[*].companies.has_more
```

```json Example theme={null}
true
```

**location** `object` *required*

An object containing location meta data about a Intercom contact.

```json CEL theme={null}
$result_object_key[*].location
```

```json Example theme={null}
{
"city": "Dublin",
"country": "Ireland",
"region": "Dublin",
"type": "location"
}
```

**location.type** `string` *required*

Type of object

```json CEL theme={null}
$result_object_key[*].location.type
```

```json Example theme={null}
"location"
```

**location.country** `string`

Country

```json CEL theme={null}
$result_object_key[*].location.country
```

```json Example theme={null}
"Ireland"
```

**location.region** `string`

Region

```json CEL theme={null}
$result_object_key[*].location.region
```

```json Example theme={null}
"Dublin"
```

**location.city** `string`

City

```json CEL theme={null}
$result_object_key[*].location.city
```

```json Example theme={null}
"Dublin"
```

**social\_profiles** `object` *required*

An object containing social profiles that a contact has.

```json CEL theme={null}
$result_object_key[*].social_profiles
```

```json Example theme={null}
{
"data": [
{
"name": "Facebook",
"type": "social_profile",
"url": "http://x.com/foo"
}
]
}
```

**social\_profiles.data** `[]object` *required*

Social media profiles

```json CEL theme={null}
$result_object_key[*].social_profiles.data
```

```json Example theme={null}
[
{
"name": "Facebook",
"type": "social_profile",
"url": "http://x.com/foo"
}
]
```

**social\_profiles.data.map(x, x.type)** `[]string` *required*

Mapped array of: Type of object

```json CEL theme={null}
$result_object_key[*].social_profiles.data.map(x, x.type)
```

```json Example theme={null}
[
"social_profile"
]
```

**social\_profiles.data.map(x, x.name)** `[]string` *required*

Mapped array of: Type of social media

```json CEL theme={null}
$result_object_key[*].social_profiles.data.map(x, x.name)
```

```json Example theme={null}
[
"Facebook"
]
```

**social\_profiles.data.map(x, x.url)** `[]string` *required*

Mapped array of: Profile URL

```json CEL theme={null}
$result_object_key[*].social_profiles.data.map(x, x.url)
```

```json Example theme={null}
[
"http://x.com/foo"
]
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.