Contacts
GET
Get Contact
GET /v1/contacts/{contactId}Retrieve a specific contact by ID.
Use Cases:
- Fetch contact details for display in your application
- Verify contact information before updates
- Check subscription status and topic memberships
- Retrieve contact properties for personalization
- Audit contact data and history
Behavior:
- Returns complete contact object including all properties
- Includes subscription status (subscribed/unsubscribed)
- Shows all topic memberships and their statuses
- Includes metadata (createdAt, updatedAt timestamps)
- Contact must belong to your workspace
Required Scope: read:contacts
Response Includes:
- Basic info: id, email, firstName, lastName
- All custom property values
- Subscription status and unsubscribe reason (if applicable)
- Topic memberships with individual subscription statuses
- Timestamps for creation and last update
Path parameters
contactIdstringrequiredContact ID
Response
200Successfully retrieved contact with all properties, subscription status, topic memberships, and metadata
objectstringrequiredidstringrequiredemailstringrequiredfirstNameanyrequiredlastNameanyrequiredphoneanyrequiredcountryanyrequiredtimezoneanyrequiredcityanyrequiredstatus"SUBSCRIBED" | "UNSUBSCRIBED" | "BOUNCED" | "COMPLAINED" | "ARCHIVED" | "UNCONFIRMED"requiredsubscribedAtanyrequiredunsubscribedAtanyrequiredpropertiesobjectrequiredtopicsstring[]required