provider Contacts GET /contacts/find_by_external_id/{external_id}
@utdk/intercom /contacts/find_by_external_id/{external_id}
Get a contact by External ID
You can fetch the details of a single contact by external ID. Note that this endpoint only supports users and not leads.
Intercom-Version header
enum: 1.0, 1.1, 1.2, 1.3…
external_id path required
The external ID of the user that you want to retrieve
string

Try it

Authentication
Configure credentials for Intercom API
Gateway
The gateway proxies requests and injects credentials server-side. Configure credentials above, then enter your gateway URL.

Saved automatically to browser storage.

showcontactbyexternalid
GET/contacts/find_by_external_id/{external_id}
You can fetch the details of a single contact by external ID. Note that this endpoint only supports users and not leads.

Parameters

required

The external ID of the user that you want to retrieve

Enter a gateway URL above to enable sending.

Code snippet
Updates live as you fill in the form above.

TypeScript

import intercom from '@utdk/intercom';

await intercom.showcontactbyexternalid({
  "Intercom-Version": "2.14"
})