> For the complete documentation index, see [llms.txt](https://docs.xibosignage.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.xibosignage.com/developer/integrate/openapi/usergroup.md).

# Usergroup

User Groups

## UserGroup Search

> Search User Groups

```json
{"openapi":"3.0.0","info":{"title":"Xibo API","version":"4.5"},"tags":[{"name":"usergroup","description":"User Groups"}],"servers":[{"url":"/api"}],"paths":{"/group":{"get":{"tags":["usergroup"],"summary":"UserGroup Search","description":"Search User Groups","operationId":"userGroupSearch","parameters":[{"name":"userGroupId","in":"query","description":"Filter by UserGroup Id","required":false,"schema":{"type":"integer"}},{"name":"userGroup","in":"query","description":"Filter by UserGroup Name","required":false,"schema":{"type":"string"}},{"name":"sortBy","in":"query","description":"Specifies which field the results are sorted by. Used together with sortDir","required":false,"schema":{"type":"string","enum":["groupId","group","description","libraryQuota","isSystemNotification","isDisplayNotification","isDataSetNotification","isLayoutNotification","isLibraryNotification","isReportNotification","isScheduleNotification","isCustomNotification","isShownForAddUser"]}},{"name":"sortDir","in":"query","description":"Sort direction","required":false,"schema":{"type":"string","enum":["asc","desc"]}}],"responses":{"200":{"description":"successful operation","headers":{"X-Total-Count":{"description":"The total number of records","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/UserGroup"}}}}}}}}},"components":{"schemas":{"UserGroup":{"description":"Class UserGroup","properties":{"groupId":{"description":"The Group ID","type":"integer"},"group":{"description":"The group name","type":"string"},"isUserSpecific":{"description":"A flag indicating whether this is a user specific group or not","type":"integer"},"isEveryone":{"description":"A flag indicating the special everyone group","type":"integer"},"description":{"description":"Description of this User Group","type":"string"},"libraryQuota":{"description":"This users library quota in bytes. 0 = unlimited","type":"integer"},"isSystemNotification":{"description":"Does this Group receive system notifications.","type":"integer"},"isDisplayNotification":{"description":"Does this Group receive display notifications.","type":"integer"},"isDataSetNotification":{"description":"Does this Group receive DataSet notifications.","type":"integer"},"isLayoutNotification":{"description":"Does this Group receive Layout notifications.","type":"integer"},"isLibraryNotification":{"description":"Does this Group receive Library notifications.","type":"integer"},"isReportNotification":{"description":"Does this Group receive Report notifications.","type":"integer"},"isScheduleNotification":{"description":"Does this Group receive Schedule notifications.","type":"integer"},"isCustomNotification":{"description":"Does this Group receive Custom notifications.","type":"integer"},"isShownForAddUser":{"description":"Is this Group shown in the list of choices when onboarding a new user","type":"integer"},"defaultHomepageId":{"description":"Default Home page for new users","type":"string"},"features":{"description":"Features this User Group has direct access to","type":"array","items":{"type":"string"}}},"type":"object"}}}}
```

## UserGroup Add

> Add User Group

```json
{"openapi":"3.0.0","info":{"title":"Xibo API","version":"4.5"},"tags":[{"name":"usergroup","description":"User Groups"}],"servers":[{"url":"/api"}],"paths":{"/group":{"post":{"tags":["usergroup"],"summary":"UserGroup Add","description":"Add User Group","operationId":"userGroupAdd","requestBody":{"required":true,"content":{"application/x-www-form-urlencoded":{"schema":{"required":["group"],"properties":{"group":{"description":"Name of the User Group","type":"string"},"decription":{"description":"A description of the User Group","type":"string"},"libraryQuota":{"description":"The quota that should be applied (KiB). Provide 0 for no quota","type":"string"},"isSystemNotification":{"description":"Flag (0, 1), should members of this Group receive system notifications?","type":"integer"},"isDisplayNotification":{"description":"Flag (0, 1), should members of this Group receive Display notifications\r\n     * for Displays they have permissions to see","type":"integer"},"isDataSetNotification":{"description":"Flag (0, 1), should members of this Group receive DataSet notification emails?","type":"integer"},"isLayoutNotification":{"description":"Flag (0, 1), should members of this Group receive Layout notification emails?","type":"integer"},"isLibraryNotification":{"description":"Flag (0, 1), should members of this Group receive Library notification emails?","type":"integer"},"isReportNotification":{"description":"Flag (0, 1), should members of this Group receive Report notification emails?","type":"integer"},"isScheduleNotification":{"description":"Flag (0, 1), should members of this Group receive Schedule notification emails?","type":"integer"},"isCustomNotification":{"description":"Flag (0, 1), should members of this Group receive Custom notification emails?","type":"integer"},"isShownForAddUser":{"description":"Flag (0, 1), should this Group be shown in the Add User onboarding form.","type":"integer"},"defaultHomePageId":{"description":"If this user has been created via the onboarding form, this should be the default home page","type":"integer"}},"type":"object"}}}},"responses":{"201":{"description":"successful operation","headers":{"Location":{"description":"Location of the new record","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserGroup"}}}}}}}},"components":{"schemas":{"UserGroup":{"description":"Class UserGroup","properties":{"groupId":{"description":"The Group ID","type":"integer"},"group":{"description":"The group name","type":"string"},"isUserSpecific":{"description":"A flag indicating whether this is a user specific group or not","type":"integer"},"isEveryone":{"description":"A flag indicating the special everyone group","type":"integer"},"description":{"description":"Description of this User Group","type":"string"},"libraryQuota":{"description":"This users library quota in bytes. 0 = unlimited","type":"integer"},"isSystemNotification":{"description":"Does this Group receive system notifications.","type":"integer"},"isDisplayNotification":{"description":"Does this Group receive display notifications.","type":"integer"},"isDataSetNotification":{"description":"Does this Group receive DataSet notifications.","type":"integer"},"isLayoutNotification":{"description":"Does this Group receive Layout notifications.","type":"integer"},"isLibraryNotification":{"description":"Does this Group receive Library notifications.","type":"integer"},"isReportNotification":{"description":"Does this Group receive Report notifications.","type":"integer"},"isScheduleNotification":{"description":"Does this Group receive Schedule notifications.","type":"integer"},"isCustomNotification":{"description":"Does this Group receive Custom notifications.","type":"integer"},"isShownForAddUser":{"description":"Is this Group shown in the list of choices when onboarding a new user","type":"integer"},"defaultHomepageId":{"description":"Default Home page for new users","type":"string"},"features":{"description":"Features this User Group has direct access to","type":"array","items":{"type":"string"}}},"type":"object"}}}}
```

## User Group search by ID

> Get the User group object specified by the provided groupId

```json
{"openapi":"3.0.0","info":{"title":"Xibo API","version":"4.5"},"tags":[{"name":"usergroup","description":"User Groups"}],"servers":[{"url":"/api"}],"paths":{"/group/{userGroupId}":{"get":{"tags":["usergroup"],"summary":"User Group search by ID","description":"Get the User group object specified by the provided groupId","operationId":"userGroupSearchById","parameters":[{"name":"userGroupId","in":"path","description":"Numeric ID of the User Group to get","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserGroup"}}}}}}}},"components":{"schemas":{"UserGroup":{"description":"Class UserGroup","properties":{"groupId":{"description":"The Group ID","type":"integer"},"group":{"description":"The group name","type":"string"},"isUserSpecific":{"description":"A flag indicating whether this is a user specific group or not","type":"integer"},"isEveryone":{"description":"A flag indicating the special everyone group","type":"integer"},"description":{"description":"Description of this User Group","type":"string"},"libraryQuota":{"description":"This users library quota in bytes. 0 = unlimited","type":"integer"},"isSystemNotification":{"description":"Does this Group receive system notifications.","type":"integer"},"isDisplayNotification":{"description":"Does this Group receive display notifications.","type":"integer"},"isDataSetNotification":{"description":"Does this Group receive DataSet notifications.","type":"integer"},"isLayoutNotification":{"description":"Does this Group receive Layout notifications.","type":"integer"},"isLibraryNotification":{"description":"Does this Group receive Library notifications.","type":"integer"},"isReportNotification":{"description":"Does this Group receive Report notifications.","type":"integer"},"isScheduleNotification":{"description":"Does this Group receive Schedule notifications.","type":"integer"},"isCustomNotification":{"description":"Does this Group receive Custom notifications.","type":"integer"},"isShownForAddUser":{"description":"Is this Group shown in the list of choices when onboarding a new user","type":"integer"},"defaultHomepageId":{"description":"Default Home page for new users","type":"string"},"features":{"description":"Features this User Group has direct access to","type":"array","items":{"type":"string"}}},"type":"object"}}}}
```

## UserGroup Edit

> Edit User Group

```json
{"openapi":"3.0.0","info":{"title":"Xibo API","version":"4.5"},"tags":[{"name":"usergroup","description":"User Groups"}],"servers":[{"url":"/api"}],"paths":{"/group/{userGroupId}":{"put":{"tags":["usergroup"],"summary":"UserGroup Edit","description":"Edit User Group","operationId":"userGroupEdit","parameters":[{"name":"userGroupId","in":"path","description":"ID of the User Group","required":true,"schema":{"type":"integer"}}],"requestBody":{"required":true,"content":{"application/x-www-form-urlencoded":{"schema":{"required":["group"],"properties":{"group":{"description":"Name of the User Group","type":"string"},"decription":{"description":"A description of the User Group","type":"string"},"libraryQuota":{"description":"The quota that should be applied (KiB). Provide 0 for no quota","type":"string"},"isSystemNotification":{"description":"Flag (0, 1), should members of this Group receive system notifications?","type":"integer"},"isDisplayNotification":{"description":"Flag (0, 1), should members of this Group receive Display notifications\r\n     * for Displays they have permissions to see","type":"integer"},"isDataSetNotification":{"description":"Flag (0, 1), should members of this Group receive DataSet notification emails?","type":"integer"},"isLayoutNotification":{"description":"Flag (0, 1), should members of this Group receive Layout notification emails?","type":"integer"},"isLibraryNotification":{"description":"Flag (0, 1), should members of this Group receive Library notification emails?","type":"integer"},"isReportNotification":{"description":"Flag (0, 1), should members of this Group receive Report notification emails?","type":"integer"},"isScheduleNotification":{"description":"Flag (0, 1), should members of this Group receive Schedule notification emails?","type":"integer"},"isCustomNotification":{"description":"Flag (0, 1), should members of this Group receive Custom notification emails?","type":"integer"},"isShownForAddUser":{"description":"Flag (0, 1), should this Group be shown in the Add User onboarding form.","type":"integer"},"defaultHomePageId":{"description":"If this user has been created via the onboarding form, this should be the default home page","type":"integer"}},"type":"object"}}}},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserGroup"}}}}}}}},"components":{"schemas":{"UserGroup":{"description":"Class UserGroup","properties":{"groupId":{"description":"The Group ID","type":"integer"},"group":{"description":"The group name","type":"string"},"isUserSpecific":{"description":"A flag indicating whether this is a user specific group or not","type":"integer"},"isEveryone":{"description":"A flag indicating the special everyone group","type":"integer"},"description":{"description":"Description of this User Group","type":"string"},"libraryQuota":{"description":"This users library quota in bytes. 0 = unlimited","type":"integer"},"isSystemNotification":{"description":"Does this Group receive system notifications.","type":"integer"},"isDisplayNotification":{"description":"Does this Group receive display notifications.","type":"integer"},"isDataSetNotification":{"description":"Does this Group receive DataSet notifications.","type":"integer"},"isLayoutNotification":{"description":"Does this Group receive Layout notifications.","type":"integer"},"isLibraryNotification":{"description":"Does this Group receive Library notifications.","type":"integer"},"isReportNotification":{"description":"Does this Group receive Report notifications.","type":"integer"},"isScheduleNotification":{"description":"Does this Group receive Schedule notifications.","type":"integer"},"isCustomNotification":{"description":"Does this Group receive Custom notifications.","type":"integer"},"isShownForAddUser":{"description":"Is this Group shown in the list of choices when onboarding a new user","type":"integer"},"defaultHomepageId":{"description":"Default Home page for new users","type":"string"},"features":{"description":"Features this User Group has direct access to","type":"array","items":{"type":"string"}}},"type":"object"}}}}
```

## Delete User Group

> Delete User Group

```json
{"openapi":"3.0.0","info":{"title":"Xibo API","version":"4.5"},"tags":[{"name":"usergroup","description":"User Groups"}],"servers":[{"url":"/api"}],"paths":{"/group/{userGroupId}":{"delete":{"tags":["usergroup"],"summary":"Delete User Group","description":"Delete User Group","operationId":"userGroupDelete","parameters":[{"name":"userGroupId","in":"path","description":"The user Group ID to Delete","required":true,"schema":{"type":"integer"}}],"responses":{"204":{"description":"successful operation"}}}}}}
```

## Assign User to User Group

> Assign User to User Group

```json
{"openapi":"3.0.0","info":{"title":"Xibo API","version":"4.5"},"tags":[{"name":"usergroup","description":"User Groups"}],"servers":[{"url":"/api"}],"paths":{"/group/members/assign/{userGroupId}":{"post":{"tags":["usergroup"],"summary":"Assign User to User Group","description":"Assign User to User Group","operationId":"userGroupAssign","parameters":[{"name":"userGroupId","in":"path","description":"ID of the user group to which assign the user","required":true,"schema":{"type":"integer"}}],"requestBody":{"required":true,"content":{"application/x-www-form-urlencoded":{"schema":{"required":["userId"],"properties":{"userId":{"description":"Array of userIDs to assign","type":"array","items":{"type":"integer"}},"unassignUserId":{"description":"An optional array of User IDs to unassign","type":"array","items":{"type":"integer"}}},"type":"object"}}}},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/UserGroup"}}}}}}}}},"components":{"schemas":{"UserGroup":{"description":"Class UserGroup","properties":{"groupId":{"description":"The Group ID","type":"integer"},"group":{"description":"The group name","type":"string"},"isUserSpecific":{"description":"A flag indicating whether this is a user specific group or not","type":"integer"},"isEveryone":{"description":"A flag indicating the special everyone group","type":"integer"},"description":{"description":"Description of this User Group","type":"string"},"libraryQuota":{"description":"This users library quota in bytes. 0 = unlimited","type":"integer"},"isSystemNotification":{"description":"Does this Group receive system notifications.","type":"integer"},"isDisplayNotification":{"description":"Does this Group receive display notifications.","type":"integer"},"isDataSetNotification":{"description":"Does this Group receive DataSet notifications.","type":"integer"},"isLayoutNotification":{"description":"Does this Group receive Layout notifications.","type":"integer"},"isLibraryNotification":{"description":"Does this Group receive Library notifications.","type":"integer"},"isReportNotification":{"description":"Does this Group receive Report notifications.","type":"integer"},"isScheduleNotification":{"description":"Does this Group receive Schedule notifications.","type":"integer"},"isCustomNotification":{"description":"Does this Group receive Custom notifications.","type":"integer"},"isShownForAddUser":{"description":"Is this Group shown in the list of choices when onboarding a new user","type":"integer"},"defaultHomepageId":{"description":"Default Home page for new users","type":"string"},"features":{"description":"Features this User Group has direct access to","type":"array","items":{"type":"string"}}},"type":"object"}}}}
```

## Unassign User from User Group

> Unassign User from User Group

```json
{"openapi":"3.0.0","info":{"title":"Xibo API","version":"4.5"},"tags":[{"name":"usergroup","description":"User Groups"}],"servers":[{"url":"/api"}],"paths":{"/group/members/unassign/{userGroupId}":{"post":{"tags":["usergroup"],"summary":"Unassign User from User Group","description":"Unassign User from User Group","operationId":"userGroupUnassign","parameters":[{"name":"userGroupId","in":"path","description":"ID of the user group from which to unassign the user","required":true,"schema":{"type":"integer"}}],"requestBody":{"required":true,"content":{"application/x-www-form-urlencoded":{"schema":{"required":["userId"],"properties":{"userId":{"description":"Array of userIDs to unassign","type":"array","items":{"type":"integer"}}},"type":"object"}}}},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/UserGroup"}}}}}}}}},"components":{"schemas":{"UserGroup":{"description":"Class UserGroup","properties":{"groupId":{"description":"The Group ID","type":"integer"},"group":{"description":"The group name","type":"string"},"isUserSpecific":{"description":"A flag indicating whether this is a user specific group or not","type":"integer"},"isEveryone":{"description":"A flag indicating the special everyone group","type":"integer"},"description":{"description":"Description of this User Group","type":"string"},"libraryQuota":{"description":"This users library quota in bytes. 0 = unlimited","type":"integer"},"isSystemNotification":{"description":"Does this Group receive system notifications.","type":"integer"},"isDisplayNotification":{"description":"Does this Group receive display notifications.","type":"integer"},"isDataSetNotification":{"description":"Does this Group receive DataSet notifications.","type":"integer"},"isLayoutNotification":{"description":"Does this Group receive Layout notifications.","type":"integer"},"isLibraryNotification":{"description":"Does this Group receive Library notifications.","type":"integer"},"isReportNotification":{"description":"Does this Group receive Report notifications.","type":"integer"},"isScheduleNotification":{"description":"Does this Group receive Schedule notifications.","type":"integer"},"isCustomNotification":{"description":"Does this Group receive Custom notifications.","type":"integer"},"isShownForAddUser":{"description":"Is this Group shown in the list of choices when onboarding a new user","type":"integer"},"defaultHomepageId":{"description":"Default Home page for new users","type":"string"},"features":{"description":"Features this User Group has direct access to","type":"array","items":{"type":"string"}}},"type":"object"}}}}
```

## Copy User Group

> Copy an user group, optionally copying the group members

```json
{"openapi":"3.0.0","info":{"title":"Xibo API","version":"4.5"},"tags":[{"name":"usergroup","description":"User Groups"}],"servers":[{"url":"/api"}],"paths":{"/group/{userGroupId}/copy":{"post":{"tags":["usergroup"],"summary":"Copy User Group","description":"Copy an user group, optionally copying the group members","operationId":"userGroupCopy","parameters":[{"name":"userGroupId","in":"path","description":"The User Group ID to Copy","required":true,"schema":{"type":"integer"}}],"requestBody":{"required":true,"content":{"application/x-www-form-urlencoded":{"schema":{"required":["group"],"properties":{"group":{"description":"The Group Name","type":"string"},"copyMembers":{"description":"Flag indicating whether to copy group members","type":"integer"},"copyFeatures":{"description":"Flag indicating whether to copy group features","type":"integer"}},"type":"object"}}}},"responses":{"201":{"description":"successful operation","headers":{"Location":{"description":"Location of the new record","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserGroup"}}}}}}}},"components":{"schemas":{"UserGroup":{"description":"Class UserGroup","properties":{"groupId":{"description":"The Group ID","type":"integer"},"group":{"description":"The group name","type":"string"},"isUserSpecific":{"description":"A flag indicating whether this is a user specific group or not","type":"integer"},"isEveryone":{"description":"A flag indicating the special everyone group","type":"integer"},"description":{"description":"Description of this User Group","type":"string"},"libraryQuota":{"description":"This users library quota in bytes. 0 = unlimited","type":"integer"},"isSystemNotification":{"description":"Does this Group receive system notifications.","type":"integer"},"isDisplayNotification":{"description":"Does this Group receive display notifications.","type":"integer"},"isDataSetNotification":{"description":"Does this Group receive DataSet notifications.","type":"integer"},"isLayoutNotification":{"description":"Does this Group receive Layout notifications.","type":"integer"},"isLibraryNotification":{"description":"Does this Group receive Library notifications.","type":"integer"},"isReportNotification":{"description":"Does this Group receive Report notifications.","type":"integer"},"isScheduleNotification":{"description":"Does this Group receive Schedule notifications.","type":"integer"},"isCustomNotification":{"description":"Does this Group receive Custom notifications.","type":"integer"},"isShownForAddUser":{"description":"Is this Group shown in the list of choices when onboarding a new user","type":"integer"},"defaultHomepageId":{"description":"Default Home page for new users","type":"string"},"features":{"description":"Features this User Group has direct access to","type":"array","items":{"type":"string"}}},"type":"object"}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.xibosignage.com/developer/integrate/openapi/usergroup.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.