Usergroup
Organizational unit for hierarchical user and company management.
Usergroups provide a hierarchical structure for organizing users, companies, and customers. They enable inheritance of settings, permissions, and configurations throughout the organizational tree.
type Usergroup {
id: Int! @deprecated
usergroupId: Int!
name: String!
hidden: YesNo
inheritProductList: YesNo
path: String
slug: String
tag: String
createdAt: DateTime
lastModifiedAt: DateTime
parentUsergroupId: Int!
usergroup: Usergroup! @deprecated
usergroups: [Usergroup!]! @deprecated
companies(
input: CompanySearchArguments = [object Object]
): CompaniesResponse
customers: [Customer!]!
}
Fields
Usergroup.id ● Int! deprecated non-null scalar
This property is no longer relevant or necessary, use usergroupId instead.
Legacy unique identifier for the usergroup.
Deprecated identifier maintained for backward compatibility. Use usergroupId for new implementations.
Usergroup.usergroupId ● Int! non-null scalar
Unique identifier for the usergroup.
Primary key used to reference the usergroup throughout the system and establish hierarchical relationships.
Usergroup.name ● String! non-null scalar
Display name of the usergroup.
Human-readable name used for identification and display in user interfaces. Must be unique within the parent usergroup.
Usergroup.hidden ● YesNo enum
Visibility flag for administrative operations.
When set to 'Y', the usergroup is hidden from standard user interfaces and is only used for background operations or system processes.
Usergroup.inheritProductList ● YesNo enum
Product list inheritance configuration.
When set to 'Y', the usergroup inherits product lists from its parent usergroup. When set to 'N', it maintains its own product list configuration.
Usergroup.path ● String scalar
Hierarchical path to the organizational root.
Comma-separated list of IDs representing the path from this usergroup to the root of the organizational hierarchy. Used for inheritance calculations and permission resolution.
Usergroup.slug ● String scalar
URL-friendly identifier for the usergroup.
Unique slug used in URLs and API endpoints for human-readable usergroup identification. Must be URL-safe and unique within the parent usergroup.
Usergroup.tag ● String scalar
Classification tag for the usergroup.
Custom tag or category used for grouping, filtering, or classification purposes within the organizational structure.
Usergroup.createdAt ● DateTime scalar
Timestamp when the usergroup was created.
Automatically set when the usergroup is first created in the system. Used for auditing and tracking organizational changes.
Usergroup.lastModifiedAt ● DateTime scalar
Timestamp when the usergroup was last modified.
Automatically updated whenever any usergroup information is changed. Used for auditing and synchronization purposes.
Usergroup.parentUsergroupId ● Int! non-null scalar
Identifier of the parent usergroup.
References the parent usergroup in the organizational hierarchy. Used for inheritance and permission calculations. Null for root-level usergroups.
Usergroup.usergroup ● Usergroup! deprecated non-null object
This field is deprecated and will be removed in a future
Usergroup.usergroups ● [Usergroup!]! deprecated non-null object
This field is deprecated and will be removed in a future
Usergroup.companies ● CompaniesResponse object
Companies contained within this usergroup.
Paginated list of all companies that belong to this usergroup, including their relationships and organizational context.
Usergroup.companies.input ● CompanySearchArguments input
Usergroup.customers ● [Customer!]! non-null object
Returned By
usergroup query ● usergroupCreate mutation ● usergroupUpdate mutation
Member Of
Company object ● Customer object ● User object ● Usergroup object ● UsergroupsResponse object