Authorizations
Include your Brew API key as a Bearer token in the Authorization header.
Example: Authorization: Bearer bw_api_your_key_here
Path Parameters
Either the contact's email address or their userId. When using an email address, you must URI-encode it (replace @ with %40). Examples:
- Email:
user%40example.com
(for user@example.com) - User ID:
user_12345
Response
Contact found and returned with all current data
Complete contact object with all properties
Unique contact identifier
"cont_2Jk9mN8pQ7rX4vL1"
Contact's email address
"jane.smith@example.com"
How the contact was added to your audience
"API"
Whether the contact is subscribed to marketing emails
true
Contact's subscription group memberships
{
"sg_newsletter": true,
"sg_product_updates": false
}
Contact's first name (null if not provided)
"Jane"
Contact's last name (null if not provided)
"Smith"
External user ID if provided (null if not set)
"user_12345"