Contents x
Get all user groups
  • 16 Mar 2023
  • 1 Minute to read
  • Contributors
  • Print
  • Dark
    Light
Contents

Get all user groups

  • Updated on 16 Mar 2023
  • 1 Minute to read
  • Contributors
  • Print
  • Dark
    Light
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

Customer Api response data

object
group_id
string

The ID of the team account group.

title
string

The name of the team account group.

description
string

Description of the team account group.

extension_data
object
success
boolean

Status indication for customer Api response

errors
Array of object

Errors in the customer Api response

object
extension_data
stack_trace
string

Stack trace for error response message

description
string

Description for error cause

error_code
string

Error code for Api resonse

custom_data
object
warnings
Array of object

Warning in the customer Api response

object
extension_data
description
string

Warning description

warning_code
string

warning code for customer Api base response

information
Array of object

Information passed by the customer Api response

object
extension_data
description
string

status description for customer Api response information

Was this article helpful?
What's Next