List groups
GET https://{{host}}/papi/v1/groups
You need information about the prevailing group to access most PAPI interfaces. This operation provides a read-only list of groups, which may contain properties. This operation provides a flat list of groups, along with parentGroupId information to structure them as a hierarchy. Each group also lists any available contracts that enable property features, but not which group contains a given property. Use the Identity and Access Management API to assign properties to groups, and modify the group hierarchy.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
accountSwitchKey | string | (Optional) For customers who manage more than one account, this runs the operation from another account. The Identity and Access Management API provides a list of available account switch keys. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
PAPI-Use-Prefixes | string | (Required) Enum Sets whether to represent ID prefixes in response data. Set to false when exchanging PAPI data with other APIs. | |
Accept | string |
RESPONSES
status: OK
{"accountId":"act_A-CCT3456","accountName":"Digital Company","groups":{"items":[{"contractIds":["ctr_C-0N7RAC71"],"groupId":"grp_54321","groupName":"Example.com-1-1TJZH5"},{"contractIds":["ctr_K-0N7RAK7"],"groupId":"grp_32145","groupName":"Test","parentGroupId":"grp_15225"},{"contractIds":["ctr_K-0N7RAK71"],"groupId":"grp_32145","groupName":"TomTest","parentGroupId":"grp_15225"}]}}