Get all user groups

  • Updated on Dec 24, 2024
  • 1 minute(s) read
  • Janeera D A
  • Pradeep Srinivasan
  • Manoharan Soundarraj
Get
/v2/Teams/groups
Security
API Key
Header parameter nameapi_token

Enter REST API key. To generate a key, go to Settings → Knowledge base portal → API tokens

Responses
200

Success

Teams - Success status Response

Here you can gather all the type of team user group.

{
  "result": [
    {
      "group_id": "c08e52df-1de9-44e7-8c02-be0e41826c24",
      "title": "MyGroupName-1",
      "description": "This is the group description."
    },
    {
      "group_id": "e52dfdf-1de9-44edf7-8c02-be0e41826ff",
      "title": "MyGroupName-2",
      "description": "This is the group description."
    }
  ],
  "extension_data": null,
  "success": true,
  "errors": [],
  "warnings": [],
  "information": []
}
Expand All
object
result
Array of object (TeamAccountGroupSummaryCustomer) | null

Customer API response data

object
group_id
string | null

The ID of the team account group.

title
string | null

The name of the team account group.

description
string | null

Description of the team account group.

extension_data
object | null

Extention data for customer API response

success
boolean

Status indication for customer API response

errors
Array of object (BaseError) | null

Errors in the customer API response

object
extension_data
object | null

Thids is the Extention data object

stack_trace
string | null

Stack trace for error response message

description
string | null

Description for error cause

error_code
string | null

Error code for Api response

custom_data
object | null
property*
warnings
Array of object (BaseWarning) | null

Warnings in the customer API response

object
extension_data
object | null

Extention Data for customer Api warning

description
string | null

Warning description

warning_code
string | null

warning code for customer Api base response

information
Array of object (BaseInformation) | null

Information passed by the customer API response

object
extension_data
object | null

Extention data for customer Api response information

description
string | null

status description for customer Api response information