WorkGroup

Manage work groups, which represent teams or units within an office or project.
You can create, update, delete, and search for work groups with advanced filtering and pagination.

Version

2.0.0

OpenAPI version

3.0.0

Operations

index

POST

/v2/work-group/index

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

Request Body

Parameters for searching work groups

object

filter

object

work_group_id

string format: uuid

code

string

name

string

office_id

string format: uuid

work_group_type

string

project_id

string

project_name

string

project_type

string

office_name

string

per-page

integer

default: 100 >= 1

page

integer

default: 1 >= 1

sort

string

Allowed values: code name work_group_type

history

boolean

Example

{
  "filter": {
    "name": "My group",
    "code": "GRP-001"
  },
  "per-page": 50,
  "page": 2,
  "sort": "-name"
}

Responses

200

List of work groups

Array<object>

object

work_group_id

string format: uuid

code

string

name

string

description

string

office_id

string format: uuid

work_group_type

string

project_id

string

project_name

string

project_type

string

office_name

string

owned_active

boolean

parent_active

boolean

Example

{
  "work_group_id": "wg-1",
  "code": "GRP-001",
  "name": "My group",
  "description": "Main work group",
  "office_id": "off-1",
  "work_group_type": "team",
  "project_id": "proj-1",
  "project_name": "Project X",
  "office_name": "Main Office"
}

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

view

GET

/v2/work-group/view/{id}

Retrieve a work group by its unique ID.

Path Parameters

id

required

string format: uuid

ID of the work group to retrieve

Responses

200

Work group found

object

work_group_id

required

string

code

string

name

required

string

description

string

office_id

required

string

work_group_type

required

string

Example

{
  "work_group_id": "wg-1",
  "code": "GRP-001",
  "name": "My group",
  "description": "Main work group",
  "office_id": "off-1",
  "work_group_type": "team",
  "project_id": "proj-1",
  "project_name": "Project X",
  "office_name": "Main Office"
}

404

Work group not found

create

POST

/v2/work-group/create

Create a new work group by providing the required details.

Request Body ^required

Work group object to be created

object

work_group_id

required

string

code

string

name

required

string

description

string

office_id

required

string

work_group_type

required

string

Example

{
  "code": "GRP-002",
  "name": "Support group",
  "description": "Support team",
  "office_id": "off-2",
  "work_group_type": "support"
}

Responses

201

Work group created successfully

object

work_group_id

required

string

code

string

name

required

string

description

string

office_id

required

string

work_group_type

required

string

Example

{
  "work_group_id": "wg-2",
  "code": "GRP-002",
  "name": "Support group",
  "description": "Support team",
  "office_id": "off-2",
  "work_group_type": "support"
}

update

PUT

/v2/work-group/update/{id}

Update an existing work group by its unique ID.

Path Parameters

id

required

string format: uuid

ID of the work group to update

Request Body ^required

Work group object with updated data

object

work_group_id

required

string

code

string

name

required

string

description

string

office_id

required

string

work_group_type

required

string

Example

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

Responses

200

Work group updated successfully

object

work_group_id

required

string

code

string

name

required

string

description

string

office_id

required

string

work_group_type

required

string

Example

{
  "work_group_id": "wg-1",
  "name": "Updated group",
  "description": "Updated description"
}

404

Work group not found

delete

DELETE

/v2/work-group/delete/{id}

Delete a work 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 work group to delete

Query Parameters

force

boolean

Force the deletion of the entity and all related entities

Responses

204

Work 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