Skip to main content
POST
Retrieve Contact

Headers

Accept
string
default:application/json

e.g. application/json

x-api-key
string

e.g. [Required] Partner specific API key provided by Birdeye for data exchange.

x-business-number
string

e.g. [Required] User assosiated businessNumber

Content-Type
string
default:application/json

Media type of the JSON request body.

Body

application/json
id
string

Id of enterprise customer. optional (if cid, phone or email is provided).

cid
string

Id of customer mapping on a location. optional (if id, phone or email is provided).

email
string

Email of customer, optional (if phone, id or cid is provided).

phone
string

Phone of customer optional (if email, id or cid is provided).

Response

OK

id
string

Id of enterprise customer.

firstName
string

First name of the customer.

lastName
string

Last name of the customer.

email
string

Email of customer, optional (if phone is provided).

phone
string

Phone of customer optional (if email is provided).

countryCode
string

Country code of the phone number. Default value=US, Other Possible values=AU,CA,MX,PR,VI

smsOptin
boolean

SMS Opting flag.

mappings
object[]

List of locations where customer is mapped. If requested by cid, only that location's mapping is returned.

tags
string

List of tags.

customFields
object[]

List of Custom fields.

externalId
string

Unique external identifier of the contact which could be from the CRM or any external system storing your contacts.

emailPreferences
object

Email communication preference flags.

smsPreferences
object

SMS communication preference flags.