Skip to main content
GET
Get Child Businesses

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.

Query Parameters

pid
number
required

Reseller/Sub-reseller/Enterprise Id.

Response

200 - application/json

OK

id
number

Id of the Business

name
string

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

alias
string

Alias, Your internal way of identifying this location.

phone
string

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

address
object

Business address

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:

createdOn
string

Business singup date.

createdBy
string

Full name of the user who created the business (or location).

childCount
number

Child account count. note: applicable only for Reseller, Enterprise-Location, Enterprise-Product.