> ## Documentation Index
> Fetch the complete documentation index at: https://deepline.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.
# Intercom Show Contact By External Id: Inputs, Cost & CLI
> Get a contact by External ID. Includes inputs, outputs, pricing notes, Deepline CLI examples, and GTM automation guidance.
## Run in Enrichment Spreadsheet
Use this function as a column step in `deepline enrich`.
```bash theme={null}
deepline enrich --input leads.csv --output leads.enriched.csv --with 'result=intercom_show_contact_by_external_id:{"external_id":"{{external_id}}"}' --json
```
Map payload values to spreadsheet columns with `{{column_name}}` placeholders.
## Input Schema
| Name | Type | Required | Default | Description |
| --------------------- | -------- | -------- | ------- | ----------------------------------------------------- |
| `payload.external_id` | `string` | Yes | | The external ID of the user that you want to retrieve |
Show raw input schema
### Input JSON Schema
```json theme={null}
{
"type": "object",
"description": "You can fetch the details of a single contact by external ID. Note that this endpoint only supports users and not leads.",
"properties": {
"external_id": {
"type": "string",
"description": "The external ID of the user that you want to retrieve"
}
},
"required": [
"external_id"
],
"additionalProperties": false
}
```
## Output Schema
| Name | Type | Required | Default | Description |
| ------------- | -------- | -------- | ------- | ---------------------------------------------------- |
| `result.data` | `object` | Yes | | Contacts represent your leads and users in Intercom. |
| `result.meta` | `object` | No | | Additional response metadata (status, paging). |
Show raw output schema
### Output JSON Schema
```json theme={null}
{
"type": "object",
"description": "Standard tool result payload.",
"properties": {
"data": {
"type": "object",
"description": "Contacts represent your leads and users in Intercom.",
"properties": {
"type": {
"type": "string",
"description": "The type of object."
},
"id": {
"type": "string",
"description": "The unique identifier for the contact which is given by Intercom."
},
"external_id": {
"type": [
"string",
"null"
],
"description": "The unique identifier for the contact which is provided by the Client."
},
"workspace_id": {
"type": "string",
"description": "The id of the workspace which the contact belongs to."
},
"role": {
"type": "string",
"description": "The role of the contact."
},
"email": {
"type": "string",
"description": "The contact's email."
},
"email_domain": {
"type": "string",
"description": "The contact's email domain."
},
"phone": {
"type": [
"string",
"null"
],
"description": "The contacts phone."
},
"name": {
"type": [
"string",
"null"
],
"description": "The contacts name."
},
"owner_id": {
"type": [
"integer",
"null"
],
"description": "The id of an admin that has been assigned account ownership of the contact."
},
"has_hard_bounced": {
"type": "boolean",
"description": "Whether the contact has had an email sent to them hard bounce."
},
"marked_email_as_spam": {
"type": "boolean",
"description": "Whether the contact has marked an email sent to them as spam."
},
"unsubscribed_from_emails": {
"type": "boolean",
"description": "Whether the contact is unsubscribed from emails."
},
"created_at": {
"type": "integer",
"description": "(Unix timestamp in seconds) The time when the contact was created.",
"format": "date-time"
},
"updated_at": {
"type": "integer",
"description": "(Unix timestamp in seconds) The time when the contact was last updated.",
"format": "date-time"
},
"signed_up_at": {
"type": [
"integer",
"null"
],
"description": "(Unix timestamp in seconds) The time specified for when a contact signed up.",
"format": "date-time"
},
"last_seen_at": {
"type": [
"integer",
"null"
],
"description": "(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"
},
"last_replied_at": {
"type": [
"integer",
"null"
],
"description": "(Unix timestamp in seconds) The time when the contact last messaged in.",
"format": "date-time"
},
"last_contacted_at": {
"type": [
"integer",
"null"
],
"description": "(Unix timestamp in seconds) The time when the contact was last messaged.",
"format": "date-time"
},
"last_email_opened_at": {
"type": [
"integer",
"null"
],
"description": "(Unix timestamp in seconds) The time when the contact last opened an email.",
"format": "date-time"
},
"last_email_clicked_at": {
"type": [
"integer",
"null"
],
"description": "(Unix timestamp in seconds) The time when the contact last clicked a link in an email.",
"format": "date-time"
},
"language_override": {
"type": [
"string",
"null"
],
"description": "A preferred language setting for the contact, used by the Intercom Messenger even if their browser settings change."
},
"browser": {
"type": [
"string",
"null"
],
"description": "The name of the browser which the contact is using."
},
"browser_version": {
"type": [
"string",
"null"
],
"description": "The version of the browser which the contact is using."
},
"browser_language": {
"type": [
"string",
"null"
],
"description": "The language set by the browser which the contact is using."
},
"os": {
"type": [
"string",
"null"
],
"description": "The operating system which the contact is using."
},
"android_app_name": {
"type": [
"string",
"null"
],
"description": "The name of the Android app which the contact is using."
},
"android_app_version": {
"type": [
"string",
"null"
],
"description": "The version of the Android app which the contact is using."
},
"android_device": {
"type": [
"string",
"null"
],
"description": "The Android device which the contact is using."
},
"android_os_version": {
"type": [
"string",
"null"
],
"description": "The version of the Android OS which the contact is using."
},
"android_sdk_version": {
"type": [
"string",
"null"
],
"description": "The version of the Android SDK which the contact is using."
},
"android_last_seen_at": {
"type": [
"integer",
"null"
],
"description": "(Unix timestamp in seconds) The time when the contact was last seen on an Android device.",
"format": "date-time"
},
"ios_app_name": {
"type": [
"string",
"null"
],
"description": "The name of the iOS app which the contact is using."
},
"ios_app_version": {
"type": [
"string",
"null"
],
"description": "The version of the iOS app which the contact is using."
},
"ios_device": {
"type": [
"string",
"null"
],
"description": "The iOS device which the contact is using."
},
"ios_os_version": {
"type": [
"string",
"null"
],
"description": "The version of iOS which the contact is using."
},
"ios_sdk_version": {
"type": [
"string",
"null"
],
"description": "The version of the iOS SDK which the contact is using."
},
"ios_last_seen_at": {
"type": [
"integer",
"null"
],
"description": "(Unix timestamp in seconds) The last time the contact used the iOS app.",
"format": "date-time"
},
"custom_attributes": {
"type": "object",
"description": "The custom attributes which are set for the contact."
},
"avatar": {
"type": [
"object",
"null"
],
"properties": {
"type": {
"type": "string",
"description": "The type of object"
},
"image_url": {
"type": [
"string",
"null"
],
"description": "An image URL containing the avatar of a contact.",
"format": "uri"
}
},
"additionalProperties": false
},
"tags": {
"type": [
"object",
"null"
],
"description": "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.",
"properties": {
"data": {
"type": "array",
"description": "This object represents the tags attached to a contact.",
"items": {
"type": "object",
"description": "A list used to access other resources from a parent model.",
"properties": {
"type": {
"type": "string",
"description": "The addressable object type",
"format": "uri"
},
"id": {
"type": "string",
"description": "The id of the addressable object"
},
"url": {
"type": "string",
"description": "Url to get more company resources for this contact",
"format": "uri"
}
},
"additionalProperties": false
}
},
"url": {
"type": "string",
"description": "url to get more tag resources for this contact",
"format": "uri"
},
"total_count": {
"type": "integer",
"description": "Int representing the total number of tags attached to this contact"
},
"has_more": {
"type": "boolean",
"description": "Whether there's more Addressable Objects to be viewed. If true, use the url to view all"
}
},
"additionalProperties": false
},
"notes": {
"type": "object",
"description": "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.",
"properties": {
"data": {
"type": "array",
"description": "This object represents the notes attached to a contact.",
"items": {
"type": "object",
"description": "A list used to access other resources from a parent model.",
"properties": {
"type": {
"type": "string",
"description": "The addressable object type",
"format": "uri"
},
"id": {
"type": "string",
"description": "The id of the addressable object"
},
"url": {
"type": "string",
"description": "Url to get more company resources for this contact",
"format": "uri"
}
},
"additionalProperties": false
}
},
"url": {
"type": "string",
"description": "Url to get more company resources for this contact",
"format": "uri"
},
"total_count": {
"type": "integer",
"description": "Int representing the total number of companyies attached to this contact"
},
"has_more": {
"type": "boolean",
"description": "Whether there's more Addressable Objects to be viewed. If true, use the url to view all"
}
},
"additionalProperties": false
},
"companies": {
"type": "object",
"description": "An object with metadata about companies attached to a contact . Up to 10 will be displayed here. Use the url to get more.",
"properties": {
"data": {
"type": "array",
"description": "An array of company data objects attached to the contact.",
"items": {
"type": "object",
"description": "An object containing data about the companies that a contact is associated with.",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier for the company which is given by Intercom."
},
"type": {
"type": "string",
"description": "The type of the object. Always company.",
"enum": [
"company"
]
},
"url": {
"type": "string",
"description": "The relative URL of the company.",
"format": "uri"
}
},
"additionalProperties": false
}
},
"url": {
"type": "string",
"description": "Url to get more company resources for this contact",
"format": "uri"
},
"total_count": {
"type": "integer",
"description": "Integer representing the total number of companies attached to this contact"
},
"has_more": {
"type": "boolean",
"description": "Whether there's more Addressable Objects to be viewed. If true, use the url to view all"
}
},
"additionalProperties": false
},
"location": {
"type": "object",
"description": "An object containing location meta data about a Intercom contact.",
"properties": {
"type": {
"type": [
"string",
"null"
],
"description": "Always location"
},
"country": {
"type": [
"string",
"null"
],
"description": "The country that the contact is located in"
},
"region": {
"type": [
"string",
"null"
],
"description": "The overal region that the contact is located in"
},
"city": {
"type": [
"string",
"null"
],
"description": "The city that the contact is located in"
}
},
"additionalProperties": false
},
"social_profiles": {
"type": "object",
"description": "An object containing social profiles that a contact has.",
"properties": {
"data": {
"type": "array",
"description": "A list of social profiles objects associated with the contact.",
"items": {
"type": "object",
"description": "A Social Profile allows you to label your contacts, companies, and conversations and list them using that Social Profile.",
"properties": {
"type": {
"type": "string",
"description": "value is \"social_profile\""
},
"name": {
"type": "string",
"description": "The name of the Social media profile"
},
"url": {
"type": "string",
"description": "The name of the Social media profile",
"format": "uri"
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"meta": {
"type": "object",
"description": "Additional response metadata (status, paging).",
"additionalProperties": true
}
},
"required": [
"data"
],
"additionalProperties": false
}
```
## Advanced: Direct CLI
Use direct execution for single payload debugging.
```bash theme={null}
deepline tools execute intercom_show_contact_by_external_id --payload '{
"external_id": "string"
}' --json
```
### CLI flags
| Flag | Description |
| --------------------------- | --------------------------------------------------- |
| `--json` | Print machine-readable output. |
| `--wait` | Wait for terminal provider status when supported. |
| `--debug` | Enable wait mode with additional status/log output. |
| `--wait-timeout SECONDS` | Max seconds to wait in wait mode. |
| `--poll-interval SECONDS` | Polling interval in seconds during wait mode. |
| `--timeout SECONDS` | Request timeout in seconds. |
| `--connect-timeout SECONDS` | Connection timeout in seconds. |
## Cost
* Pricing model: `fixed` (per call).
* Estimated Deepline credits: `0` per pricing unit.
* Provider-native pricing may still exist outside Deepline credit billing.
* Billing mode: `no_bill`.