Contents

GroupEntry

The identifier, type, and per-product roles for a group that a customer belongs to.

Declaration

object GroupEntry

Properties

NameTypeDescription
groupIdgroupId

The identifier of the group.

groupTypegroupType

The type of the group.

roles[RoleEntry]

An optional array of the customer’s roles in this group, one for each of your products that the group provides access to. This array is present for a group with a groupType of ORGANIZATION, and absent for a group with a groupType of CONSUMER.

Mentioned in

Discussion

The Get Customer Groups endpoint returns a GroupEntry for each group a customer belongs to.

A customer’s role can differ per product, so roles is an array of RoleEntry values rather than a single role. Read the role for the productId you’re evaluating rather than assuming a single role applies across your products.

Topics

Group data types

See Also

Response data types