Birdeye icon

Birdeye

Reputation and local marketing for multi-location businesses — collect and reply to reviews, sync listings across 50+ directories, manage contacts and campaigns, run surveys and tickets, publish social posts, and pull reputation, listings and competitor reports.

2 triggers89 searches78 actionsInstant (webhooks)Auth: API key

AI-assisted documentation42 min read

This documentation is compiled from our integration source code, internal specs for Birdeye, its official API documentation and anonymized requests logs we collect from our support team[2].

Open Birdeye on WEXTL →

To use Birdeye on WEXTL you need an active account and an API access token from your account settings.[3]

  • API KeypasswordRequired

    dashboard → Settings → API. The key is confidential; Birdeye requires it be sent only from a backend server.

    [1]
  • Account Business NumbertextRequired

    Your account business number (not a location number). Used as the default business for every module; each module can override it.

    [1]
  1. Log in to your WEXTL account, add the Birdeye node module to your workflow, and click Create new credential.
    Instant triggers use webhooks — click Create a webhook first when adding one, then create the credential.
  2. Optional: In the Credential name field, enter a name for the credential.
  3. Enter the authentication credentials you copied from your Birdeye account, or follow the on-screen instructions to create the credential.
  4. If prompted, authenticate your account and confirm access.
  5. If you want to make changes to your credential in the future, follow the steps in Manage credentials →

Notes

Credentials are org-scoped; share them with teammates from the Credentials picker on any of its nodes.For detailed information on connecting an application, see Connect an application →

Watch Conversation EventsTrigger

No fields documented.

Watch EventsTrigger

No fields documented.

