Birdeye

App · 13 actions

Read Birdeye businesses and reviews and manage contacts.

Actions

ActionWhat it does
Delete contactDelete contact.
Get businessGet business.
Get contactGet contact.
Get review summaryGet review summary.
List child businessesList child businesses.
List contact activityList contact activity.
List contactsList contacts.
List opted out contactsList opted out contacts.
List review tagsList review tags.
List reviewsList reviews.
List time zonesList time zones.
Save contactSave contact.
Search businessesSearch businesses.

Delete contact

Delete contact.

Inputs

Business IdbusinessIdtext
Businessid.
IdidtextRequired
Id of enterprise customer.
Business IdsbusinessIdslist
List of business Ids. If businessIds are provided, mappings would be deleted from those locations only. If no businessIds are provided, the customer would be deleted from all the locations.

Outputs

dataobject
Response.
Example output
{
  "data": {}
}

Get business

Get business.

Inputs

Business Idbusiness_idtext
Business id.

Outputs

dataobject
Response.
Example output
{
  "data": {
    "alias": "example",
    "avgRating": 1.0,
    "businessId": 1.0,
    "category": "example",
    "coverImageUrl": "example",
    "description": "example",
    "emailId": "example",
    "facebookCover": "example",
    "fax": "example",
    "gmbCover": "example",
    "hoursOfOperations": [],
    "isSEOEnabled": false,
    "isServiceAreaProvider": "example",
    "keywords": "example",
    "languages": [],
    "location": {
      "address1": "example",
      "address2": "example",
      "city": "example",
      "countryCode": "example",
      "state": "example",
      "subLocality": "example",
      "zip": "example"
    },
    "logoUrl": "example",
    "name": "example",
    "payment": "example",
    "phone": "example",
    "reviewCount": 1.0,
    "serviceAreas": [],
    "services": "example",
    "socialProfileURLs": {
      "facebookUrl": "example",
      "googleUrl": "example",
      "linkedInUrl": "example",
      "twitterUrl": "example",
      "youTubeUrl": "example"
    },
    "status": "example",
    "timezone": "example",
    "type": "example",
    "websiteUrl": "example",
    "working24x7": 1.0
  }
}

Get contact

Get contact.

Inputs

Business IdbusinessIdtext
Businessid.
Ididtext
Id of enterprise customer. optional (if cid, phone or email is provided).
Cidcidtext
Id of customer mapping on a location. optional (if id, phone or email is provided).
Emailemailtext
Email of customer, optional (if phone, id or cid is provided).
Phonephonetext
Phone of customer optional (if email, id or cid is provided).
ExperiencescoreexperienceScoretrue/false
If true, includes the experience score of the customer in the response. Default is false.

Outputs

dataobject
Response.
Example output
{
  "data": {
    "countryCode": "example",
    "customFields": [],
    "email": "example",
    "experienceScore": 1.0,
    "experienceScoreSource": "example",
    "externalId": "example",
    "firstName": "example",
    "id": "example",
    "lastName": "example",
    "mappings": [],
    "phone": "example",
    "smsOptin": false,
    "tags": "example"
  }
}

Get review summary

Get review summary.

Inputs

Business IdbusinessIdtext
Businessid.
Statusesstatuseslist
Statuses.

Outputs

dataobject
Response.
Example output
{
  "data": {
    "ratings": [],
    "sources": []
  }
}

List child businesses

List child businesses.

Inputs

Pidpidtext
Pid.

Outputs

datalist
Response.
Example output
{
  "data": []
}

List contact activity

List contact activity.

Inputs

Business IdbusinessIdtext
Businessid.
StartdatestartDatetext
Startdate.
EnddateendDatetext
Enddate.
Customer IdcustomerIdtextRequired
Customerid.

Outputs

datalist
Response.
Example output
{
  "data": []
}

List contacts

List contacts.

Inputs

Tagstagstrue/false
Tags.
Customfieldscustomfieldstrue/false
Customfields.
Sourcessourceslist
Source of the customer/lead. Possible values are api,dashboard,facebook,integration,sftp,bulkupload,webchat,crmimport,other,referral,voicecall,text,email,google.
StartdateutcstartDateUtcdate and timeRequired
Startdateutc.
EnddateutcendDateUtcdate and timeRequired
Enddateutc.
ContacttypecontactTypetext
Possible values are "lead", "customer". If blank then all contact types are returned.
Business IdbusinessIdtext
Businessid.
PagepagetextRequired
Page number to request.
SizesizetextRequired
Number of records per page, max is 5000.

Outputs

dataobject
Response.
Example output
{
  "data": {
    "contacts": [],
    "page": 1.0,
    "size": 1.0,
    "totalPages": 1.0
  }
}

List opted out contacts

List opted out contacts.

Inputs

Business IdbusinessIdtext
Businessid.
ItemsitemstextRequired
Items.

Outputs

