Be the first to get access to new connectors. Get early access →
ConnectorBay Early access

Birdeye (BYOK) — connector documentation

  • MCP endpoint: https://byok-birdeye.connectorbay.com/mcp
  • REST API: POST https://byok-birdeye.connectorbay.com/v1/tools/{tool_name}, described by the OpenAPI 3.1 spec at https://byok-birdeye.connectorbay.com/openapi.json
  • Transport: Streamable HTTP, stateless, MCP specification 2025-06-18 or later
  • Authentication: your own Birdeye Birdeye API key, sent in the X-Upstream-Key header of every request (never stored, logged or cached)
  • Health: https://byok-birdeye.connectorbay.com/health · Tool schemas: https://byok-birdeye.connectorbay.com/tools.json
  • Publisher: Unify Dynamics LLC · connectorbay.com/byok-birdeye · agent@connectorbay.com

What Birdeye (BYOK) is for

Birdeye (BYOK) lets an AI assistant read your own Birdeye data through the Birdeye API with a key you supply (Birdeye API key). Read-only: 12 tools (get_user_details, get_business, list_child_businesses, get_review_summary, list_reviews, list_review_tags, get_dashboard, list_surveys, list_review_sources, count_reviews_by_source, list_competitors, get_listing). The BYOK key travels with each request, is used for that one call only and is never stored, logged or cached; it is only ever sent to api.birdeye.com. Unofficial connector by Unify Dynamics LLC: not affiliated with, endorsed by or sponsored by Birdeye. Birdeye and its logos are trademarks of their owners and are used only to say which service the connector works with.

Ask your assistant things like:

  • "Which Birdeye businesses can jane@example.com access?"
  • "What are the review count and rating of Birdeye business 12345678?"
  • "Which locations sit under my Birdeye enterprise account 12345678?"
  • "How many reviews does Birdeye business 12345678 have on each site?"
  • "Show the latest reviews that mention parking for Birdeye business 12345678"
  • "Which review tags exist for Birdeye business 12345678?"

What it does

  • get_user_details: Look up a Birdeye user by email: name, role and the businesses the user can access.
  • get_business: Get a business profile: name, contact details, address, category, status, review count, average rating and social profile links.
  • list_child_businesses: List the businesses and sub-accounts under a reseller, sub-reseller or enterprise account with type, status and city.
  • get_review_summary: Get a business's review counts and average rating per review site, plus the count per star rating.
  • list_reviews: List a business's reviews with rating, text, reviewer name, source, date and any reply. Runs a search; nothing is changed. Page with sindex and count.
  • list_review_tags: List the review tags defined for a business.
  • get_dashboard: Get the reputation dashboard of a business: all-time and last-30-day rating and review counts, sentiment split, industry benchmark, and recent positive and negative reviews.
  • list_surveys: List a business's surveys with status, creation and modification time, response count and question count.
  • list_review_sources: List the review sites (aggregation sources) connected to a business with the profile URL on each.
  • count_reviews_by_source: Count reviews per review site for a business and optionally selected locations over the last N months. Runs a report; nothing is changed.
  • list_competitors: List the competitor enterprises and their locations tracked for a business.
  • get_listing: Get a location's online listing data: name, phone, website, address, timezone, hours and business status.

BYOK key

You bring your own Birdeye Birdeye API key (https://app.birdeye.com/). Your assistant sends it in the X-Upstream-Key header with each request. ConnectorBay uses it for that one call only: it is never stored, logged or cached, never shown in an answer, and it is only sent to api.birdeye.com over https, with no redirects followed. Create a key with the fewest permissions the tools need (read-only if the provider offers it), and revoke it at the provider whenever you like.

Data sources

Live from the Birdeye API (api.birdeye.com) with a BYOK key; documentation: https://docs.birdeye.com/api/introduction. Endpoints checked against that documentation on 2026-10-16.

What it is not

Unofficial connector by Unify Dynamics LLC: not affiliated with, endorsed by or sponsored by Birdeye. Birdeye and its logos are trademarks of their owners and are used only to say which service the connector works with. It is read-only: it never creates, changes, sends or deletes anything in your Birdeye account.

Built for: Worldwide. Languages: English.