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.
Parameters
Hide parameters
Hide parameters
HI ID PII
This field maps to the destination API properties field.{
"$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"
}
]
}
{
"$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 a result object key to be specified which will nest the action’s result data inside the downstream data context in the Workflow. Here we demonstrate how to refer to this data using the prefix$result_object_key.
Hide fields
Hide fields
The type of object.
CEL
$result_object_key[*].type
Example
"contact"
The unique identifier for the contact which is given by Intercom.
CEL
$result_object_key[*].id
Example
"5ba682d23d7cf92bef87bfd4"
The unique identifier for the contact which is provided by the Client.
CEL
$result_object_key[*].external_id
Example
"f3b87a2e09d514c6c2e79b9a"
The id of the workspace which the contact belongs to.
CEL
$result_object_key[*].workspace_id
Example
"ecahpwf5"
The role of the contact.
CEL
$result_object_key[*].role
Example
"user"
The contact’s email.
CEL
$result_object_key[*].email
Example
"joe@example.com"
The contact’s email domain.
CEL
$result_object_key[*].email_domain
Example
"example.com"
The contacts phone.
CEL
$result_object_key[*].phone
Example
"+1123456789"
The contacts phone number normalized to the E164 format
CEL
$result_object_key[*].formatted_phone
Example
"+1123456789"
The contacts name.
CEL
$result_object_key[*].name
Example
"John Doe"
The id of an admin that has been assigned account ownership of the contact.
CEL
$result_object_key[*].owner_id
Example
123
Whether the contact has had an email sent to them hard bounce.
CEL
$result_object_key[*].has_hard_bounced
Example
true
Whether the contact has marked an email sent to them as spam.
CEL
$result_object_key[*].marked_email_as_spam
Example
true
Whether the contact is unsubscribed from emails.
CEL
$result_object_key[*].unsubscribed_from_emails
Example
true
The time when the contact was created.
CEL
$result_object_key[*].created_at
Example
"2024-07-12T16:00:00Z"
The time when the contact was last updated.
CEL
$result_object_key[*].updated_at
Example
"2024-07-12T16:00:00Z"
The time specified for when a contact signed up.
CEL
$result_object_key[*].signed_up_at
Example
"2024-07-12T16:00:00Z"
The time when the contact was last seen (either where the Intercom Messenger was installed or when specified manually).
CEL
$result_object_key[*].last_seen_at
Example
"2024-07-12T16:00:00Z"
The time when the contact last messaged in.
CEL
$result_object_key[*].last_replied_at
Example
"2024-07-12T16:00:00Z"
The time when the contact was last messaged.
CEL
$result_object_key[*].last_contacted_at
Example
"2024-07-12T16:00:00Z"
The time when the contact last opened an email.
CEL
$result_object_key[*].last_email_opened_at
Example
"2024-07-12T16:00:00Z"
The time when the contact last clicked a link in an email.
CEL
$result_object_key[*].last_email_clicked_at
Example
"2024-07-12T16:00:00Z"
A preferred language setting for the contact used by the Intercom Messenger even if their browser settings change.
CEL
$result_object_key[*].language_override
Example
"en"
The name of the browser which the contact is using.
CEL
$result_object_key[*].browser
Example
"Chrome"
The version of the browser which the contact is using.
CEL
$result_object_key[*].browser_version
Example
"80.0.3987.132"
The language set by the browser which the contact is using.
CEL
$result_object_key[*].browser_language
Example
"en-US"
The operating system which the contact is using.
CEL
$result_object_key[*].os
Example
"Mac OS X"
The name of the Android app which the contact is using.
CEL
$result_object_key[*].android_app_name
Example
"Intercom"
The version of the Android app which the contact is using.
CEL
$result_object_key[*].android_app_version
Example
"5.0.0"
The Android device which the contact is using.
CEL
$result_object_key[*].android_device
Example
"Pixel 3"
The version of the Android OS which the contact is using.
CEL
$result_object_key[*].android_os_version
Example
"10"
The version of the Android SDK which the contact is using.
CEL
$result_object_key[*].android_sdk_version
Example
"28"
The time when the contact was last seen on an Android device.
CEL
$result_object_key[*].android_last_seen_at
Example
"2024-07-12T16:00:00Z"
The name of the iOS app which the contact is using.
CEL
$result_object_key[*].ios_app_name
Example
"Intercom"
The version of the iOS app which the contact is using.
CEL
$result_object_key[*].ios_app_version
Example
"5.0.0"
The iOS device which the contact is using.
CEL
$result_object_key[*].ios_device
Example
"iPhone 11"
The version of iOS which the contact is using.
CEL
$result_object_key[*].ios_os_version
Example
"13.3.1"
The version of the iOS SDK which the contact is using.
CEL
$result_object_key[*].ios_sdk_version
Example
"13.3.1"
The last time the contact used the iOS app.
CEL
$result_object_key[*].ios_last_seen_at
Example
"2024-07-12T16:00:00Z"
The custom attributes which are set for the contact.
CEL
$result_object_key[*].custom_attributes
Example
{
"contact_preference": "email",
"name": "John Doe"
}
URL of the avatar
CEL
$result_object_key[*].avatar
Example
"https://example.org/128Wash.jpg"
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.
CEL
$result_object_key[*].tags
Example
{
"data": [
{
"id": "123",
"name": "Managed by Morf",
"type": "tag",
"url": "/contacts/5ba682d23d7cf92bef87bfd4/tags"
}
],
"has_more": true,
"total_count": 100,
"url": "/contacts/5ba682d23d7cf92bef87bfd4/tags"
}
Array of objects
CEL
$result_object_key[*].tags.data
Example
[
{
"id": "123",
"name": "Managed by Morf",
"type": "tag",
"url": "/contacts/5ba682d23d7cf92bef87bfd4/tags"
}
]
Mapped array of: Type of object
CEL
$result_object_key[*].tags.data.map(x, x.type)
Example
[
"tag"
]
Mapped array of: ID of object
CEL
$result_object_key[*].tags.data.map(x, x.id)
Example
[
"123"
]
Mapped array of: URL to get more
CEL
$result_object_key[*].tags.data.map(x, x.url)
Example
[
"/contacts/5ba682d23d7cf92bef87bfd4/tags"
]
Mapped array of: Name of tag
CEL
$result_object_key[*].tags.data.map(x, x.name)
Example
[
"Managed by Morf"
]
URL to get more
CEL
$result_object_key[*].tags.url
Example
"/contacts/5ba682d23d7cf92bef87bfd4/tags"
Count of tags
CEL
$result_object_key[*].tags.total_count
Example
100
Has more tags
CEL
$result_object_key[*].tags.has_more
Example
true
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.
CEL
$result_object_key[*].notes
Example
{
"data": [
{
"id": "123",
"type": "note",
"url": "/contacts/5ba682d23d7cf92bef87bfd4/notes"
}
],
"has_more": true,
"total_count": 100,
"url": "/contacts/5ba682d23d7cf92bef87bfd4/notes"
}
Array of objects
CEL
$result_object_key[*].notes.data
Example
[
{
"id": "123",
"type": "note",
"url": "/contacts/5ba682d23d7cf92bef87bfd4/notes"
}
]
Mapped array of: Type of object
CEL
$result_object_key[*].notes.data.map(x, x.type)
Example
[
"note"
]
Mapped array of: ID of object
CEL
$result_object_key[*].notes.data.map(x, x.id)
Example
[
"123"
]
Mapped array of: URL to get more
CEL
$result_object_key[*].notes.data.map(x, x.url)
Example
[
"/contacts/5ba682d23d7cf92bef87bfd4/notes"
]
URL to get more
CEL
$result_object_key[*].notes.url
Example
"/contacts/5ba682d23d7cf92bef87bfd4/notes"
Count of notes
CEL
$result_object_key[*].notes.total_count
Example
100
Has more notes
CEL
$result_object_key[*].notes.has_more
Example
true
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.
CEL
$result_object_key[*].companies
Example
{
"data": [
{
"id": "123",
"type": "company",
"url": "/contacts/5ba682d23d7cf92bef87bfd4/companies"
}
],
"has_more": true,
"total_count": 100,
"url": "/contacts/5ba682d23d7cf92bef87bfd4/companies"
}
Array of objects
CEL
$result_object_key[*].companies.data
Example
[
{
"id": "123",
"type": "company",
"url": "/contacts/5ba682d23d7cf92bef87bfd4/companies"
}
]
Mapped array of: Type of object
CEL
$result_object_key[*].companies.data.map(x, x.type)
Example
[
"company"
]
Mapped array of: ID of object
CEL
$result_object_key[*].companies.data.map(x, x.id)
Example
[
"123"
]
Mapped array of: URL to get more
CEL
$result_object_key[*].companies.data.map(x, x.url)
Example
[
"/contacts/5ba682d23d7cf92bef87bfd4/companies"
]
URL to get more
CEL
$result_object_key[*].companies.url
Example
"/contacts/5ba682d23d7cf92bef87bfd4/companies"
Count of companies
CEL
$result_object_key[*].companies.total_count
Example
100
Has more companies
CEL
$result_object_key[*].companies.has_more
Example
true
An object containing location meta data about a Intercom contact.
CEL
$result_object_key[*].location
Example
{
"city": "Dublin",
"country": "Ireland",
"region": "Dublin",
"type": "location"
}
Type of object
CEL
$result_object_key[*].location.type
Example
"location"
Country
CEL
$result_object_key[*].location.country
Example
"Ireland"
Region
CEL
$result_object_key[*].location.region
Example
"Dublin"
City
CEL
$result_object_key[*].location.city
Example
"Dublin"
An object containing social profiles that a contact has.
CEL
$result_object_key[*].social_profiles
Example
{
"data": [
{
"name": "Facebook",
"type": "social_profile",
"url": "http://x.com/foo"
}
]
}
Social media profiles
CEL
$result_object_key[*].social_profiles.data
Example
[
{
"name": "Facebook",
"type": "social_profile",
"url": "http://x.com/foo"
}
]
Mapped array of: Type of object
CEL
$result_object_key[*].social_profiles.data.map(x, x.type)
Example
[
"social_profile"
]
Mapped array of: Type of social media
CEL
$result_object_key[*].social_profiles.data.map(x, x.name)
Example
[
"Facebook"
]
Mapped array of: Profile URL
CEL
$result_object_key[*].social_profiles.data.map(x, x.url)
Example
[
"http://x.com/foo"
]