Skip to main content
GET
Get hierarchy (v2)

Headers

Accept
string
default:application/json

e.g. application/json

x-api-key
string
required

Partner specific API key provided by Birdeye for data exchange.

x-business-number
string
required

Long business number of the business whose hierarchy you want to fetch, e.g. the business number of an enterprise or of a location.

Response

OK

businessId
number

Id of the business whose hierarchy is returned.

businessNumber
number

Business number of the business whose hierarchy is returned.

name
string

Name of the business.

type
string

Type of the business, e.g. Enterprise-Location.

hierarchy
object[]

Top level nodes of the hierarchy tree.