Get
/v2/Teams/roles
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
Show example

Success

Collapse all
object
result
Array of object (RoleMetaData) | null

Customer API response data

object
id
string | null

The ID of the role

title
string | null

Name of the role

description
string | null

Description of role

is_system_role
boolean

If true, it indicates that the role is one of the system default roles.

role_type
integer (int32)
Valid values[ 0, 1 ]
extension_data
object (ExtensionDataObject)
success
boolean

Status indication for customer API response

errors
Array of object (BaseError) | null

Errors in the customer API response

object
warnings
Array of object (BaseWarning) | null

Warnings in the customer API response

object
information
Array of object (BaseInformation) | null

Information passed by the customer API response

object