Teams

Gets a list of team profiles

get

This endpoint is used to fetch all the team profiles in the current organization

Authorizations

Query parameters

items_per_pageintegerRequired

Items Per Page

pageintegerRequired

Page Number

reversebooleanOptional

Sorting Order

sortstringOptional

Sorting Key

Responses

200Success

application/json

get

HTTPcURLJavaScriptPython

GET /ux/common/teams/profile/?items_per_page=1&page=1 HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

[
  {
    "id": "text",
    "module_ui_name": "text",
    "team_id": "text",
    "module_id": 1,
    "module_name": "text",
    "group_type": "text",
    "group_id": 1,
    "name": "text",
    "description": "text",
    "owner": [
      {
        "keys": "text",
        "values": "text",
        "queryparam": true
      }
    ],
    "staff_selection_type": "text",
    "is_approval_sequence": true,
    "tags": [
      {
        "keys": "text",
        "values": "text",
        "queryparam": true
      }
    ],
    "staffs": [
      {
        "keys": "text",
        "values": "text",
        "queryparam": true
      }
    ],
    "sequence_staffs": [
      {
        "keys": "text",
        "values": "text",
        "queryparam": true
      }
    ],
    "level_staff": [
      {
        "keys": "text",
        "values": "text",
        "queryparam": true
      }
    ],
    "is_preconfigure": true,
    "is_deleted": true,
    "organization": "text",
    "creation_time": "2025-06-07T15:04:05.795Z",
    "last_update_time": "2025-06-07T15:04:05.795Z",
    "response_required": true,
    "approval_percentage": 1,
    "department": "text",
    "business_hr_profile": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "asset_tags": [],
    "is_add_notify_required": true,
    "is_demo_data": true,
    "events_thres_id": [],
    "location": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "group_email": "text",
    "delegate_members": [
      {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    ],
    "team_delegate": true,
    "sequence_delegate": true,
    "config": {
      "keys": "text",
      "values": "text",
      "queryparam": true
    }
  }
]

Creates a new team

post

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

Authorizations

Body

Other propertiesanyOptional

Responses

201

No response body

post

HTTPcURLJavaScriptPython

POST /ux/common/teams/profile/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 368

{
  "name": "Team Approval 2",
  "description": "Test Approval 2",
  "type": "Approval",
  "staff_selection_type": "individual",
  "approval_sequence": false,
  "staff": [
    {
      "profile_id": "105068180334458180584",
      "email": "[e-mail]",
      "full_name": "Vinutha K"
    }
  ],
  "expertiseGroupList": [],
  "owners": [
    {
      "profile_id": "105068167971394819048",
      "email": "[e-mail]",
      "full_name": "Shilpa V"
    }
  ]
}

201

No response body

No content

Gets a team with the given id

get

This endpoint is used to fetch a team details in the current organization

Authorizations

Path parameters

idstringRequired

Responses

200Success

application/json

get

HTTPcURLJavaScriptPython

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

200Success

{
  "id": "text",
  "module_ui_name": "text",
  "team_id": "text",
  "module_id": 1,
  "module_name": "text",
  "group_type": "text",
  "group_id": 1,
  "name": "text",
  "description": "text",
  "owner": [
    {
      "keys": "text",
      "values": "text",
      "queryparam": true
    }
  ],
  "staff_selection_type": "text",
  "is_approval_sequence": true,
  "tags": [
    {
      "keys": "text",
      "values": "text",
      "queryparam": true
    }
  ],
  "staffs": [
    {
      "keys": "text",
      "values": "text",
      "queryparam": true
    }
  ],
  "sequence_staffs": [
    {
      "keys": "text",
      "values": "text",
      "queryparam": true
    }
  ],
  "level_staff": [
    {
      "keys": "text",
      "values": "text",
      "queryparam": true
    }
  ],
  "is_preconfigure": true,
  "is_deleted": true,
  "organization": "text",
  "creation_time": "2025-06-07T15:04:05.795Z",
  "last_update_time": "2025-06-07T15:04:05.795Z",
  "response_required": true,
  "approval_percentage": 1,
  "department": "text",
  "business_hr_profile": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "asset_tags": [],
  "is_add_notify_required": true,
  "is_demo_data": true,
  "events_thres_id": [],
  "location": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "group_email": "text",
  "delegate_members": [
    {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  ],
  "team_delegate": true,
  "sequence_delegate": true,
  "config": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  }
}

Edits the team with given id

put

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

Authorizations

Path parameters

idstringRequired

Body

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

Team Serializers

idstringRequired

module_ui_namestringRead-onlyRequired

team_idstring · max: 225Required

module_idintegerOptional

module_namestringOptional

group_typestringOptional

group_idintegerOptional

namestring · max: 225Optional

descriptionstringOptional

staff_selection_typestringOptional

is_approval_sequencebooleanOptional

is_preconfigurebooleanOptional

is_deletedbooleanOptional

organizationstring · max: 225Required

creation_timestring · date-timeOptional

last_update_timestring · date-timeOptional

response_requiredbooleanOptional

approval_percentageintegerOptional

departmentstringOptional

is_add_notify_requiredbooleanOptional

is_demo_databooleanOptional

group_emailstringOptional

team_delegatebooleanOptional

sequence_delegatebooleanOptional

Responses

200Success

application/json

put

HTTPcURLJavaScriptPython

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

{
  "id": "text",
  "team_id": "text",
  "module_id": 1,
  "module_name": "text",
  "group_type": "text",
  "group_id": 1,
  "name": "text",
  "description": "text",
  "owner": [
    {
      "keys": "text",
      "values": "text",
      "queryparam": true
    }
  ],
  "staff_selection_type": "text",
  "is_approval_sequence": true,
  "tags": [
    {
      "keys": "text",
      "values": "text",
      "queryparam": true
    }
  ],
  "staffs": [
    {
      "keys": "text",
      "values": "text",
      "queryparam": true
    }
  ],
  "sequence_staffs": [
    {
      "keys": "text",
      "values": "text",
      "queryparam": true
    }
  ],
  "level_staff": [
    {
      "keys": "text",
      "values": "text",
      "queryparam": true
    }
  ],
  "is_preconfigure": true,
  "is_deleted": true,
  "organization": "text",
  "creation_time": "2025-06-07T15:04:05.795Z",
  "last_update_time": "2025-06-07T15:04:05.795Z",
  "response_required": true,
  "approval_percentage": 1,
  "department": "text",
  "business_hr_profile": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "asset_tags": [],
  "is_add_notify_required": true,
  "is_demo_data": true,
  "events_thres_id": [],
  "location": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "group_email": "text",
  "delegate_members": [
    {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  ],
  "team_delegate": true,
  "sequence_delegate": true,
  "config": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  }
}

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

200Success

{
  "id": "text",
  "module_ui_name": "text",
  "team_id": "text",
  "module_id": 1,
  "module_name": "text",
  "group_type": "text",
  "group_id": 1,
  "name": "text",
  "description": "text",
  "owner": [
    {
      "keys": "text",
      "values": "text",
      "queryparam": true
    }
  ],
  "staff_selection_type": "text",
  "is_approval_sequence": true,
  "tags": [
    {
      "keys": "text",
      "values": "text",
      "queryparam": true
    }
  ],
  "staffs": [
    {
      "keys": "text",
      "values": "text",
      "queryparam": true
    }
  ],
  "sequence_staffs": [
    {
      "keys": "text",
      "values": "text",
      "queryparam": true
    }
  ],
  "level_staff": [
    {
      "keys": "text",
      "values": "text",
      "queryparam": true
    }
  ],
  "is_preconfigure": true,
  "is_deleted": true,
  "organization": "text",
  "creation_time": "2025-06-07T15:04:05.795Z",
  "last_update_time": "2025-06-07T15:04:05.795Z",
  "response_required": true,
  "approval_percentage": 1,
  "department": "text",
  "business_hr_profile": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "asset_tags": [],
  "is_add_notify_required": true,
  "is_demo_data": true,
  "events_thres_id": [],
  "location": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "group_email": "text",
  "delegate_members": [
    {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  ],
  "team_delegate": true,
  "sequence_delegate": true,
  "config": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  }
}

Deletes the team with given id

delete

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

Authorizations

Path parameters

idstringRequired

Responses

204

No response body

delete

HTTPcURLJavaScriptPython

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

204

No response body

No content

post

API endpoint that allows users to be viewed or edited.

Authorizations

Body

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

Team Serializers

idstringRequired

module_ui_namestringRead-onlyRequired

team_idstring · max: 225Required

module_idintegerOptional

module_namestringOptional

group_typestringOptional

group_idintegerOptional

namestring · max: 225Optional

descriptionstringOptional

staff_selection_typestringOptional

is_approval_sequencebooleanOptional

is_preconfigurebooleanOptional

is_deletedbooleanOptional

organizationstring · max: 225Required

creation_timestring · date-timeOptional

last_update_timestring · date-timeOptional

response_requiredbooleanOptional

approval_percentageintegerOptional

departmentstringOptional

is_add_notify_requiredbooleanOptional

is_demo_databooleanOptional

group_emailstringOptional

team_delegatebooleanOptional

sequence_delegatebooleanOptional

Responses

200Success

application/json

post

HTTPcURLJavaScriptPython

POST /ux/common/teams/profile/incident_map/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 1112

{
  "id": "text",
  "team_id": "text",
  "module_id": 1,
  "module_name": "text",
  "group_type": "text",
  "group_id": 1,
  "name": "text",
  "description": "text",
  "owner": [
    {
      "keys": "text",
      "values": "text",
      "queryparam": true
    }
  ],
  "staff_selection_type": "text",
  "is_approval_sequence": true,
  "tags": [
    {
      "keys": "text",
      "values": "text",
      "queryparam": true
    }
  ],
  "staffs": [
    {
      "keys": "text",
      "values": "text",
      "queryparam": true
    }
  ],
  "sequence_staffs": [
    {
      "keys": "text",
      "values": "text",
      "queryparam": true
    }
  ],
  "level_staff": [
    {
      "keys": "text",
      "values": "text",
      "queryparam": true
    }
  ],
  "is_preconfigure": true,
  "is_deleted": true,
  "organization": "text",
  "creation_time": "2025-06-07T15:04:05.795Z",
  "last_update_time": "2025-06-07T15:04:05.795Z",
  "response_required": true,
  "approval_percentage": 1,
  "department": "text",
  "business_hr_profile": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "asset_tags": [],
  "is_add_notify_required": true,
  "is_demo_data": true,
  "events_thres_id": [],
  "location": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "group_email": "text",
  "delegate_members": [
    {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  ],
  "team_delegate": true,
  "sequence_delegate": true,
  "config": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  }
}

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

200Success

{
  "id": "text",
  "module_ui_name": "text",
  "team_id": "text",
  "module_id": 1,
  "module_name": "text",
  "group_type": "text",
  "group_id": 1,
  "name": "text",
  "description": "text",
  "owner": [
    {
      "keys": "text",
      "values": "text",
      "queryparam": true
    }
  ],
  "staff_selection_type": "text",
  "is_approval_sequence": true,
  "tags": [
    {
      "keys": "text",
      "values": "text",
      "queryparam": true
    }
  ],
  "staffs": [
    {
      "keys": "text",
      "values": "text",
      "queryparam": true
    }
  ],
  "sequence_staffs": [
    {
      "keys": "text",
      "values": "text",
      "queryparam": true
    }
  ],
  "level_staff": [
    {
      "keys": "text",
      "values": "text",
      "queryparam": true
    }
  ],
  "is_preconfigure": true,
  "is_deleted": true,
  "organization": "text",
  "creation_time": "2025-06-07T15:04:05.795Z",
  "last_update_time": "2025-06-07T15:04:05.795Z",
  "response_required": true,
  "approval_percentage": 1,
  "department": "text",
  "business_hr_profile": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "asset_tags": [],
  "is_add_notify_required": true,
  "is_demo_data": true,
  "events_thres_id": [],
  "location": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "group_email": "text",
  "delegate_members": [
    {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  ],
  "team_delegate": true,
  "sequence_delegate": true,
  "config": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  }
}

get

API endpoint that allows users to be viewed or edited.

Authorizations

Responses

200Success

application/json

get

HTTPcURLJavaScriptPython

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

200Success

{
  "id": "text",
  "module_ui_name": "text",
  "team_id": "text",
  "module_id": 1,
  "module_name": "text",
  "group_type": "text",
  "group_id": 1,
  "name": "text",
  "description": "text",
  "owner": [
    {
      "keys": "text",
      "values": "text",
      "queryparam": true
    }
  ],
  "staff_selection_type": "text",
  "is_approval_sequence": true,
  "tags": [
    {
      "keys": "text",
      "values": "text",
      "queryparam": true
    }
  ],
  "staffs": [
    {
      "keys": "text",
      "values": "text",
      "queryparam": true
    }
  ],
  "sequence_staffs": [
    {
      "keys": "text",
      "values": "text",
      "queryparam": true
    }
  ],
  "level_staff": [
    {
      "keys": "text",
      "values": "text",
      "queryparam": true
    }
  ],
  "is_preconfigure": true,
  "is_deleted": true,
  "organization": "text",
  "creation_time": "2025-06-07T15:04:05.795Z",
  "last_update_time": "2025-06-07T15:04:05.795Z",
  "response_required": true,
  "approval_percentage": 1,
  "department": "text",
  "business_hr_profile": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "asset_tags": [],
  "is_add_notify_required": true,
  "is_demo_data": true,
  "events_thres_id": [],
  "location": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "group_email": "text",
  "delegate_members": [
    {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  ],
  "team_delegate": true,
  "sequence_delegate": true,
  "config": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  }
}

post

API endpoint that allows users to be viewed or edited.

Authorizations

Body

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

Team Serializers

idstringRequired

module_ui_namestringRead-onlyRequired

team_idstring · max: 225Required

module_idintegerOptional

module_namestringOptional

group_typestringOptional

group_idintegerOptional

namestring · max: 225Optional

descriptionstringOptional

staff_selection_typestringOptional

is_approval_sequencebooleanOptional

is_preconfigurebooleanOptional

is_deletedbooleanOptional

organizationstring · max: 225Required

creation_timestring · date-timeOptional

last_update_timestring · date-timeOptional

response_requiredbooleanOptional

approval_percentageintegerOptional

departmentstringOptional

is_add_notify_requiredbooleanOptional

is_demo_databooleanOptional

group_emailstringOptional

team_delegatebooleanOptional

sequence_delegatebooleanOptional

Responses

200Success

application/json

post

HTTPcURLJavaScriptPython

POST /ux/common/teams/profile/usergrplist/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 1112

{
  "id": "text",
  "team_id": "text",
  "module_id": 1,
  "module_name": "text",
  "group_type": "text",
  "group_id": 1,
  "name": "text",
  "description": "text",
  "owner": [
    {
      "keys": "text",
      "values": "text",
      "queryparam": true
    }
  ],
  "staff_selection_type": "text",
  "is_approval_sequence": true,
  "tags": [
    {
      "keys": "text",
      "values": "text",
      "queryparam": true
    }
  ],
  "staffs": [
    {
      "keys": "text",
      "values": "text",
      "queryparam": true
    }
  ],
  "sequence_staffs": [
    {
      "keys": "text",
      "values": "text",
      "queryparam": true
    }
  ],
  "level_staff": [
    {
      "keys": "text",
      "values": "text",
      "queryparam": true
    }
  ],
  "is_preconfigure": true,
  "is_deleted": true,
  "organization": "text",
  "creation_time": "2025-06-07T15:04:05.795Z",
  "last_update_time": "2025-06-07T15:04:05.795Z",
  "response_required": true,
  "approval_percentage": 1,
  "department": "text",
  "business_hr_profile": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "asset_tags": [],
  "is_add_notify_required": true,
  "is_demo_data": true,
  "events_thres_id": [],
  "location": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "group_email": "text",
  "delegate_members": [
    {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  ],
  "team_delegate": true,
  "sequence_delegate": true,
  "config": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  }
}

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

200Success

{
  "id": "text",
  "module_ui_name": "text",
  "team_id": "text",
  "module_id": 1,
  "module_name": "text",
  "group_type": "text",
  "group_id": 1,
  "name": "text",
  "description": "text",
  "owner": [
    {
      "keys": "text",
      "values": "text",
      "queryparam": true
    }
  ],
  "staff_selection_type": "text",
  "is_approval_sequence": true,
  "tags": [
    {
      "keys": "text",
      "values": "text",
      "queryparam": true
    }
  ],
  "staffs": [
    {
      "keys": "text",
      "values": "text",
      "queryparam": true
    }
  ],
  "sequence_staffs": [
    {
      "keys": "text",
      "values": "text",
      "queryparam": true
    }
  ],
  "level_staff": [
    {
      "keys": "text",
      "values": "text",
      "queryparam": true
    }
  ],
  "is_preconfigure": true,
  "is_deleted": true,
  "organization": "text",
  "creation_time": "2025-06-07T15:04:05.795Z",
  "last_update_time": "2025-06-07T15:04:05.795Z",
  "response_required": true,
  "approval_percentage": 1,
  "department": "text",
  "business_hr_profile": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "asset_tags": [],
  "is_add_notify_required": true,
  "is_demo_data": true,
  "events_thres_id": [],
  "location": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "group_email": "text",
  "delegate_members": [
    {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  ],
  "team_delegate": true,
  "sequence_delegate": true,
  "config": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  }
}

get

API endpoint that allows users to be viewed or edited.

Authorizations

Responses

200Success

application/json

get

HTTPcURLJavaScriptPython

GET /ux/common/teams/profile/validate_team_change/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "id": "text",
  "module_ui_name": "text",
  "team_id": "text",
  "module_id": 1,
  "module_name": "text",
  "group_type": "text",
  "group_id": 1,
  "name": "text",
  "description": "text",
  "owner": [
    {
      "keys": "text",
      "values": "text",
      "queryparam": true
    }
  ],
  "staff_selection_type": "text",
  "is_approval_sequence": true,
  "tags": [
    {
      "keys": "text",
      "values": "text",
      "queryparam": true
    }
  ],
  "staffs": [
    {
      "keys": "text",
      "values": "text",
      "queryparam": true
    }
  ],
  "sequence_staffs": [
    {
      "keys": "text",
      "values": "text",
      "queryparam": true
    }
  ],
  "level_staff": [
    {
      "keys": "text",
      "values": "text",
      "queryparam": true
    }
  ],
  "is_preconfigure": true,
  "is_deleted": true,
  "organization": "text",
  "creation_time": "2025-06-07T15:04:05.795Z",
  "last_update_time": "2025-06-07T15:04:05.795Z",
  "response_required": true,
  "approval_percentage": 1,
  "department": "text",
  "business_hr_profile": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "asset_tags": [],
  "is_add_notify_required": true,
  "is_demo_data": true,
  "events_thres_id": [],
  "location": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "group_email": "text",
  "delegate_members": [
    {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  ],
  "team_delegate": true,
  "sequence_delegate": true,
  "config": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  }
}