Birdeye

Birdeye Business API

Create and maintain your business on Birdeye.

GitHub OpenAPI

Operations 15

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

POST /v1/signup/reseller/subaccount Create a business under a reseller · Create a business #
Ask an LLM
“Can a reseller create a new sub-account business through the API?”
“What details are required to sign up a new business location under my reseller account?”
Tell an agent
Create business {businessName} with zip {zip} and phone {phone} under reseller {rid}, email {email_id}.
Sign up a new sub-account named {businessName} for reseller {rid}.
POST /v1/business/{businessNumber}/search Search businesses under an account · Search Business #
Ask an LLM
“How do I search the businesses under my account by name?”
“Can I sort and page through business search results?”
Tell an agent
Search businesses under {businessNumber} for {searchStr}.
Find locations under account {businessNumber} matching {searchStr}, sorted by {sortBy}.
GET /v1/business/{business_id} Get a business profile · Get Business #
Ask an LLM
“What profile details does Birdeye hold for one of my businesses?”
“Can I pull a single business's full profile by its ID?”
Tell an agent
Get the business profile for {business_id}.
Show me the details of business {business_id}.
PUT /v1/business/{businessId} Update a business profile · Update Business #
Ask an LLM
“Can I change a location's hours of operation and website through the API?”
“Which business profile fields like services, keywords and social links can I update?”
Tell an agent
Update business {businessId} with email {emailId}, phone {phone} and services {services}.
Change the website of business {businessId} to {websiteUrl}.
DELETE /v1/business/{business_Id} Delete a business · Delete Business #
Ask an LLM
“Can I permanently delete a business from my account?”
“Is there a way to remove a location record entirely rather than just making it inactive?”
Tell an agent destructive · confirm first
Delete business {business_Id}.
Remove business {business_Id} from Birdeye.
PUT /v1/business/{business_id}/status Set a business active or inactive · Update the status #
Ask an LLM
“Can I mark a business inactive without deleting it?”
“What status values can I set on a business, active or inactive?”
Tell an agent
Set the status of business {business_id} to {astatus}.
Switch business {business_id} to {astatus} status.
GET /v1/business/child/all List child businesses of a parent account · Get Child Businesses #
Ask an LLM
“Which child businesses sit under my reseller or enterprise account?”
“Can I list every location belonging to an enterprise parent?”
Tell an agent
List the child businesses of parent {pid}.
Show all locations under enterprise {pid}.
POST /v1/business/tabs Choose the tabs on a public profile · Update public profile of Businesses #
Ask an LLM
“Can I choose which tabs appear on a business's public profile page?”
“What controls the tabs shown on my Birdeye public profile?”
Tell an agent
Update the public profile tabs of business {businessId} to {profileTabs}.
Show only profile tabs {profileTabs} for business {businessId}.
GET /v1/business/{businessId}/hierarchy Get an enterprise's location hierarchy · Get hierarchy for an enterprise #
Ask an LLM
“What does the location hierarchy look like for my enterprise?”
“Can I see the regions and levels my locations are grouped into?”
Tell an agent
Get the enterprise hierarchy for business {businessId}.
Show the location hierarchy levels of {businessId}.
POST /v1/business/business-hierarchy/location/update-mapping/{businessId} Remap a location in the hierarchy · Update Hierarchy #
Ask an LLM
“Can I move a location to a different level in the enterprise hierarchy?”
“Is it possible to remap which hierarchy level a location belongs to?”
Tell an agent
Update the hierarchy mapping for location {businessId} to level {Level}.
Remap location {businessId} in the enterprise hierarchy.
GET /v1/business/{businessNumber}/profile/customcard Get a profile's custom cards · Get Custom card details #
Ask an LLM
“Which custom cards are shown on a business's public profile?”
“Can I read the custom card content for one location?”
Tell an agent
Get the custom card details for business {businessNumber}.
List the profile custom cards on {businessNumber}.
PUT /v1/business/public/card/{cardId} Edit an existing custom card · Update Custom card #
Ask an LLM
“Can I change the title or image of a custom card already on my profile?”
“Can I pin an existing custom card to the top of the profile?”
Tell an agent
Update custom card {cardId} with title {title}.
Pin custom card {cardId} to the top and set its link to {clickURL}.
DELETE /v1/business/public/card/{cardId} Delete a custom card · Delete Custom card #
Ask an LLM
“Can I take a custom card off a business profile for good?”
“Is there a call to delete one custom card by its ID?”
Tell an agent destructive · confirm first
Delete custom card {cardId}.
Remove the profile custom card {cardId}.
GET /v1/business/{businessNumber}/timezones List timezones available to a business · Get Timezone List #
Ask an LLM
“Which timezone values can I assign to a business?”
“Where do I get the list of valid timezones for a location's profile?”
Tell an agent
List the available timezones for business {businessNumber}.
Get timezone options for {businessNumber}.
POST /v1/business/{businessNumber}/birdeye/impressions Get Birdeye profile impressions · Get Birdeye Impressions #
Ask an LLM
“How many impressions did my locations get on Birdeye over a date range?”
“Can I compare Birdeye profile impressions across several locations?”
Tell an agent
Get Birdeye impressions for locations {businessNumbers} under account {businessNumber}.
Show Birdeye impressions for {businessNumbers} from {startDate} to {endDate} under {businessNumber}.

Documentation

📖
Documentation
https://docs.birdeye.com/api/introduction
📖
Authentication
https://docs.birdeye.com/api/authentication

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/birdeye/refs/heads/main/openapi/birdeye-business-api-openapi.yml

Other Resources

🔗
Vocabulary
https://raw.githubusercontent.com/api-evangelist/birdeye/refs/heads/main/vocabulary/birdeye-vocabulary.yml
🔗
JSONLDContext
https://raw.githubusercontent.com/api-evangelist/birdeye/refs/heads/main/json-ld/birdeye-context.jsonld

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/birdeye:birdeye-business-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

birdeye-business-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Birdeye Business API
  version: '1.0'
  description: 'Operations tagged Business across 2 of this provider''s published API definitions: birdeye-birdeye-api-openapi.yml, birdeye-openapi-original.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.birdeye.com
  description: Production
- url: https://api.birdeye.com/resources
tags:


# --- truncated at 32 KB (64 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/birdeye/refs/heads/main/openapi/birdeye-business-api-openapi.yml