User Groups

Group Object

The group object represents a user group in the Marketplace platform. This object contains the following properties:

Field	Type	Description
id	string	Primary group identifier. Example: "UGR-1234-1234"
href	string	Relative reference to object on API. Example: "/v1/accounts/groups/UGR-1234-1234"
icon	string	Relative path to 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	Module	List of modules available for the group. Example: "Invoices"
default	bool	Indicated 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 UsersCount is 0. Example: { "users": 123 }

Example

GROUP OBJECT

{
	"id": "UGR-5116-6265",
	"href": "/user-groups/UGR-5116-6265",
	"name": "Test-1",
	"description": "Sed ut perspiciatis unde omnis iste natus error sit voluptatem accusantium doloremque laudantium.",
	"modules": [
		{
			"id": "MOD-1756-1452",
			"name": "Access management"
		},
		{
			"id": "MOD-9042-8216",
			"name": "Account management"
		}
	],
	"icon": "https://picsum.photos/210/201",
	"default": true,
	"stats": {
		"users": 123
	}
}