Intercom: Retrieve Visitor With User ID

Retrieve a visitor with User ID.

Tool ID: intercom_retrieve_visitor_with_user_id

Run this action

Use the TypeScript SDK for a single call. Put ctx.tools.execute(...) inside a Play when the call should be durable, scheduled, or run across a CSV.

import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'intercom_retrieve_visitor_with_user_id',
  {
    "user_id": "user_123"
  },
);

console.log(result.toolResponse.raw);

CLI

deepline tools execute intercom_retrieve_visitor_with_user_id --input '{
  "user_id": "user_123"
}' --json

Example response

The SDK exposes this shape at result.toolResponse.raw. Values below are representative.

{
  "data": {
    "type": "visitor",
    "id": "id_123",
    "user_id": "user_123"
  }
}

Use deepline tools get intercom_retrieve_visitor_with_user_id --json for the latest machine-readable contract.

Input reference

You can fetch the details of a single visitor.

Name	Type	Required	Default	Details
`payload.user_id`	`string`	Yes	—	The user_id of the Visitor you want to retrieve.

Output reference

Standard tool result payload.

Name	Type	Required	Default	Details
`result.data`	`object`	Yes	—	Visitors are useful for representing anonymous people that have not yet been identified. They usually represent website visitors. Visitors are not visible in Intercom platform. The Visitors resource provides methods to fetch, update, convert and delete.
`result.data.type`	`string`	No	`"visitor"`	Value is ‘visitor’
`result.data.id`	`string`	No	—	The Intercom defined id representing the Visitor.
`result.data.user_id`	`string`	No	—	Automatically generated identifier for the Visitor.
`result.data.anonymous`	`boolean`	No	—	Identifies if this visitor is anonymous.
`result.data.email`	`string`	No	—	The email of the visitor. Format: `email`.
`result.data.phone`	`string \| null`	No	—	The phone number of the visitor.
`result.data.name`	`string \| null`	No	—	The name of the visitor.
`result.data.pseudonym`	`string \| null`	No	—	The pseudonym of the visitor.
`result.data.avatar`	`object`	No	—	—
`result.data.avatar.type`	`string`	No	`"avatar"`	—
`result.data.avatar.image_url`	`string \| null`	No	—	This object represents the avatar associated with the visitor. Format: `uri`.
`result.data.app_id`	`string`	No	—	The id of the app the visitor is associated with.
`result.data.companies`	`object`	No	—	—
`result.data.companies.type`	`"company.list"`	No	—	The type of the object Allowed: `company.list`.
`result.data.companies.companies`	`array`	No	—	—
`result.data.companies.companies[].type`	`"company"`	No	—	Value is `company` Allowed: `company`.
`result.data.companies.companies[].id`	`string`	No	—	The Intercom defined id representing the company.
`result.data.companies.companies[].name`	`string`	No	—	The name of the company.
`result.data.companies.companies[].app_id`	`string`	No	—	The Intercom defined code of the workspace the company is associated to.
`result.data.companies.companies[].plan`	`object`	No	—	—
`result.data.companies.companies[].plan.type`	`string`	No	—	Value is always “plan”
`result.data.companies.companies[].plan.id`	`string`	No	—	The id of the plan
`result.data.companies.companies[].plan.name`	`string`	No	—	The name of the plan
`result.data.companies.companies[].company_id`	`string`	No	—	The company id you have defined for the company.
`result.data.companies.companies[].remote_created_at`	`integer`	No	—	The time the company was created by you.
`result.data.companies.companies[].created_at`	`integer`	No	—	The time the company was added in Intercom.
`result.data.companies.companies[].updated_at`	`integer`	No	—	The last time the company was updated.
`result.data.companies.companies[].last_request_at`	`integer`	No	—	The time the company last recorded making a request.
`result.data.companies.companies[].size`	`integer`	No	—	The number of employees in the company.
`result.data.companies.companies[].website`	`string`	No	—	The URL for the company website.
`result.data.companies.companies[].industry`	`string`	No	—	The industry that the company operates in.
`result.data.companies.companies[].monthly_spend`	`integer`	No	—	How much revenue the company generates for your business.
`result.data.companies.companies[].session_count`	`integer`	No	—	How many sessions the company has recorded.
`result.data.companies.companies[].user_count`	`integer`	No	—	The number of users in the company.
`result.data.companies.companies[].custom_attributes`	`record`	No	—	The custom attributes you have set on the company.
`result.data.companies.companies[].tags`	`object`	No	—	The list of tags associated with the company
`result.data.companies.companies[].tags.type`	`"tag.list"`	No	—	The type of the object Allowed: `tag.list`.
`result.data.companies.companies[].tags.tags`	`array`	No	—	—
`result.data.companies.companies[].tags.tags[].type`	`string`	No	—	value is “tag”
`result.data.companies.companies[].tags.tags[].id`	`string`	No	—	The id of the tag
`result.data.companies.companies[].tags.tags[].name`	`string`	No	—	The name of the tag
`result.data.companies.companies[].segments`	`object`	No	—	The list of segments associated with the company
`result.data.companies.companies[].segments.type`	`"segment.list"`	No	—	The type of the object Allowed: `segment.list`.
`result.data.companies.companies[].segments.segments`	`array`	No	—	—
`result.data.companies.companies[].segments.segments[].type`	`"segment"`	No	—	The type of object. Allowed: `segment`.
`result.data.companies.companies[].segments.segments[].id`	`string`	No	—	The unique identifier representing the segment.
`result.data.companies.companies[].segments.segments[].name`	`string`	No	—	The name of the segment.
`result.data.companies.companies[].segments.segments[].created_at`	`integer`	No	—	The time the segment was created.
`result.data.companies.companies[].segments.segments[].updated_at`	`integer`	No	—	The time the segment was updated.

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

This output schema is too large to embed without slowing the page. Get the complete live contract with deepline tools get intercom_retrieve_visitor_with_user_id --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.

Get started

Build and automate

Common workflows

Data and integrations

Reference

Intercom: Retrieve Visitor With User ID

Run this action

CLI

Example response

Input reference

Output reference

Deepline cost

​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