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

index

POST

/v2/group/index

Returns a paginated and filterable list of groups.
Use POST to allow complex filters via JSON payload.

Request Body

Parameters for searching groups

object

filter

object

group_id

string

name

string

description

string

status

string

created_at

integer

updated_at

integer

per-page

integer

default: 100 >= 1

page

integer

default: 1 >= 1

sort

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

string

history

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.

boolean

Example

{
  "filter": {
    "name": "Safety Group"
  },
  "per-page": 10,
  "page": 1,
  "sort": "name"
}

Responses

200

List of groups

Array<object>

object

group_id

string

name

string

description

string

status

string

created_at

integer

updated_at

integer

Example

{
  "group_id": "grp-1",
  "name": "Safety Group",
  "description": "Group for safety team",
  "status": "active",
  "created_at": 1700000000,
  "updated_at": 1700000001
}

Headers

X-Pagination-Current-Page

integer

Current page

X-Pagination-Page-Count

integer

Total number of pages

X-Pagination-Per-Page

integer

Number of items per page

X-Pagination-Total-Count

integer

Total number of items

create

POST

/v2/group/create

Create a new group by providing the required details.

Request Body ^required

Group object to be created

object

group_id

string

name

string

description

string

status

string

created_at

integer

updated_at

integer

Example

{
  "name": "New Group",
  "description": "A new group for project members",
  "status": "active"
}

Responses

201

Group created successfully

object

group_id

string

name

string

description

string

status

string

created_at

integer

updated_at

integer

Example

{
  "group_id": "grp-2",
  "name": "New Group",
  "description": "A new group for project members",
  "status": "active"
}

view

GET

/v2/group/view/{id}

Retrieve a group by its unique ID.

Path Parameters

id

required

string format: uuid

ID of the group to retrieve

Responses

200

Group found

object

group_id

string

name

string

description

string

status

string

created_at

integer

updated_at

integer

Example

{
  "group_id": "grp-1",
  "name": "Safety Group",
  "description": "Group for safety team",
  "status": "active",
  "created_at": 1700000000,
  "updated_at": 1700000001
}

404

Group not found

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

id

required

string format: uuid

ID of the group to delete

Query Parameters

force

boolean

Force the deletion of the entity and all related entities

Responses

204

Group deleted successfully

400

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

PUT

/v2/group/update/{id}

Update an existing group by its unique ID.

Path Parameters

id

required

string format: uuid

ID of the group to update

Request Body ^required

Group object with updated data

object

group_id

string

name

string

description

string

status

string

created_at

integer

updated_at

integer

Example

{
  "name": "Updated Group",
  "description": "Updated description"
}

Responses

200

Group updated successfully

object

group_id

string

name

string

description

string

status

string

created_at

integer

updated_at

integer

Example

{
  "group_id": "grp-1",
  "name": "Updated Group",
  "description": "Updated description"
}

404

Group not found