GET v1/bunits?bunitId={bunitId}

Returns the descendant tree of the active profile's business unit.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
bunitId An optional business unit ID. If specified, that business unit will be the starting point for the descendant tree. integer

None.

Body Parameters

None.

Response Information

Resource Description

SimpleBusinessUnit
NameDescriptionTypeAdditional information
Id The business unit ID.
integer

None.

ParentId The business unit relation's parent ID.
integer

None.

Name The name of the business unit.
string

None.

GroupName The name of the group the business unit is a part of
string

None.

SystemId globally unique identifier

None.

RemoteId integer

None.

ReportRemotely boolean

None.

SynchronizeConsumerNames boolean

None.

BusinessUnits The business unit's children.
Collection of SimpleBusinessUnit

None.

Tags Collection of Tag

None.

HasContract boolean

None.

HasReferral boolean

None.

InvoiceConsumer boolean

None.

InvoiceDay The day of the month customers of this business unit are invoiced.
Default value is zero (0) and represents the last day of the month.
integer

None.

Response Formats

application/json

Sample:

Sample not available.

text/json

Sample:

Sample not available.