v1

latestOpenAPI 3.0.32026-07-2621102.1 MB
Corporate Hierarchy

Get Group Hierarchy

Use the Get Group Hierarchy endpoint to retrieve a group's hierarchy, either a root group or a non-root group. This endpoint returns only the groups, not the associated accounts. By default, the endpoint returns all of the subgroups that are downstream of the specified group. Pass a value for subGroupLevel to specify how many subgroup levels to retrieve. See <a href="doc:creating-a-corporate-hierarchy" target="_blank">Creating a Corporate Hierarchy</a> for instructions on using this endpoint.

post/getGroupHierarchy

Response

status_codeinteger nullable required

The response status code. May return a string for some statuses.

statusstring nullable required

The condition of a process or response

processing_timenumber float nullable required

The time elapsed in processing the transaction

system_timestampstring date-time nullable required

A system generated timestamp

rtokenstring nullable required

A system-generated ID used for tracking

errorsstring[]

A list of errors generated while the request was processed