Actions32
- Broadcast Actions
- Contact Actions
- Custom Event Actions
- List Actions
- Template Actions
- Transactional Actions
Contact → Get by External ID
AI-generatedSummary
Retrieve a contact from Notifuse by specifying its external ID, optionally including the contact's list subscriptions in the response.
Inputs
- External ID (required) — The external identifier of the contact to retrieve.
- Include Contact Lists — Boolean flag to include the contact's subscribed contact lists in the response. Defaults to false.
Output shape
a single contact record as JSON
The returned JSON includes contact details matching the provided external ID. If 'Include Contact Lists' is set to true, the response also includes the contact list subscriptions. Errors are thrown if the contact is not found or on API request failure.
Examples
Example 1: Get contact without lists
Provide the external ID of the contact, set 'Include Contact Lists' to false or leave unset. The node returns the contact's details without subscription lists.
Example 2: Get contact with lists
Provide the external ID and set 'Include Contact Lists' to true. The node returns the contact's details along with their contact list subscriptions.