OrgRole

Manage organization roles, which represent roles within the company organization chart.
You can create, update, delete, and search for org roles with advanced filtering and pagination.

Version

2.0.0

OpenAPI version

3.0.0

Operations

index

POST

/v2/org-role/index

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

Request Body

Parameters for searching org roles

object

filter

object

org_role_id

string format: uuid

code

string

name

string

project_id

string

per-page

integer

default: 100 >= 1

page

integer

default: 1 >= 1

sort

string

Allowed values: code name

history

boolean

Example

{
  "filter": {
    "name": "HR Manager",
    "code": "ORG-ROLE-001"
  },
  "per-page": 20,
  "page": 1,
  "sort": "name"
}

Responses

200

List of org roles

Array<object>

object

org_role_id

required

string

code

string

name

required

string

description

string

project_id

required

string

{
  "org_role_id": "223e4567-e89b-12d3-a456-426655440000",
  "code": "ORG-ROLE-001",
  "name": "HR Manager",
  "description": "HR department manager",
  "project_id": "452b7448dce72057574d59f93d456ed0"
}

Example

{
  "org_role_id": "223e4567-e89b-12d3-a456-426655440000",
  "code": "ORG-ROLE-001",
  "name": "HR Manager",
  "description": "HR department manager",
  "project_id": "452b7448dce72057574d59f93d456ed0"
}

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/org-role/view/{id}

Retrieve an org role by its unique ID.

Path Parameters

id

required

string format: uuid

ID of the org role to retrieve

Responses

200

Org role found

object

org_role_id

required

string

code

string

name

required

string

description

string

project_id

required

string

Example

{
  "org_role_id": "223e4567-e89b-12d3-a456-426655440000",
  "code": "ORG-ROLE-001",
  "name": "HR Manager",
  "description": "HR department manager",
  "project_id": "452b7448dce72057574d59f93d456ed0"
}

404

Org role not found

create

POST

/v2/org-role/create

Create a new org role by providing the required details.

Request Body ^required

Org role object to be created

object

org_role_id

required

string

code

string

name

required

string

description

string

project_id

required

string

Example

{
  "code": "ORG-ROLE-002",
  "name": "IT Manager",
  "description": "IT department manager",
  "project_id": "452b7448dce72057574d59f93d456ed0"
}

Responses

201

Org role created successfully

object

org_role_id

required

string

code

string

name

required

string

description

string

project_id

required

string

Example

{
  "org_role_id": "323e4567-e89b-12d3-a456-426655440000",
  "code": "ORG-ROLE-002",
  "name": "IT Manager",
  "description": "IT department manager",
  "project_id": "452b7448dce72057574d59f93d456ed0"
}

update

PUT

/v2/org-role/update/{id}

Update an existing org role by its unique ID.

Path Parameters

id

required

string format: uuid

ID of the org role to update

Request Body ^required

Org role object with updated data

object

org_role_id

required

string

code

string

name

required

string

description

string

project_id

required

string

Example

{
  "name": "Updated HR Manager",
  "description": "Updated description"
}

Responses

200

Org role updated successfully

object

org_role_id

required

string

code

string

name

required

string

description

string

project_id

required

string

Example

{
  "org_role_id": "223e4567-e89b-12d3-a456-426655440000",
  "name": "Updated HR Manager",
  "description": "Updated description"
}

404

Org role not found

delete

DELETE

/v2/org-role/delete/{id}

Delete an org role by its unique ID.
If force=true, all related entities will also be deleted.

Path Parameters

id

required

string format: uuid

ID of the org role to delete

Query Parameters

force

boolean

Force the deletion of the entity and all related entities

Responses

204

Org role 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