Group
Manage groups, which represent logical collections of users or entities.
You can create, update, delete, and search for groups with advanced filtering and pagination.
- Version
- 2.0.0
- OpenAPI version
- 3.0.0
Operations
Section titled “Operations” POST /v2/group/index
Returns a paginated and filterable list of groups.
Use POST to allow complex filters via JSON payload.
Request Body
Section titled “Request Body ”Parameters for searching groups
object
object
The field of the model to sort the list for, use a minus to revert the sort. Es -name is to require the sort in reverse order
The field establishes whether to also include historized elements that are no longer active in the results. If you leave this parameter empty the response returns only actual entries.
Example
{ "filter": { "name": "Safety Group" }, "per-page": 10, "page": 1, "sort": "name"}Responses
Section titled “ Responses ”List of groups
object
Example
{ "group_id": "grp-1", "name": "Safety Group", "description": "Group for safety team", "status": "active", "created_at": 1700000000, "updated_at": 1700000001}Headers
Section titled “Headers ”Current page
Total number of pages
Number of items per page
Total number of items
create
Section titled “create” POST /v2/group/create
Create a new group by providing the required details.
Request Body required
Section titled “Request Body required ”Group object to be created
object
Example
{ "name": "New Group", "description": "A new group for project members", "status": "active"}Responses
Section titled “ Responses ”Group created successfully
object
Example
{ "group_id": "grp-2", "name": "New Group", "description": "A new group for project members", "status": "active"} GET /v2/group/view/{id}
Retrieve a group by its unique ID.
Path Parameters
Section titled “Path Parameters ”ID of the group to retrieve
Responses
Section titled “ Responses ”Group found
object
Example
{ "group_id": "grp-1", "name": "Safety Group", "description": "Group for safety team", "status": "active", "created_at": 1700000000, "updated_at": 1700000001}Group not found
delete
Section titled “delete” DELETE /v2/group/delete/{id}
Delete a group by its unique ID.
If force=true, all related entities will also be deleted.
Path Parameters
Section titled “Path Parameters ”ID of the group to delete
Query Parameters
Section titled “Query Parameters ”Force the deletion of the entity and all related entities
Responses
Section titled “ Responses ”Group deleted successfully
If force=false, the operation is interrupted and the list of connected entities that will be deleted in case of confirmation (force=true) is returned
update
Section titled “update” PUT /v2/group/update/{id}
Update an existing group by its unique ID.
Path Parameters
Section titled “Path Parameters ”ID of the group to update
Request Body required
Section titled “Request Body required ”Group object with updated data
object
Example
{ "name": "Updated Group", "description": "Updated description"}Responses
Section titled “ Responses ”Group updated successfully
object
Example
{ "group_id": "grp-1", "name": "Updated Group", "description": "Updated description"}Group not found