Intercom API (unofficial showcase)
GET/visitors

Retrieve a visitor by user ID

Retrieves a visitor using the visitor's user_id. Use this operation when you need the details associated with a specific visitor identifier. The response includes visitor identity and profile information.

2 parameters
user_idstringrequired
The identifier of the visitor to retrieve.
Intercom-Versionstringoptional
The Intercom API version to use. Defaults to 2.17 when omitted.
Allowed:1.01.11.21.31.42.02.12.22.32.42.52.6Default:2.17

3 status codes
200Returns the visitor object, including its identifiers, profile details, and associated company and location data.
typestringoptional
Value is 'visitor'
Default:visitor
idstringoptional
The Intercom defined id representing the Visitor.
user_idstringoptional
Automatically generated identifier for the Visitor.
anonymousbooleanoptional
Identifies if this visitor is anonymous.
emailstringoptional
The email of the visitor.
phonestringoptional
The phone number of the visitor.
namestringoptional
The name of the visitor.
pseudonymstringoptional
The pseudonym of the visitor.
avatarobjectoptional
app_idstringoptional
The id of the app the visitor is associated with.
companiesobjectoptional
location_dataobjectoptional
las_request_atintegeroptional
The time the Lead last recorded making a request.
created_atintegeroptional
The time the Visitor was added to Intercom.
remote_created_atintegeroptional
The time the Visitor was added to Intercom.
signed_up_atintegeroptional
The time the Visitor signed up for your product.
updated_atintegeroptional
The last time the Visitor was updated.
session_countintegeroptional
The number of sessions the Visitor has had.
social_profilesobjectoptional
owner_idstringoptional
The id of the admin that owns the Visitor.
unsubscribed_from_emailsbooleanoptional
Whether the Visitor is unsubscribed from emails.
marked_email_as_spambooleanoptional
Identifies if this visitor has marked an email as spam.
has_hard_bouncedbooleanoptional
Identifies if this visitor has had a hard bounce.
tagsobjectoptional
segmentsobjectoptional
custom_attributesobjectoptional
The custom attributes you have set on the Visitor.
referrerstringoptional
The referer of the visitor.
utm_campaignstringoptional
The utm_campaign of the visitor.
utm_contentstringoptional
The utm_content of the visitor.
utm_mediumstringoptional
The utm_medium of the visitor.
utm_sourcestringoptional
The utm_source of the visitor.
utm_termstringoptional
The utm_term of the visitor.
do_not_trackbooleanoptional
Identifies if this visitor has do not track enabled.
401Returned when the request is unauthorized.

One documented failure

  • unauthorized

    Access Token Invalid

typestringrequired
The type is error.list
request_idstringoptional
errorsarray<object>required
An array of one or more error objects
404Returned when the visitor is not found.

One documented failure

  • not_found

    Visitor Not Found

typestringrequired
The type is error.list
request_idstringoptional
errorsarray<object>required
An array of one or more error objects

Error handling

A 401 is returned when the request is unauthorized. A 404 is returned when no visitor is found for the supplied user_id query parameter.