Get Average Response Time By LocationSearch
Input fields[3]
FieldType
Business IDtext
Sort Orderchoice
Sort Bytext
Start Indexnumber
Page Sizenumber
Review Sitesarray
Review Site IDtext
Ratingstext
6other input fields
Output fields[3]
FieldType
Location Labeltext
Average Response Timeobject
Daysnumber
Hoursnumber
Minutesnumber
Responded Countnumber
Business Numbernumber
Get Average Response Time Over TimeSearch
Input fields[3]
FieldType
Business IDtext
Review Sitesarray
Review Site IDtext
Ratingstext
Business Numberschoice
Start Datedate
End Datedate
Comparison Start Datedate
2other input fields
Output fields[3]
FieldType
Period Labeltext
Short Labeltext
Period Starttext
Period Endtext
Average Response Timeobject
Daysnumber
Hoursnumber
Minutesnumber
Responded Countnumber
Get Birdeye ImpressionsSearch
Input fields[3]
FieldType
Business Numbertext
Business NumbersRequired
choice
Start DateRequired
text
End DateRequired
text
Limitnumber
Start Indexnumber
Sort Bytext
1other input field
Output fields[3]
FieldType
Location Nametext
Counttext
Get BusinessSearch
Input fields[3]
FieldType
Business Numbertext
Output fields[3]
FieldType
Business IDnumber
Nametext
Aliastext
Email IDtext
Phonetext
Faxtext
Website URLtext
21other output fields
Get Business Dashboard ReportSearch
Input fields[3]
FieldType
Business IDtext
Output fields[3]
FieldType
All-Time Statsobject
Last 30 Days Statsobject
Recent Negative Reviewsarray
Review IDtext
Ratingnumber
Commentstext
Review URLurl
Review Datetext
Responsetext
Source Typetext
Reviewerobject
Recent Positive Reviewsarray
Review IDtext
Ratingnumber
Commentstext
Review URLurl
Review Datetext
Responsetext
Source Typetext
Reviewerobject
Syndicationobject
Get Business HierarchySearch
Input fields[3]
FieldType
Business Numbertext
Output fields[3]
FieldType
IDnumber
Nametext
Aliastext
Addresstext
Phonetext
Statustext
Created Ontext
4other output fields
Get Campaign Request URLSearch
Input fields[3]
FieldType
Contact IDRequired
choice
Survey IDnumber
Template IDnumber
Check-in IDnumber
Business Numbertext
Output fields[3]
FieldType
External URL IDnumber
URLtext
Get Competitive Insight CategoriesSearch
Input fields[3]
FieldType
Business IDtext
Source Typechoice
Aggregation Sourcesarray
Time Periodtext
Start Datedate
End Datedate
Competitorsarray
Output fields[3]
FieldType
Categoriesarray
Get Competitive Insight KeywordsSearch
Input fields[3]
FieldType
Business IDtext
Source Typechoice
Aggregation Sourcesarray
Time Periodtext
Start Datedate
End Datedate
Competitorsarray
4other input fields
Output fields[3]
FieldType
Business IDtext
Enterprise Nametext
Keywordsarray
Countnumber
Average Scorenumber
Keyword Statsarray
Negative Keyword Adjectivesarray
1other output field
Get Competitive Insight ThemesSearch
Input fields[3]
FieldType
Business IDtext
Source Typechoice
Aggregation Sourcesarray
Time Periodtext
Start Datedate
End Datedate
Competitorsarray
3other input fields
Output fields[3]
FieldType
Business IDtext
Enterprise Nametext
Themesarray
Occurrencenumber
Average Scorenumber
Positive Percentagenumber
Negative Percentagenumber
6other output fields
Get Competitive Ranking ReportSearch
Input fields[3]
FieldType
Business IDtext
Start Datedate
End Datedate
Review Sitesarray
Review Site IDtext
Output fields[3]
FieldType
Positive Countnumber
Neutral Countnumber
Negative Countnumber
Positive Percentnumber
Neutral Percentnumber
Negative Percentnumber
Business Nametext
3other output fields
Get Competitor Review MetricsSearch
Input fields[3]
FieldType
Business IDtext
Start Indexnumber
Page Sizenumber
Sort Orderchoice
Business Numberschoice
From Datedate
To Datedate
4other input fields
Output fields[3]
FieldType
Business Locationsarray
Competitor Locationtext
Competitor Brandtext
Sourcetext
Overall Ratingnumber
Review Countnumber
Get ContactSearch
Input fields[3]
FieldType
Contact IDtext
Location Mapping IDtext
Emailtext
Phonetext
Include Experience Scoreboolean
Business Numbertext
Output fields[3]
FieldType
IDtext
First Nametext
Last Nametext
Emailtext
Phonetext
Country Codetext
Blockedboolean
10other output fields
Get Contact (V2)Search
Input fields[3]
FieldType
Contact IDtext
Location Mapping IDtext
Emailtext
Phonetext
Business Numbertext
Output fields[3]
FieldType
IDtext
First Nametext
Last Nametext
Emailtext
Phonetext
Country Codetext
Blockedboolean
9other output fields
Get Custom FieldSearch
Input fields[3]
FieldType
Business Numbertext
Field IDRequired
text
Output fields[3]
FieldType
IDnumber
Field Valuetext
Field Nametext
Typetext
Default Valuetext
Field Descriptiontext
Filterableboolean
Get Details Of A UserSearch
Input fields[3]
FieldType
EmailRequired
text
Output fields[3]
FieldType
Email IDtext
First Nametext
Last Nametext
Phonetext
User Roletext
Business Listarray
Get Google Keyword CountsSearch
Input fields[3]
FieldType
Business Numbertext
Business Numberschoice
MonthsRequired
array
Selected Keywordsarray
Keyword Searchtext
Limitnumber
Start Indexnumber
2other input fields
Output fields[3]
FieldType
Keywordtext
Frequencynumber
Get Google Service Location MappingSearch
Input fields[3]
FieldType
Business IDtext
Output fields[3]
FieldType
Resulttext
Get Insight Experience Location InfoSearch
Input fields[3]
FieldType
Business IDtext
Business NumbersRequired
choice
Start DateRequired
date
End DateRequired
date
User EmailRequired
choice
Review Sourcesarray
Ratingschoice
3other input fields
Output fields[3]
FieldType
Location Business Numbertext
Location Nametext
Experience Scorenumber
Listing Scorenumber
Sentiment Scorenumber
Reputation Scorenumber
Previous Period Experience Scorenumber
7other output fields
Get Insight Experience Over TimeSearch
Input fields[3]
FieldType
Business IDtext
Business NumbersRequired
choice
Start DateRequired
date
End DateRequired
date
Review Sourcesarray
Ratingschoice
Hierarchy Node Filtersarray
2other input fields
Output fields[3]
FieldType
Start Datetext
End Datetext
Labeltext
Short Labeltext
Experience Scorenumber
Sentimentobject
Scorenumber
Reputationobject
Scorenumber
2other output fields
Get Insight Experience Score BenchmarkSearch
Input fields[3]
FieldType
Business IDtext
Business NumbersRequired
choice
Start DateRequired
date
End DateRequired
date
Review Sourcesarray
Ratingschoice
Output fields[3]
FieldType
Actualobject
Sentiment Scorenumber
Reputation Scorenumber
Experience Scorenumber
Listing Scorenumber
Industry Sentiment Scorenumber
Industry Reputation Scorenumber
Industry Experience Scorenumber
Compareobject
Sentiment Scorenumber
Reputation Scorenumber
Experience Scorenumber
Listing Scorenumber
Get Insights Category Report By LocationSearch
Input fields[3]
FieldType
Business IDtext
Start Datedate
End Datedate
Review Sitesarray
Review Site IDtext
Business Numberschoice
Limitnumber
Output fields[3]
FieldType
Location Aliastext
Average Scorenumber
Gradetext
Total Countnumber
Metrics By Categoryobject
Get ListingSearch
Input fields[3]
FieldType
Business Numbertext
Output fields[3]
FieldType
Business Infoobject
Additional Infoobject
Mediaobject
Opt-Out Flagsobject
COVID Infoobject
Bing Listingobject
Internal Listingobject
6other output fields
Get Listings InsightsSearch
Input fields[3]
FieldType
Business Numbertext
Business Numberschoice
Start Datetext
End Datetext
View ModeRequired
text
Output fields[3]
FieldType
Map View Total Countnumber
Search View Total Countnumber
Website Visits Total Countnumber
Get Directions Total Countnumber
Calls Total Countnumber
Users Reached Total Countnumber
Users Engaged Total Countnumber
6other output fields
Get Listings Insights DatapointsSearch
Input fields[3]
FieldType
Report TypeRequired
choice
Business Numbertext
Business Numberschoice
Start Datetext
End Datetext
View Modetext
Group Bytext
1other input field
Output fields[3]
FieldType
Labeltext
Website Visits Countnumber
Directions Countnumber
Calls Countnumber
Get Location Status ReportSearch
Input fields[3]
FieldType
Business Numbertext
Output fields[3]
FieldType
Business Nametext
Activation Statustext
Last Updatedtext
Location Statustext
Publish Listingstext
Errorsarray
Total Sitesnumber
11other output fields
Get NPS By LocationSearch
Input fields[3]
FieldType
Business IDtext
Start Datedate
End Datedate
Review Sitesarray
Review Site IDtext
Business Numberschoice
Limitnumber
Output fields[3]
FieldType
Node IDnumber
Location Labeltext
Dynamic Labelobject
Detractor Percentilenumber
Passive Percentilenumber
Promoter Percentilenumber
NPS Scorenumber
5other output fields
Get NPS Over TimeSearch
Input fields[3]
FieldType
Business IDtext
Start Datedate
End Datedate
Review Sitesarray
Review Site IDtext
Limitnumber
Output fields[3]
FieldType
Period Labeltext
Short Labeltext
Period Starttext
Period Endtext
Detractor Percentilenumber
Passive Percentilenumber
Promoter Percentilenumber
5other output fields
Get Product ListingSearch
Input fields[3]
FieldType
Product IdentifierRequired
choice
Business Numbertext
Output fields[3]
FieldType
Product IDtext
Product SKUtext
Location Countnumber
Titletext
Descriptiontext
Product URLtext
Image Linktext
12other output fields
Get Review And Rating Over TimeSearch
Input fields[3]
FieldType
Business IDtext
Sort Bychoice
Sort Orderchoice
Source Aliasesarray
Source Aliastext
Business Numberschoice
Last N Daysnumber
Limitnumber
Output fields[3]
FieldType
Average Ratingnumber
Review Countnumber
Datetext
Get Review Conversion ReportSearch
Input fields[3]
FieldType
Business IDtext
From Datedate
To Datedate
Last N Daysnumber
Last N Monthsnumber
Output fields[3]
FieldType
Email Sent Infoobject
Email Open Infoobject
Email Click Infoobject
Reviews By Sourcearray
Source Nametext
Source Aliastext
Average Ratingnumber
Review Countnumber
SMS Detailobject
Get Review Count By RatingSearch
Input fields[3]
FieldType
Business IDtext
Business Numberschoice
Source Aliastext
From Datedate
To Datedate
Output fields[3]
FieldType
Total Review Countnumber
Count By Ratingarray
Ratingnumber
Countnumber
Get Review Count By Rating By EmployeeSearch
Input fields[3]
FieldType
Business IDtext
Business Numberschoice
Source Aliastext
From Datedate
To Datedate
Employeesarray
First Nametext
Last Nametext
Phonetext
Output fields[3]
FieldType
Employeesarray
Employeeobject
Count By Ratingarray
Get Review Count By SourceSearch
Input fields[3]
FieldType
Business IDtext
Source Aliasesarray
Source Aliastext
Business Numberschoice
Last N Monthsnumber
Limitnumber
Output fields[3]
FieldType
Review Countnumber
Location Nametext
Business IDtext
Counts By Sourcearray
Source Aliastext
Countnumber
Get Review Response Rate By LocationSearch
Input fields[3]
FieldType
Business IDtext
Sort Orderchoice
Sort Bytext
Start Indexnumber
Page Sizenumber
Review Sitesarray
Review Site IDtext
Ratingstext
6other input fields
Output fields[3]
FieldType
Location Labeltext
Total Countnumber
Response Ratenumber
Unresponded Ratenumber
Unresponded Countnumber
Responded Countnumber
Business Numbernumber
Get Review Response Rate Over TimeSearch
Input fields[3]
FieldType
Business IDtext
Review Sitesarray
Review Site IDtext
Ratingstext
Business Numberschoice
Start Datedate
End Datedate
Comparison Start Datedate
2other input fields
Output fields[3]
FieldType
Period Labeltext
Short Labeltext
Total Countnumber
Period Starttext
Period Endtext
Response Ratenumber
Unresponded Countnumber
4other output fields
Get Review SummarySearch
Input fields[3]
FieldType
Business IDtext
Statusestext
Output fields[3]
FieldType
Sourcesarray
Source Nametext
Source Aliastext
Average Ratingnumber
Review Countnumber
Ratingsarray
Ratingnumber
Review Countnumber
Get Reviews And Rating By LocationSearch
Input fields[3]
FieldType
Business IDtext
Sort Bychoice
Sort Orderchoice
Source Aliasesarray
Source Aliastext
Business Numberschoice
Last N Monthsnumber
Limitnumber
Output fields[3]
FieldType
Ratingnumber
Review Countnumber
Location Nametext
Business IDnumber
Statetext
Get Search AI Accuracy ReportSearch
Input fields[3]
FieldType
Business IDtext
Page Sizenumber
Start Indexnumber
Business Numberschoice
AI Modelschoice
Start Datedate
End Datedate
Output fields[3]
FieldType
Totalnumber
Has Nextboolean
Datatext
Get Search AI ConfigurationSearch
Input fields[3]
FieldType
Business IDtext
Output fields[3]
FieldType
Frequencytext
Quotanumber
Billing Typetext
Themesarray
Get Search AI Sentiment ReportSearch
Input fields[3]
FieldType
Business IDtext
Page Sizenumber
Start Indexnumber
Business Numberschoice
AI Modelschoice
Start Datedate
End Datedate
1other input field
Output fields[3]
FieldType
Totalnumber
Has Nextboolean
Datatext
Get Social Media Upload StatusSearch
Input fields[3]
FieldType
Business Numbertext
Batch IDRequired
text
Output fields[3]
FieldType
Batch IDtext
Statustext
Accepted Countnumber
Success Countnumber
Failed Countnumber
Pending Countnumber
Itemsarray
Get Social Open URL Performance ReportSearch
Input fields[3]
FieldType
Business Numbertext
Start DateRequired
text
End DateRequired
text
Social Channelsarray
Business Numberschoice
Comparison Date Rangeobject
Pagenumber
2other input fields
Output fields[3]
FieldType
Location Labeltext
Start Datetext
End Datetext
Location IDnumber
Business Numbertext
External Reference IDtext
Channel-Wise Dataobject
Get Social Post StatusSearch
Input fields[3]
FieldType
Business Numbertext
Tracking IDRequired
text
Output fields[3]
FieldType
Tracking IDtext
Account Numbertext
Social Sitetext
Sub-Business Numbersarray
Social Post Detailsarray
Get SurveySearch
Input fields[3]
FieldType
Survey IDRequired
choice
Business IDtext
Localetext
Output fields[3]
FieldType
Survey IDnumber
Logo URLtext
Nametext
Statustext
Created (epoch ms)number
Last Modified (epoch ms)number
Response Countnumber
5other output fields
Get Usage ReportSearch
Input fields[3]
FieldType
Business IDtext
Report TypeRequired
choice
Start IndexRequired
number
CountRequired
number
Start Datedate
End Datedate
Review Sitesarray
Review Site IDtext
5other input fields
Output fields[3]
FieldType
Location Nametext
Location Aliastext
Email Sent Infoobject
Email Open Infoobject
Email Click Infoobject
Recommended Reviews Countarray
Source IDnumber
Source Nametext
Source Aliastext
Average Ratingnumber
Review Countnumber
Non-Recommended Reviews Countarray
Source IDnumber
Source Nametext
Source Aliastext
Average Ratingnumber
Review Countnumber
4other output fields
Get Visitor ReportSearch
Input fields[3]
FieldType
Business IDtext
Source Aliasesarray
Source Aliastext
Business Numberschoice
Last N Monthsnumber
Limitnumber
Output fields[3]
FieldType
Visitor Countnumber
Location Nametext
Business IDtext
Visitors By Sourcearray
Source Aliastext
Countnumber
List Aggregation Source AliasesSearch
Input fields[3]
FieldType
Business IDtext
Limitnumber
Output fields[3]
FieldType
Aliastext
List Aggregation SourcesSearch
Input fields[3]
FieldType
Business IDtext
Limitnumber
Output fields[3]
FieldType
IDnumber
Source Aliastext
Source URLtext
Source Nametext
Statusnumber
List All FAQ QnASearch
Input fields[3]
FieldType
Business IDtext
Start Indexnumber
Countnumber
Orderchoice
Business Numberschoice
Limitnumber
Output fields[3]
FieldType
Questionobject
Texttext
Updated Datetext
Answersarray
All Locationsboolean
Sourcetext
Source Typetext
Source Valuetext
Business Numbersarray
List Apple Action LinksSearch
List Apple AttributesSearch
Input fields[3]
FieldType
Business Numbertext
Output fields[3]
FieldType
Attribute Groupsobject
List Archived ReviewsSearch
Input fields[3]
FieldType
Business IDtext
Business Numberschoice
Include Non-Aggregated Reviewsboolean
Start Indexnumber
Countnumber
Sort Fieldnumber
Sort Ordernumber
9other input fields
Output fields[3]
FieldType
Review IDtext
Ratingnumber
Commentstext
Recommendednumber
Statustext
Reviewerobject
First Nametext
Last Nametext
Nick Nametext
Thumbnail URLurl
Source Typetext
11other output fields
List Business CompetitorsSearch
Input fields[3]
FieldType
Business IDtext
Limitnumber
Output fields[3]
FieldType
Enterprise Business Numbertext
Enterprise Nametext
Business Competitorsarray
List Business MediaSearch
Input fields[3]
FieldType
Business Numbertext
Limitnumber
Output fields[3]
FieldType
Media IDtext
URLtext
Media Categorytext
Descriptiontext
Media Formattext
List Child BusinessesSearch
Input fields[3]
FieldType
Business Numbertext
Limitnumber
Output fields[3]
FieldType
IDnumber
Nametext
Aliastext
Addressobject
Address1text
Address2text
Sub Localitytext
Citytext
Statetext
Ziptext
Country Codetext
Country Nametext
Phonetext
Typetext
Statustext
2other output fields
List Competitor AI ReviewsSearch
Input fields[3]
FieldType
Business IDtext
Start Indexnumber
Page Sizenumber
Sort Orderchoice
Business Numberschoice
From Datedate
To Datedate
4other input fields
Output fields[3]
FieldType
Business Locationsarray
Competitor Locationtext
Competitor Brandtext
Sourcetext
Ratingnumber
Review Commenttext
Reviewer Nametext
2other output fields
List Competitor Child BusinessesSearch
Input fields[3]
FieldType
Business IDtext
Limitnumber
Output fields[3]
FieldType
Business IDtext
Business Nametext
Business Aliastext
Addressobject
Address Line 1text
Address Line 2text
Citytext
Statetext
Country Codetext
Zip Codetext
Country Nametext
Phonetext
Account Typetext
Statustext
3other output fields
List Competitor ReviewsSearch
Input fields[3]
FieldType
Business IDtext
Start IndexRequired
number
CountRequired
number
From Datedate
To Datedate
Updated From Datedate
Updated To Datedate
6other input fields
Output fields[3]
FieldType
Review IDtext
Ratingnumber
Commentstext
Titletext
Reviewerobject
First Nametext
Last Nametext
Nicknametext
Thumbnail URLtext
Emailtext
Facebook IDtext
Citytext
Statetext
Review URLtext
Source Typetext
8other output fields
List Contact Activity LogSearch
Input fields[3]
FieldType
Contact IDRequired
choice
Start Datetext
End Datetext
Limitnumber
Business Numbertext
Output fields[3]
FieldType
Typetext
Activity Datetext
Actiontext
Activity Timestampnumber
List ContactsSearch
Input fields[3]
FieldType
PageRequired
number
Page SizeRequired
number
Sort ByRequired
text
Start Datetext
End Datetext
Limitnumber
Business Numbertext
Output fields[3]
FieldType
Contact IDnumber
Nametext
Emailtext
Phonetext
Last Activitytext
List Contacts Or LeadsSearch
Input fields[3]
FieldType
Include Tag Databoolean
Include Custom Field Databoolean
Sourcestext
Start Date (UTC)Required
text
End Date (UTC)Required
text
Contact Typechoice
PageRequired
text
3other input fields
Output fields[3]
FieldType
First Nametext
Last Nametext
Emailtext
Phonetext
Createddate
Contact Typetext
Sourcetext
1other output field
List Conversation Webhook EventsSearch
Input fields[3]
FieldType
Limitnumber
Output fields[3]
FieldType
Event IDnumber
Event Nametext
List ConversationsSearch
Input fields[3]
FieldType
Start Datetext
End Datetext
Message Offsetnumber
Message Page Sizenumber
Contact Filterobject
Phonetext
Emailtext
Exclude Campaign Messagesboolean
Limitnumber
1other input field
Output fields[3]
FieldType
Conversation IDnumber
Contactobject
Contact IDnumber
Nametext
First Nametext
Last Nametext
Phonetext
Emailtext
Created Datetext
Updated Datetext
Teamtext
Location IDnumber
Messagesarray
Sent Atnumber
IDtext
Texttext
Message Datetext
Attachmentstext
Directiontext
Channeltext
Conversation Start Datetext
Last Message Received Ontext
Statustext
Last Used Channeltext
1other output field
List Custom CardsSearch
Input fields[3]
FieldType
Business Numbertext
Limitnumber
Output fields[3]
FieldType
Card IDnumber
Titletext
Descriptiontext
Image URLtext
Image Positiontext
Is Visiblenumber
Click URLtext
1other output field
List Custom FieldsSearch
Input fields[3]
FieldType
Business Numbertext
PageRequired
number
SizeRequired
number
Search Stringtext
Sort Bytext
Order Bychoice
Output fields[3]
FieldType
IDnumber
Field Valuetext
Field Nametext
Typetext
Default Valuetext
Field Descriptiontext
Filterableboolean
1other output field
List EmployeesSearch
Input fields[3]
FieldType
Business Numbertext
Limitnumber
Output fields[3]
FieldType
First Nametext
Last Nametext
Email IDtext
Phonetext
Image URLtext
List Enterprise CompetitorsSearch
Input fields[3]
FieldType
Business IDtext
Limitnumber
Output fields[3]
FieldType
Business IDtext
Business Nametext
Competitor IDtext
Business Aliastext
List GMB AttributesSearch
Input fields[3]
FieldType
Business Numbertext
Category IDRequired
choice
Country CodeRequired
choice
Output fields[3]
FieldType
Attribute Groupsobject
List Google Questions And AnswersSearch
Input fields[3]
FieldType
Business IDtext
Start IndexRequired
number
Page SizeRequired
number
Limitnumber
Output fields[3]
FieldType
Question IDnumber
Answered By Ownerboolean
Asked By Ownerboolean
Questiontext
Updated Bytext
Timetext
Updated Ontext
5other output fields
List Google ServicesSearch
Input fields[3]
FieldType
Business IDtext
Start IndexRequired
number
Page SizeRequired
number
Sort ByRequired
choice
Sort OrderRequired
choice
Searchtext
Limitnumber
Output fields[3]
FieldType
Service IDtext
Nametext
Currency Codetext
Pricenumber
Descriptiontext
Grouptext
Duration (minutes)number
List Hotel AttributesSearch
Input fields[3]
FieldType
Business Numbertext
Output fields[3]
FieldType
Hotel Attributesobject
List Listing CategoriesSearch
Input fields[3]
FieldType
Business Numbertext
SourceRequired
choice
Country CodeRequired
choice
Limitnumber
Output fields[3]
FieldType
IDtext
Nametext
Primaryboolean
List More Hours TypesSearch
Input fields[3]
FieldType
Business Numbertext
Channelchoice
Limitnumber
List Opted-Out ContactsSearch
Input fields[3]
FieldType
StartRequired
date
EndRequired
date
Subscription StatusRequired
array
Statustext
Business Numbertext
Output fields[3]
FieldType
Email Opt-Outsarray
IDnumber
First Nametext
Last Nametext
Emailtext
Phonetext
Text Opt-Outsarray
IDnumber
First Nametext
Last Nametext
Emailtext
Phonetext
Blockedarray
IDnumber
First Nametext
Last Nametext
Emailtext
Phonetext
List Opted-Out Contacts (V2)Search
Input fields[3]
FieldType
StartRequired
date
EndRequired
date
Subscription StatusRequired
array
Statustext
Business Numbertext
Output fields[3]
FieldType
Email Opt-Outsarray
IDnumber
First Nametext
Last Nametext
Emailtext
Phonetext
Opted Out Fromarray
Text Opt-Outsarray
IDnumber
First Nametext
Last Nametext
Emailtext
Phonetext
Opted Out Fromarray
Blockedarray
IDnumber
First Nametext
Last Nametext
Emailtext
Phonetext
Opted Out Fromarray
List Product ListingsSearch
Input fields[3]
FieldType
Business Numbertext
Business Numberschoice
Searchtext
Statustext
Page Sizenumber
Page Numbernumber
Limitnumber
Output fields[3]
FieldType
Product IDtext
Product SKUtext
Location Countnumber
Titletext
Descriptiontext
Product URLtext
Image Linktext
10other output fields
List Review TagsSearch
Input fields[3]
FieldType
Business IDtext
Limitnumber
Output fields[3]
FieldType
Tagtext
List ReviewsSearch
Input fields[3]
FieldType
Business IDtext
Start IndexRequired
number
CountRequired
number
Include Non-Aggregated Reviewsboolean
From Datedate
To Datedate
From Timestampdate
14other input fields
Output fields[3]
FieldType
Review IDtext
Ratingnumber
Commentstext
Titletext
Reviewerobject
First Nametext
Last Nametext
Nick Nametext
Thumbnail URLurl
Emailemail
Facebook IDtext
Citytext
Statetext
Review URL (lowercase url)url
Review URL (uppercase URL)url
10other output fields
List Search AI Available RunsSearch
Input fields[3]
FieldType
Business IDtext
Limitnumber
Output fields[3]
FieldType
Run Datetext
Themesarray
List Search AI BusinessesSearch
Input fields[3]
FieldType
Business IDtext
Business Numberschoice
AI Modelchoice
Themechoice
Page Numbernumber
Page Sizenumber
Start Datedate
3other input fields
Output fields[3]
FieldType
Themetext
Prompttext
AI Modeltext
Business Numbertext
Processed Datetext
Businessesarray
List Search AI CitationsSearch
Input fields[3]
FieldType
Business IDtext
Business Numberschoice
AI Modelchoice
Themechoice
Page Numbernumber
Page Sizenumber
Start Datedate
3other input fields
Output fields[3]
FieldType
Themetext
Prompttext
AI Modeltext
Business Numbertext
Processed Datetext
Citationsarray
List Survey ResponsesSearch
Input fields[3]
FieldType
Survey IDRequired
choice
Business Numbertext
Pagenumber
Page Sizenumber
Sort Bytext
Sort Orderchoice
Include Ticket IDsboolean
3other input fields
Output fields[3]
FieldType
Response IDnumber
Request Datetext
Response Datetext
Completedboolean
Question Countnumber
Localetext
Survey IDnumber
10other output fields
List SurveysSearch
Input fields[3]
FieldType
Business IDtext
Sort Bychoice
Sort Orderchoice
Searchtext
Limitnumber
Output fields[3]
FieldType
Survey IDnumber
Nametext
Statustext
Created (epoch ms)number
Last Modified (epoch ms)number
Response Countnumber
Question Countnumber
List TicketsSearch
Input fields[3]
FieldType
Business Numbertext
OperationRequired
choice
Start IndexRequired
number
Sort ByRequired
choice
Sort OrderRequired
choice
Include Total CountRequired
boolean
Assigneeschoice
9other input fields
Output fields[3]
FieldType
Ticket IDnumber
Statustext
Ratingnumber
External IDtext
Datetext
Posted Ontext
Update Datetext
10other output fields
List TimezonesSearch
Input fields[3]
FieldType
Business Numbertext
Limitnumber
Output fields[3]
FieldType
Valuetext
Labeltext
List Unanswered Google QuestionsSearch
Input fields[3]
FieldType
Business IDtext
Start IndexRequired
number
Page SizeRequired
number
Limitnumber
Output fields[3]
FieldType
Question IDnumber
Answered By Ownerboolean
Asked By Ownerboolean
Questiontext
Updated Bytext
Timetext
Updated Ontext
5other output fields
Retrieve Menu DetailsSearch
Input fields[3]
FieldType
Business Numbertext
Business Numberschoice
Limitnumber
Output fields[3]
FieldType
IDtext
Business Numbertext
Account Numbertext
Menu Detailsobject
Created Atdate
Updated Atdate
CRM Nametext
Search BusinessesSearch
Input fields[3]
FieldType
Business Numbertext
Search Stringtext
Sort Bytext
Sort Orderchoice
Start Indexnumber
Page Sizenumber
Limitnumber
Output fields[3]
FieldType
Nametext
Statustext
Created Attext
Created Bytext
Business Numbernumber
Typetext
Add Aggregation SourceAction
Input fields[3]
FieldType
Business IDtext
Source AliasRequired
text
Source URLRequired
text
Output fields[3]
FieldType
IDnumber
Source Aliastext
Source Nametext
Source URLtext
Bodytext
Add Business Integration MappingAction
Input fields[3]
FieldType
Business IDtext
Integration Group IDRequired
number
ActiveRequired
boolean
Integration Propertiesarray
Add Business MediaAction
Input fields[3]
FieldType
Business Numbertext
MediaRequired
array
Output fields[3]
FieldType
Mediaarray
Add Competitor Aggregation SourceAction
Input fields[3]
FieldType
Business IDtext
Competitor Account IDRequired
choice
Source AliasRequired
text
Source URLRequired
url
Output fields[3]
FieldType
Aggregation IDtext
Source Aliastext
Source Nametext
Source URLtext
Source IDnumber
Competitor Account IDtext
Add Products To LocationsAction
Input fields[3]
FieldType
Business Numbertext
Product IDsRequired
choice
Output fields[3]
FieldType
Codenumber
Messagetext
Add Ticket CommentAction
Input fields[3]
FieldType
Business Numbertext
CommentRequired
text
Ticket IDRequired
choice
User EmailRequired
choice
Output fields[3]
FieldType
Ticket IDnumber
Assign Tags To ReviewsAction
Input fields[3]
FieldType
Business IDtext
TagRequired
choice
Review IDsarray
Review IDtext
From Datedate
To Datedate
Updated From Datedate
Updated To Datedate
5other input fields
Associate Custom FieldAction
Input fields[3]
FieldType
Business Numbertext
Field IDRequired
number
Field ValueRequired
text
Output fields[3]
FieldType
IDnumber
Field Nametext
Typetext
Field Valuetext
Default Valuetext
Is Hiddenboolean
All Businessesboolean
1other output field
Create BusinessAction
Input fields[3]
FieldType
Business Numbertext
Business EmailRequired
text
Business NameRequired
text
ZIP CodeRequired
text
Business Typetext
PhoneRequired
text
Entity Categorytext
2other input fields
Output fields[3]
FieldType
Business IDnumber
Create Competitor Child BusinessAction
Input fields[3]
FieldType
Business IDtext
Output fields[3]
FieldType
Enterprise Competitor Business IDtext
Template IDnumber
Is Aggregation Requirednumber
Typetext
Enterprise Competitor Business Numbertext
Competitor Account IDtext
Business Already Presentboolean
Create Competitor EnterpriseAction
Input fields[3]
FieldType
Business IDtext
Location Competitor Nametext
Location User Emailemail
Location Country Codetext
Location Phone Numbertext
Zip Codetext
Competitor IDchoice
1other input field
Output fields[3]
FieldType
Enterprise Competitor Business IDtext
Template IDnumber
Is Aggregation Requirednumber
Typetext
Enterprise Competitor Business Numbertext
Business Already Presentboolean
Create Contact Check-inAction
Input fields[3]
FieldType
Nametext
Emailtext
Phonetext
SMS Enabledboolean
Additional Paramsarray
Parameterobject
Assisted Employeesarray
Employeeobject
External IDtext
1other input field
Output fields[3]
FieldType
Contact IDnumber
Create Contact Check-in (V2)Action
Input fields[3]
FieldType
Nametext
Emailtext
Phonetext
SMS Enabledboolean
Additional Paramsarray
Parameterobject
Assisted Employeesarray
Employeeobject
External IDtext
3other input fields
Output fields[3]
FieldType
Contact IDnumber
Create Contact Us RequestAction
Input fields[3]
FieldType
Customer Commenttext
CustomerRequired
object
Nametext
Emailtext
Phonetext
Additional Paramsarray
Parameterobject
Business Numbertext
Output fields[3]
FieldType
Contact IDnumber
Create Conversation Webhook SubscriptionAction
Input fields[3]
FieldType
Account Business Numbertext
EventsRequired
choice
Endpoint URLtext
Output fields[3]
FieldType
Subscription IDnumber
Eventsarray
Business IDnumber
Create Custom CardAction
Input fields[3]
FieldType
Business Numbertext
TitleRequired
text
Descriptiontext
Image URLtext
Image Positionnumber
Is Visiblenumber
Pin On Topnumber
1other input field
Output fields[3]
FieldType
Card IDnumber
Titletext
Descriptiontext
Image URLtext
Image Positiontext
Is Visiblenumber
Pin On Topnumber
1other output field
Create Custom FieldAction
Input fields[3]
FieldType
Business Numbertext
Field NameRequired
text
Field TypeRequired
text
Default Valuetext
Drop-Down Optionsarray
Field Descriptiontext
Filterabletext
Output fields[3]
FieldType
IDnumber
Field Nametext
Creatednumber
Updatednumber
Create Event SubscriptionAction
Input fields[3]
FieldType
Business IDtext
Webhook URLtext
Notification Emailsarray
Event Nametext
Basic Authobject
Output fields[3]
FieldType
Subscription IDtext
Messagetext
Create Google AnswerAction
Input fields[3]
FieldType
Business IDtext
Question IDRequired
choice
AnswerRequired
text
Output fields[3]
FieldType
Answer IDtext
Create Google QuestionAction
Input fields[3]
FieldType
Business IDtext
QuestionRequired
text
AnswerRequired
text
Output fields[3]
FieldType
Question IDnumber
Create Google ServiceAction
Input fields[3]
FieldType
Business IDtext
Service NameRequired
text
Currency Codechoice
Pricenumber
Descriptiontext
Grouptext
Duration (minutes)number
Output fields[3]
FieldType
Service IDtext
Create ListingAction
Input fields[3]
FieldType
Business Numbertext
Business Infoobject
Nametext
Phonetext
Website URLtext
Emailtext
Is Address Hidden (Yes/No)text
Is Service Area Provider (Yes/No)text
Main Business Descriptiontext
Service Areastext
Locationobject
Additional Infoobject
Established Yeartext
Timezonechoice
Languagesarray
More Hourstext
Apple More Hourstext
Open 24/7 (0/1)text
Hours Of Operationtext
Special Hourstext
Business Statustext
Reopen Datetext
Mediaobject
Logo URLtext
Cover Image URLtext
GMB Cover URLtext
Facebook Cover URLtext
Opt-Out Flagsobject
GMB Logo Opt-Outboolean
Facebook Logo Opt-Outboolean
GMB Cover Opt-Outboolean
Facebook Cover Opt-Outboolean
GMB Profile Opt-Outboolean
Business Profile Opt-Outboolean
COVID Infoobject
Post Descriptiontext
COVID-19 Support Linktext
Virtual Care Linktext
Bing Listingobject
Primary Category (Bing)text
Categories (Bing)array
Phone (Bing)text
Description (Bing)text
7other input fields
Create Product ListingAction
Input fields[3]
FieldType
Business Numbertext
Business Numberschoice
TitleRequired
text
Descriptiontext
Image LinkRequired
text
Additional Image Linksarray
Brand Nametext
7other input fields
Output fields[3]
FieldType
Product IDtext
Codenumber
Messagetext
Dataobject
Create Review TagsAction
Input fields[3]
FieldType
Business IDtext
Tagschoice
Create Scheduled Social PostAction
Input fields[3]
FieldType
Business Numbertext
Post TextRequired
text
Social SiteRequired
text
Sub-Business Numberschoice
Schedule Timestampnumber
Mediaarray
Additional Meta Dataobject
Create SurveyAction
Input fields[3]
FieldType
Business IDtext
Survey Nametext
Thank You Messagetext
Survey Typetext
Owner Emailtext
Pagesarray
Output fields[3]
FieldType
Survey IDnumber
Create Survey ResponseAction
Input fields[3]
FieldType
Survey IDRequired
choice
Business IDtext
Response BodyRequired
text
Create TicketAction
Input fields[3]
FieldType
Business Numbertext
External ID (Review)number
Assigned To (Email)Required
choice
Ticket TypeRequired
choice
Customerobject
Descriptiontext
Source Typechoice
2other input fields
Output fields[3]
FieldType
Ticket IDnumber
Create UserAction
Input fields[3]
FieldType
Business Numbertext
First Nametext
Last Nametext
EmailRequired
text
Phonetext
User RoleRequired
choice
Send Invitetext
Deactivate ListingAction
Input fields[3]
FieldType
Business Numbertext
Delete a UserAction
Input fields[3]
FieldType
Business Numbertext
EmailRequired
text
Delete Aggregation SourceAction
Input fields[3]
FieldType
Business IDtext
Aggregation IDRequired
choice
Delete All Google Questions And AnswersAction
Input fields[3]
FieldType
Business IDtext
Question IDRequired
choice
Delete BusinessAction
Input fields[3]
FieldType
Business Numbertext
Delete Business MediaAction
Input fields[3]
FieldType
Business Numbertext
Media IDsRequired
choice
Delete ContactAction
Input fields[3]
FieldType
Contact IDRequired
text
Location Business IDschoice
Business Numbertext
Delete Contact By IdAction
Input fields[3]
FieldType
Contact IDRequired
choice
Output fields[3]
FieldType
Emailtext
First Nametext
Numbertext
Delete Custom CardAction
Input fields[3]
FieldType
Business Numbertext
Card IDRequired
choice
Delete Custom FieldAction
Input fields[3]
FieldType
Business Numbertext
Field IDRequired
text
Delete Event SubscriptionAction
Input fields[3]
FieldType
Business IDtext
Subscription IDRequired
text
Output fields[3]
FieldType
Messagetext
Delete Google AnswerAction
Input fields[3]
FieldType
Business IDtext
Question IDRequired
choice
Delete Google QuestionAction
Input fields[3]
FieldType
Business IDtext
Question IDRequired
choice
Delete Google ServicesAction
Input fields[3]
FieldType
Business IDtext
Service IDsRequired
choice
Delete Product ListingsAction
Input fields[3]
FieldType
Business Numbertext
Product IDsRequired
choice
Output fields[3]
FieldType
Codenumber
Messagetext
Delete Review TagAction
Input fields[3]
FieldType
Business IDtext
Tag NameRequired
choice
Delete Social PostAction
Input fields[3]
FieldType
Business Numbertext
Tracking IDRequired
text
Sub-Business NumbersRequired
choice
Fix ListingAction
Input fields[3]
FieldType
Business Numbertext
Make an API Calluniversal
Input fields[3]
FieldType
URLRequired
text
MethodRequired
choice
Headersarray
Headerobject
Query Stringarray
Parameterobject
Bodytext
Output fields[3]
FieldType
Bodytext
Headersobject
Status codenumber
Onboard Google Merchant AccountAction
Input fields[3]
FieldType
Business Numbertext
Google Merchant Center Account IDRequired
text
Output fields[3]
FieldType
Codenumber
Messagetext
Remove Products From LocationsAction
Input fields[3]
FieldType
Business Numbertext
Product IDsRequired
choice
Output fields[3]
FieldType
Codenumber
Messagetext
Remove Tags From All ReviewsAction
Input fields[3]
FieldType
Business IDtext
Tagschoice
Remove Tags From ReviewsAction
Input fields[3]
FieldType
Business IDtext
TagRequired
choice
Review IDsarray
Review IDtext
From Datedate
To Datedate
Updated From Datedate
Updated To Datedate
5other input fields
Reply To ReviewAction
Input fields[3]
FieldType
Business IDtext
Review IDRequired
text
Reply Texttext
Private Responseboolean
Output fields[3]
FieldType
Responsetext
Response Bytext
Response Date (epoch ms)number
Send User Password ResetAction
Input fields[3]
FieldType
EmailRequired
text
Set Default Review SourcesAction
Input fields[3]
FieldType
Business IDsRequired
choice
Business Numbertext
Update BusinessAction
Input fields[3]
FieldType
Business Numbertext
Nametext
Aliastext
Is Address Hiddennumber
Locationobject
Address Line 1text
Address Line 2text
Sub-Localitytext
Citytext
Statetext
ZIPtext
Country Codetext
Country Nametext
EmailRequired
text
PhoneRequired
text
44other input fields
Output fields[3]
FieldType
Nametext
Aliastext
Email IDtext
Phonetext
Faxtext
Website URLtext
Descriptiontext
16other output fields
Update Business MediaAction
Input fields[3]
FieldType
Business Numbertext
Media IDRequired
choice
Media CategoryRequired
text
Update Business StatusAction
Input fields[3]
FieldType
Business Numbertext
New StatusRequired
choice
Update Communication Preferences (V2)Action
Input fields[3]
FieldType
Email Preferencesobject
Marketing Opt-Inboolean
Feedback Opt-Inboolean
Service Opt-Inboolean
SMS Preferencesobject
Marketing Opt-Inboolean
Feedback Opt-Inboolean
Service Opt-Inboolean
SMS Opt-Inboolean
Emailsarray
Emailtext
Phone Numbersarray
Phonetext
Business Numbertext
Update Contact SubscriptionAction
Input fields[3]
FieldType
PermissionRequired
choice
Emailsarray
Emailtext
Phone Numbersarray
Phonetext
Business Numbertext
Update Custom CardAction
Input fields[3]
FieldType
Business Numbertext
Card IDRequired
choice
TitleRequired
text
Descriptiontext
Image URLtext
Image Positiontext
Is Visiblenumber
4other input fields
Update Custom FieldAction
Input fields[3]
FieldType
Business Numbertext
Field IDRequired
text
Default Valuetext
Drop-Down Optionsarray
Field Descriptiontext
Filterabletext
Is Hiddentext
Update Google AnswerAction
Input fields[3]
FieldType
Business IDtext
Question IDRequired
choice
AnswerRequired
text
Update Google QuestionAction
Input fields[3]
FieldType
Business IDtext
Question IDRequired
choice
QuestionRequired
text
Update Google ServiceAction
Input fields[3]
FieldType
Business IDtext
Service IDRequired
choice
Service NameRequired
text
Currency Codechoice
Pricenumber
Descriptiontext
Grouptext
1other input field
Update Google Service Location MappingAction
Input fields[3]
FieldType
Business IDtext
Category NameRequired
choice
Service IDsRequired
choice
Update HierarchyAction
Input fields[3]
FieldType
Business Numbertext
Leveltext
Update ListingAction
Input fields[3]
FieldType
Business Numbertext
Business Infoobject
Nametext
Phonetext
Website URLtext
Emailtext
Is Address Hidden (Yes/No)text
Is Service Area Provider (Yes/No)text
Main Business Descriptiontext
Service Areastext
Locationobject
Additional Infoobject
Established Yeartext
Timezonechoice
Languagesarray
More Hourstext
Apple More Hourstext
Open 24/7 (0/1)text
Hours Of Operationtext
Special Hourstext
Business Statustext
Reopen Datetext
Mediaobject
Logo URLtext
Cover Image URLtext
GMB Cover URLtext
Facebook Cover URLtext
Opt-Out Flagsobject
GMB Logo Opt-Outboolean
Facebook Logo Opt-Outboolean
GMB Cover Opt-Outboolean
Facebook Cover Opt-Outboolean
GMB Profile Opt-Outboolean
Business Profile Opt-Outboolean
COVID Infoobject
Post Descriptiontext
COVID-19 Support Linktext
Virtual Care Linktext
Bing Listingobject
Primary Category (Bing)text
Categories (Bing)array
Phone (Bing)text
Description (Bing)text
7other input fields
Update Product ListingAction
Input fields[3]
FieldType
Product IDRequired
choice
Business Numbertext
Business Numberschoice
TitleRequired
text
Descriptiontext
Image LinkRequired
text
Additional Image Linksarray
7other input fields
Output fields[3]
FieldType
Product IDtext
Codenumber
Messagetext
Dataobject
Error Attributesarray
Update Public Profile TabsAction
Input fields[3]
FieldType
Business Numbertext
Profile Tabsarray
Update Published Social PostAction
Input fields[3]
FieldType
Business Numbertext
Tracking IDRequired
text
Post TextRequired
text
Social SiteRequired
text
Sub-Business NumbersRequired
choice
Update Scheduled Social PostAction
Input fields[3]
FieldType
Business Numbertext
Tracking IDRequired
text
Post TextRequired
text
Social SiteRequired
text
Sub-Business NumbersRequired
choice
Schedule Timestampnumber
Mediaarray
1other input field
Update Survey SettingsAction
Input fields[3]
FieldType
Survey IDRequired
choice
Business IDtext
Survey Settingsobject
Access Controlobject
Output fields[3]
FieldType
Survey IDnumber
Survey Setting IDnumber
Update TicketAction
Input fields[3]
FieldType
Business Numbertext
Ticket UpdatesRequired
array
Update UserAction
Input fields[3]
FieldType
Business Numbertext
EmailRequired
text
Enterprise-Level AccessRequired
text
Location Numbers Accesschoice
Userobject
User Rolechoice
Notificationobject
Upload Social MediaAction
Input fields[3]
FieldType
Business Numbertext
Media URLsRequired
array
Folder IDnumber
Output fields[3]
FieldType
Batch IDtext
Accepted Countnumber
Upsert ContactAction
Input fields[3]
FieldType
Contact IDtext
First Nametext
Last Nametext
Emailtext
Phonetext
Country Codechoice
SMS Opt-Inboolean
7other input fields
Output fields[3]
FieldType
IDtext
Upsert Contact (V2)Action
Input fields[3]
FieldType
Contact IDtext
First Nametext
Last Nametext
Emailtext
Phonetext
Country Codechoice
SMS Opt-Inboolean
8other input fields
Output fields[3]
FieldType
IDtext

Look for Birdeye templates in the WEXTL template library.

Browse templates →
  1. WEXTL® Birdeye Source Code connector implementation.
  2. Our users use cases and automations.
  3. Official API Documentation for Birdeye.
  4. WEXTL® visual workflow builder data.

Last updated: Aug 19, 2026 08:38