Role Profile

Gets a list of role profiles

get

This endpoint is used to fetch all the role profiles in the current organization (works based on token used to authorize)

Authorizations

ApiKeyAuth

AuthorizationstringRequired

Responses

200Success

application/json

Serializes groups querysets.

role_namestring · max: 250 · nullableOptional

descriptionstring · max: 3000 · nullableOptional

group_idintegerOptional

organizationstring · max: 25Required

is_pre_configurebooleanOptional

role_typeintegerOptionalDefault: 1

event_mapstringRead-onlyRequired

last_update_timestring · date-timeOptional

get

/ux/common/roles/profile/

HTTPcURLJavaScriptPython

GET /ux/common/roles/profile/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

200Success

[
  {
    "role_name": "text",
    "description": "text",
    "group_id": 1,
    "organization": "text",
    "is_pre_configure": true,
    "role_type": 1,
    "event_map": "text",
    "last_update_time": "2026-03-09T21:44:08.260Z"
  }
]

Creates a new role

post

This endpoint is used to save a new role for the current organization

Authorizations

ApiKeyAuth

AuthorizationstringRequired

Body

application/json

Other propertiesanyOptional

Responses

201

No response body

post

/ux/common/roles/profile/

HTTPcURLJavaScriptPython

POST /ux/common/roles/profile/ HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 190

{
  "role_name": "Requester",
  "description": "User can have access only to requester portal",
  "selected_permissions": {
    "General": {
      "organization": {
        "view": true,
        "add": true,
        "edit": true,
        "delete": true
      }
    }
  }
}

201

No response body

No content

Gets a role profile with the given id

get

This endpoint is used to fetch a role in the current organization

Authorizations

ApiKeyAuth

AuthorizationstringRequired

Path parameters

idstringRequired

Responses

200Success

application/json

Serializes groups querysets.

role_namestring · max: 250 · nullableOptional

descriptionstring · max: 3000 · nullableOptional

group_idintegerOptional

organizationstring · max: 25Required

is_pre_configurebooleanOptional

role_typeintegerOptionalDefault: 1

event_mapstringRead-onlyRequired

last_update_timestring · date-timeOptional

get

/ux/common/roles/profile/{id}/

HTTPcURLJavaScriptPython

GET /ux/common/roles/profile/{id}/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "role_name": "text",
  "description": "text",
  "group_id": 1,
  "organization": "text",
  "is_pre_configure": true,
  "role_type": 1,
  "event_map": "text",
  "last_update_time": "2026-03-09T21:44:08.260Z"
}

Edits the role with given id

put

This endpoint is used to edit an existing role for the current organization

Authorizations

ApiKeyAuth

AuthorizationstringRequired

Path parameters

idstringRequired

Body

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

Serializes groups querysets.

role_namestring · max: 250 · nullableOptional

descriptionstring · max: 3000 · nullableOptional

group_idintegerOptional

organizationstring · max: 25Required

is_pre_configurebooleanOptional

role_typeintegerOptionalDefault: 1

event_mapstringRead-onlyRequired

last_update_timestring · date-timeOptional

Responses

200Success

application/json

Serializes groups querysets.

role_namestring · max: 250 · nullableOptional

descriptionstring · max: 3000 · nullableOptional

group_idintegerOptional

organizationstring · max: 25Required

is_pre_configurebooleanOptional

role_typeintegerOptionalDefault: 1

event_mapstringRead-onlyRequired

last_update_timestring · date-timeOptional

put

/ux/common/roles/profile/{id}/

HTTPcURLJavaScriptPython

PUT /ux/common/roles/profile/{id}/ HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 160

{
  "role_name": "text",
  "description": "text",
  "group_id": 1,
  "organization": "text",
  "is_pre_configure": true,
  "role_type": 1,
  "last_update_time": "2026-03-09T21:44:08.260Z"
}

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

200Success

{
  "role_name": "text",
  "description": "text",
  "group_id": 1,
  "organization": "text",
  "is_pre_configure": true,
  "role_type": 1,
  "event_map": "text",
  "last_update_time": "2026-03-09T21:44:08.260Z"
}

Deletes the role with given id

delete

This endpoint is used to delete an existing role for the current organization

Authorizations

ApiKeyAuth

AuthorizationstringRequired

Path parameters

idstringRequired

Responses

204

No response body

delete

/ux/common/roles/profile/{id}/

HTTPcURLJavaScriptPython

DELETE /ux/common/roles/profile/{id}/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

204

No response body

No content

Gets the module role map

get

This endpoint is used to get all module role map for the current organization

Authorizations

ApiKeyAuth

AuthorizationstringRequired

Responses

200Success

application/json

Serializes groups querysets.

role_namestring · max: 250 · nullableOptional

descriptionstring · max: 3000 · nullableOptional

group_idintegerOptional

organizationstring · max: 25Required

is_pre_configurebooleanOptional

role_typeintegerOptionalDefault: 1

event_mapstringRead-onlyRequired

last_update_timestring · date-timeOptional

get

/ux/common/roles/profile/config/

HTTPcURLJavaScriptPython

GET /ux/common/roles/profile/config/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "role_name": "text",
  "description": "text",
  "group_id": 1,
  "organization": "text",
  "is_pre_configure": true,
  "role_type": 1,
  "event_map": "text",
  "last_update_time": "2026-03-09T21:44:08.260Z"
}

get

API endpoint that allows users to be viewed or edited.

Authorizations

ApiKeyAuth

AuthorizationstringRequired

Responses

200Success

application/json

Serializes groups querysets.

role_namestring · max: 250 · nullableOptional

descriptionstring · max: 3000 · nullableOptional

group_idintegerOptional

organizationstring · max: 25Required

is_pre_configurebooleanOptional

role_typeintegerOptionalDefault: 1

event_mapstringRead-onlyRequired

last_update_timestring · date-timeOptional

get

/ux/common/roles/profile/json/

HTTPcURLJavaScriptPython

GET /ux/common/roles/profile/json/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "role_name": "text",
  "description": "text",
  "group_id": 1,
  "organization": "text",
  "is_pre_configure": true,
  "role_type": 1,
  "event_map": "text",
  "last_update_time": "2026-03-09T21:44:08.260Z"
}

Get the options for the events options

get

This endpoint is used to get the default options for events options

Authorizations

ApiKeyAuth

AuthorizationstringRequired

Responses

200Success

application/json

Serializes groups querysets.

role_namestring · max: 250 · nullableOptional

descriptionstring · max: 3000 · nullableOptional

group_idintegerOptional

organizationstring · max: 25Required

is_pre_configurebooleanOptional

role_typeintegerOptionalDefault: 1

event_mapstringRead-onlyRequired

last_update_timestring · date-timeOptional

get

/ux/common/roles/profile/options/

HTTPcURLJavaScriptPython

GET /ux/common/roles/profile/options/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "role_name": "text",
  "description": "text",
  "group_id": 1,
  "organization": "text",
  "is_pre_configure": true,
  "role_type": 1,
  "event_map": "text",
  "last_update_time": "2026-03-09T21:44:08.260Z"
}