Sign in

v1

latestOpenAPI 3.0.32026-07-26208618579.9 KB
Card Hierarchy Group Management

Get All Groups in Card Hierarchy

This operation retrieves all groups within a specified card hierarchy, optionally filtering by card ID.

get/v1/card-hierarchies/{cardHierarchyId}/groups

Path parameters

cardHierarchyIdstring biginteger required

Card hierarchy id

Query parameters

cardIdstring biginteger

Card id

auditUserstring required

The audit user to log the request

Response

Successful retrieval of the card hierarchy groups

idstring biginteger required

Generated id of the group

namestring required

Name of the group

parentIdstring biginteger

Id of the parent group

type'ROOT' | 'INTERMEDIATE' | 'CARD' required

Type of the group