List Child Business Accounts

Retrieve a list of Child Business Accounts for a Business Account.

Endpoint

GET /v1/business-accounts/{businessAccountId}/children

Authorization Header

Authorization: Bearer <access_token>

Path Parameters

businessAccountId REQUIRED

string (UUID)

Business Account ID. The children of this Business Account will be retrieved. Use self to retrieve the children of the Business Account associated with the request access token.

Request Body

None

Returns

Returns a list of Child Business Accounts. The following fields are returned.

string (UUID)

Business Account ID.

parentId

string (UUID)

ID of the parent Business Account.

name

string

Business Account name.

description

string

Business Account description.

SAMPLE RESPONSE

				
					[
  {
    "id": "28c823cf-d37b-4430-8dac-a77fbb90e57d",
    "parentId": "dff304ce-8314-42f8-829c-661927d34a11",
    "name": "Marketing",
    "description": "Marketing Business Account"
  }
]