User Groups
The Group object represents a user group in the Marketplace platform. This object contains the following properties:
id
string
Primary group identifier.
Example: UGR-1234-1234
href
string
Relative reference to the object in the API.
Example: /v1/accounts/groups/UGR-1234-1234
icon
string
Relative path to the token’s logo.
Example: /static/accounts/UGR-1234-1234/logo.png
name
string
Group name.
Example: Stark Industries
description
string
Group description.
Example: Stark's marketing group
modules
List of modules available for the group.
Example: Invoices
default
bool
Indicates if the user group is set as default in the account. There is only one default user group per account.
Example: true
stats
stats
Statistics of the group. A group can be deleted only if the user count is 0.
Example:
Example
Last updated
Was this helpful?