How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Birdeye Listing API

Keep your business information accurate and consistent across 50+ websites.

Birdeye Listing API is one of 27 APIs that Birdeye publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Listings. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and authentication docs.

This API exposes 16 operations across 16 paths, and defines 47 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against 2 base URLs: https://api.birdeye.com, https://api.birdeye.com/resources.

16 operations 16 paths 47 schemas 8 GET7 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://api.birdeye.com
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Birdeye Listing API declares 1 security scheme for authenticating requests. An API key is passed in the header as x-api-key (apiKey).

  • apiKey — Partner specific API key provided by Birdeye for data exchange.

Paths & Operations 16

Across 16 paths, the API surfaces 16 operations — 8 GET, 7 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Listing 16

Keep your business information accurate and consistent across 50+ websites.

POST
/v1/listing/fix
Fix Listing
fix-listing 1 param body → 200
GET
/v1/listing/status/location
Get Location Status Report
get-location-status-report 1 param → 200
POST
/v1/listing/insights
Listings Insights
listings-insights 1 param body → 200
POST
/v1/listing/report/{reportType}/datapoints
Listings Insights Datapoints
listings-insights-datapoints 2 params body → 200
GET
/v1/listing/{businessNumber}/gmb-attributes-list
Get GMB Attributes
get-gmb-attributes 3 params → 200
GET
/v1/listing/{businessNumber}/apple-location-attributes-list
Get Apple Attributes
get-apple-attributes 1 param → 200
GET
/v1/listing/{businessNumber}/apple-action-links
Get Apple Action Links
get-apple-action-links 1 param → 200
GET
/v1/listing/{businessNumber}/category-list
Get Category List
get-category-list 3 params → 200
POST
/v1/listing/{businessNumber}/create
Create Listing
create-listing 1 param body → 200
PUT
/v1/listing/{businessNumber}/update
Update Listing
update-listing 1 param body → 200
GET
/v1/listing/{businessNumber}/get
Get Listing
get-listing 1 param → 200
GET
/v1/listing/{businessNumber}/more-hours-type
Get More Hours Type
get-more-hours-type 2 params → 200
POST
/v1/listing/{businessNumber}/gmb/keywords
Get Google Keywords Count
get-google-keywords-count 1 param body → 200
POST
/v1/listing/{businessNumber}/deactivate
Deactivate Listing
deactivate-listing 1 param → 200
POST
/v1/listing/menu-details
Retrieve Menu Details
retrieve-menu-details body → 200
GET
/v1/listing/get/hotel-attributes
Get Hotel Attributes
getHotelAttributes 3 params → 200400401429

Schemas 47

The contract defines 47 schemas that model the data the API accepts and returns. The most detailed are Apiary_getLocationStatusReport_Response200 (18 properties), Apiary_updateListing_Request (13 properties), Apiary_getListing_Response200 (13 properties), Apiary_createListing_Request (13 properties). Each schema is shown below with its type and property counts.

3334Model
object
2 properties
2519Model
object
2 properties
Apiary_getListing_Response200
object
13 properties
Apiary_getGoogleKeywordsCount_Response200
object
1 property
Apiary_getHotelAttributes_Response200
object
1 property
4012Model
object
2 properties
4011Model
object
2 properties
Apiary_getLocationStatusReport_Response200
object
18 properties
2521Model
object
2 properties
3337Model
object
2 properties
2297Model
object
2 properties
2290Model
object
2 properties
Apiary_listingsInsightsDatapoints_Request
object
5 properties
4013Model
object
2 properties
4014Model
object
2 properties
89Model
object
2 properties
2457Model
object
2 properties
1161Model
object
2 properties
2520Model
object
2 properties
2518Model
object
2 properties
6001Model
object
2 properties
Apiary_getGmbAttributes_Response200
object
1 property
2516Model
object
2 properties
2522Model
object
2 properties
2513Model
object
2 properties
2512Model
object
2 properties
2511Model
object
2 properties
1175Model
object
2 properties
2296Model
object
2 properties
Apiary_listingsInsightsDatapoints_Response200
array
Apiary_createListing_Request
object
13 properties
3335Model
object
2 properties
2514Model
object
2 properties
3333Model
object
2 properties
Apiary_retrieveMenuDetails_Response200
array
1011Model
object
2 properties
6000Model
object
2 properties
3348Model
object
2 properties
3336Model
object
2 properties
1167Model
object
2 properties
Apiary_updateListing_Request
object
13 properties
Apiary_getCategoryList_Response200
array
4015Model
object
2 properties
2458Model
object
2 properties
2515Model
object
2 properties
2517Model
object
2 properties
Apiary_listingsInsights_Request
object
4 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

birdeye-listing-api-openapi.yml Raw ↑

Other APIs Birdeye publishes across the network.

Birdeye Aggregation API
Birdeye Business API
Birdeye Business Media API
Birdeye Campaign API
Birdeye Competitor AI API
Birdeye Competitor API
Birdeye Contact API
Birdeye Contact V2 API
Birdeye Conversation API
Birdeye Custom Fields API
Birdeye Employee API
Birdeye FAQ API
Where this information came from

This is an independent, third-party profile of Birdeye Listing API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.