Show Contact By External Id

Get a contact by External ID

GET/contacts/find_by_external_id/{external_id}

Use it in a workflow

Add a step and choose the Intercom connector.
Pick the Show Contact By External Id action (under Contacts).
Fill in the fields below, then reference the result from later steps as {{showContactByExternalId.response.data}}.

external_idstringrequired

The external ID of the user that you want to retrieve

include_merge_historyboolean

Pass `true` to include the contact's merge history in the response. Only returned for contacts with a `user` role.

Default false

Intercom-Versionstring

Intercom API version.</br>By default, it's equal to the version set in the app package.

One of1.01.11.21.31.42.02.12.22.32.42.52.62.72.82.92.102.112.122.132.142.152.16Default "2.16"

Returns 200 with an object. Read it in later steps with {{showContactByExternalId.response.data.<field>}}.

enabled_push_messagingboolean

If the user has enabled push messaging.

json

{
  "enabled_push_messaging": true
}

Need more? See the Intercom guide for connection setup and behaviour shared by every action.

Was this page helpful?