Get Group Hierarchy

post

https://api-{corename}.{env}.gpsrv.com/intserv/4.0/getGroupHierarchy

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 code	Description
617-01	Invalid 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-02	Invalid `subGroupLevel`. The value in `subGroupLevel` exceeds the group's maximum level or has an invalid value.

Form Data

apiLogin

string

required

Web service username, as provided by Galileo.
Pattern: Max 50 characters
Example: "AbC123-9999"

apiTransKey

string

required

Web service password, as provided by Galileo.
Pattern: Max 15 characters
Example: "4sb62fh6w4h7w34g"

providerId

int32

required

Galileo-issued provider identifier.
Pattern: Max 10 digits
Example: 9999

transactionId

string

required

1 to 60

A unique provider-generated ID to identify this API call. A UUID is preferred.
Pattern: 60 characters or less
Example: "9845dk-39fdk3fj3-4483483478"

groupId

string

required

length between 1 and 10

Identifier of the group (group_id) as returned by the Create Group endpoint.
Pattern: Max 10 numeric characters
Example: "4522"

subGroupLevel

int32 | null

1 to 5

Defaults to 0

Level of hierarchy a root group/sub group can have
Example: '3'

Headers

response-content-type

string

enum

Defaults to json

Use this header instead of the standard accept header to specify the response format.

Allowed:

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Response

Language

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

application/xml