Group API
The Group API manages user groups in Deepser. Groups organize users into teams for assignment, visibility control, and notification purposes. This section describes the endpoints, role-based permissions, fields, and user membership operations.
Only Administrators with access to the Group Module can create, update, and delete groups. Operators and Key Users can only retrieve group records. End Users cannot access this resource via the API.
Endpoints
http://deepserhost/api/rest/group/[id]
http://deepserhost/api/rest/groups
http://deepserhost/api/rest/group/[id]/relation/users
Roles
| Administrator | Operator | Key User | User | |
|---|---|---|---|---|
| Actions Allowed | RETRIEVE CREATE UPDATE* DELETE | RETRIEVE | RETRIEVE |
* UPDATE is not allowed for the user relation endpoint:
http://deepdeskhost/api/rest/group/[id]/relation/users
Fields
The following table lists all fields of the Group entity:
| Field | Description |
|---|---|
| entity_id | The unique ID of the record. |
| name | The group name displayed throughout the system. |
| description | Description of the group. |
| Email address of the group. | |
| level | Support level of the group. |
| status | Group status. Typically 1 for enabled, 0 for disabled. |
| company_visibility | General visibility setting applied to all group members. Functions like the user-level company_visibility field. |
| user_ids | An array containing the IDs of all users in the group. |
| formtemplate_id | The form template ID used by the record. |
| updated_at | Date of the last update. |
| created_at | Creation date of the record. |
Manage Group Members
Retrieve Group Users
To get only the user IDs in a group (without the full group details), send a GET request:
http://deepserhost/api/rest/group/[id]/relation/users
The response is an array of user IDs.
Add Users to a Group
To add users, send a POST request to the same endpoint with a JSON payload containing the user IDs:
http://deepserhost/api/rest/group/[id]/relation/users
Request body:
[
[
21,
22
]
]
Remove Users from a Group
To remove users, send a DELETE request to the same endpoint with a JSON payload containing the user IDs to remove:
http://deepserhost/api/rest/group/[id]/relation/users
Request body:
[
[
21,
22
]
]