Retrieve Contact
Retrieve a customer’s contact profile and associated details.
Headers
e.g. application/json
e.g. [Required] Partner specific API key provided by Birdeye for data exchange.
e.g. [Required] User assosiated businessNumber
Media type of the JSON request body.
Body
Id of enterprise customer. optional (if cid, phone or email is provided).
Id of customer mapping on a location. optional (if id, phone or email is provided).
Email of customer, optional (if phone, id or cid is provided).
Phone of customer optional (if email, id or cid is provided).
Response
OK
Id of enterprise customer.
First name of the customer.
Last name of the customer.
Email of customer, optional (if phone is provided).
Phone of customer optional (if email is provided).
Country code of the phone number. Default value=US, Other Possible values=AU,CA,MX,PR,VI
SMS Opting flag.
List of locations where customer is mapped. If requested by cid, only that location's mapping is returned.
List of tags.
List of Custom fields.
Unique external identifier of the contact which could be from the CRM or any external system storing your contacts.
Email communication preference flags.
SMS communication preference flags.