Get a contact by email address
Retrieves a contact by their email address within a specific workspace. The response always includes the contact's list subscriptions with their status (active, pending, unsubscribed, bounced, complained).
get/api/contacts.getByEmail
Query parameters
workspace_idstring required
The ID of the workspace
emailstring email required
The email address of the contact
Response
Contact found successfully
Example response
{
"contact": {
"email": "user@example.com",
"external_id": "user_12345",
"timezone": "America/New_York",
"language": "en-US",
"first_name": "John",
"last_name": "Doe",
"full_name": "John Doe",
"phone": "+15551234567",
"address_line_1": "123 Main St",
"address_line_2": "Apt 4B",
"country": "US",
"postcode": "10001",
"state": "NY",
"job_title": "Software Engineer",
"custom_string_1": "Premium tier",
"custom_number_1": 42,
"custom_datetime_1": "2023-06-01T09:00:00Z",
"custom_json_1": {
"preferences": {
"theme": "dark",
"notifications": true
}
},
"created_at": "2023-01-15T10:30:00Z",
"updated_at": "2023-04-22T15:45:00Z",
"contact_lists": [
{
"email": "user@example.com",
"list_id": "newsletter",
"list_name": "Newsletter",
"status": "active",
"created_at": "2023-01-15T10:30:00Z",
"updated_at": "2023-01-15T10:30:00Z",
"deleted_at": null
}
],
"contact_segments": [
{
"email": "user@example.com",
"segment_id": "premium_users",
"version": 1,
"matched_at": "2023-01-15T10:30:00Z",
"computed_at": "2023-01-15T10:30:00Z"
}
]
}
}