dataobject
Response.
Example output
{
  "data": {
    "blocked": [],
    "emailOptOut": [],
    "textOptOut": []
  }
}

List review tags

List review tags.

Inputs

Business IdbusinessIdtext
Businessid.

Outputs

datalist
Response.
Example output
{
  "data": []
}

List reviews

List reviews.

Inputs

Business IdbusinessIdtext
Businessid.
SindexsindexnumberRequired
Sindex.
CountcountnumberRequired
Count.
IncludenonaggregatedreviewsincludeNonAggregatedReviewstrue/false
Includenonaggregatedreviews.
FromdatefromDatedate
Review date start in UTC format.
TodatetoDatedate
Review date end in UTC format, eg if toDate is 04/01/2013, reviews of date 04/01/2013 is excluded .
FromtimestampfromTimestampdate and time
Fromtimestamp.
TotimestamptoTimestampdate and time
Totimestamp.
UpdatefromdateupdateFromDatedate
Review updated date start in UTC format.
UpdatetodateupdateToDatedate
Review updated date end in UTC format.
Sourcessourcestext
Aggregation source name Note: use "our_website" to filter reviews posted on Birdeye platform or use "direct_feedback" for direct feedback.
Ratingsratingslist
Review rating Possible values 0,1,2,3,4,5.
SearchstrsearchStrtext
String that is contained by review.
Subbusiness IdssubBusinessIdslist
BusinessIds under enterprise account.
Statusesstatuseslist
Review status filter. Valid values are "published", "parked", and "all". If omitted, default is "published" only (featured reviews). "published" refers to featured reviews and "parked" refers to non-featured reviews.
AllchildallChildtrue/false
Get review from all child ignoring merge reviews flag configured at parent/child relationship level.
Tagstagslist
Reviews with assigned tags
FetchextraparamsfetchExtraParamstrue/false
To fetch custom field(s) associated with the customer attributed to the review [if any].
NeedcustomerinfoneedCustomerInfotrue/false
To fetch customer information associated with the reviewer [if attributed].
FetchassitedbydetailsfetchAssitedByDetailstrue/false
To retrieve employees associated with the review [if mapped].
Messageoptions ReviewfilteroptionsmessageOptions_reviewFilterOptionslist
Filter reviews by operational status. Accepted values: `"Updated-Reviews"` (reviews that have been updated after being posted) and `"Non-Updated-Reviews"` (reviews that have never been updated). Values are case-insensitive. If both values are provided together, no filter is applied.One or more of: Updated-Reviews, Non-Updated-Reviews.

Outputs

datalist
Response.
Example output
{
  "data": []
}

List time zones

List time zones.

Inputs

BusinessnumberbusinessNumbertext
Businessnumber.

Outputs

dataobject
Response.
Example output
{
  "data": {
    "timezones": []
  }
}

Save contact

Save contact.

Inputs

Business IdbusinessIdtext
Businessid.
Ididtext
Id of enterprise customer.
FirstnamefirstNametext
First name of the customer.
LastnamelastNametext
Last name of the customer.
Emailemailtext
Email of customer, optional (if phone is provided).
Phonephonetext
Phone of customer optional (if email is provided).
CountrycodecountryCodetext
Country code of the phone number. Default value=US, Other Possible values=AU,CA,MX,PR,VI
SmsoptinsmsOptintrue/false
SMS Opt flag.
EmailoptinemailOptintrue/false
Email Opt flag.
Blockedblockedtrue/false
Contact block flag.
Business IdsbusinessIdslist
Business Ids under enterprise account. The Business Ids field is mandatory while creating a new contact. While updating, if no business Ids are provided, the same location mappings are retained.
Tagstagstext
List of tags.
CustomfieldscustomFieldslist
List of Custom fields. We currently support 4 types of customfields - text, number, currency, date (in formats - “MM/dd/yyyy” and "MM-dd-yyyy" only), and yes or no (1:"yes", 0:"no").
External IdexternalIdtext
Unique external identifier of the contact which could be from the CRM or any external system storing your contacts.

Outputs

dataobject
Response.
Example output
{
  "data": {
    "id": 1.0
  }
}

Search businesses

Search businesses.

Inputs

BusinessnumberbusinessNumbertext
Businessnumber.
SearchstrsearchStrtext
Search criteria for business. This could be business name or number.
SortbysortBytext
Results can be sorted by name, createdAt, and createdBy. By default is createdAt.
SortordersortOrdertext
The SORT order, Possible values "ASC" or "DESC". By default is "DESC".
StartindexstartIndexnumber
Once sorted, it defines starting from which index a page (number of specified search results) is to be created.
PagesizepageSizenumber
Determines the number of search results in the response. Users can set a desired value to limit results, e.g., pageSize=25 shows the top 25 business listings. The Default value is 25.

Outputs

dataobject
Response.
Example output
{
  "data": {
    "accounts": [],
    "totalCount": 1.0
  }
}

On this page