Skip to main content
GET
Get Business

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

business_id
string
required

Id of the Business.

Response

OK

services
string
required

Services (Comma separated list of services offered; used for SEO).

businessId
number

Id of the Business (Long).

name
string

Name of the Business/Product (Max 1000 character long).

alias
string

Alias, Your internal way of identifying this location.

emailId
string

Business Email ID.

phone
string

Business Phone (Required) Format is (xxx) xxx-xxxx.

fax
string

Fax number Format is (xxx) xxx-xxxx.

websiteUrl
string

Business website url.

description
string

Description of the business (10 to 4000 character long).

keywords
string

Keywords (Comma separated list of keywords; Max 10 keywords; used for SEO).

logoUrl
string

Logo Image. Minimum 250 x 250px. Recommended: 720 X 720 px. 10 KB min.

coverImageUrl
string

Cover Image (Dimension should be 1296 x 367 px).

gmbCover
string

Google Cover Image Url.

facebookCover
string

Facebook Cover Image Url.

timezone
string

Timezone of the business.

languages
any[]

Language.

isServiceAreaProvider
string

To select whether the business is Service Area Business Type. Default value is : No. Possible values are:

serviceAreas
object[]

Service Area information.

payment
string

Payment Type (Max 250 character long).

hoursOfOperations
object[]

Working hours of business for each day.

working24x7
number

Whether business is 24x7 open or not (0-false, 1-true).

location
object

Business address

reviewCount
number

Total review count of the business.

avgRating
number

Average rating of the business.

status
string

Business status. Valid values are demo, active, inactive. Default is

type
string

Business type. Valid values are "Business, Enterprise-Location, Enterprise-Product, Reseller or a existing custom hierarchy type". Default is:

category
string

Category (Mapped to Google Category).

socialProfileURLs
object

Profile URLs for business on top rated social sites

isSEOEnabled
boolean

Enable/Disbale search engine indexing of business profile. Valid values are "true","false". Default is "true"