Skip to main content
GET
Get Listing

Headers

Accept
string
default:application/json

e.g. application/json

x-api-key
string

e.g. [Required] Partner specific API key provided by Birdeye for data exchange.

Path Parameters

businessNumber
number
required

Business Number.

Response

OK

businessInfo
object

Business Information

additionalInfo
object

Business Additional Information

media
object

Media details.

optOut
object

Opt out section

covidInfo
object

Provide this data for updating any COVID specific information you want to share with your customers.

bingListing
object

This data will be used to update your Bing listing.

internalListing
object

Provide data for microsite listing purpose.

facebookListing
object

This data will be used to update your Facebook business page/ listing.

gmbListing
object

This data will be used to update your Google Business Profile/ listing.

appleListing
object

This data will be used to update your Google Business Profile/ listing.

thirdPartyListing
object

This data will be used to update your secondary listings sites.

socialProfileURLs
object

Profile URLs for business on top rated social sites

healthcare
object

This section is only applicable if you have purchased the health care listings plan and have been onboarded on the same.