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 Creating a Corporate Hierarchy for instructions on using this endpoint.

Status codes

See Global Response Statuses for status codes that are common across endpoints.

The table below lists status codes that apply to this specific endpoint.

Status codeDescription
617-01Invalid group ID. The groupId does not exist in the core. Verify that groupId is correct by calling Get Group Hierarchy for the root group.
617-02Invalid subGroupLevel. The value in subGroupLevel exceeds the group's maximum level or has an invalid value.
Click Try It! to start a request and see the response here!