Start a conversation

REST - UserGroup

Overview

This article provides details about the REST - UserGroup API call that Kayako Classic uses, including its field types, arguments, and responses.


Information

GET /Base/UserGroup

Retrieve a list of all user groups in the help desk.


Response

<usergroups>
<usergroup>
<id>1</id>
<title>Registered</title>
<grouptype>registered</grouptype>
<ismaster>1</ismaster>
</usergroup><usergroup>

<id>2</id>
<title>Guest</title>
<grouptype>guest</grouptype>
<ismaster>1</ismaster>
</usergroup><usergroup>

<id>3</id>
<title>Clients</title>
<grouptype>registered</grouptype>
<ismaster>0</ismaster>
</usergroup>
</usergroups>


GET /Base/UserGroup/$id$

Retrieve the user group identified by $id$.


Arguments

Red = required

Name Description
$id$ The unique numeric identifier of the user group


Response

Unknown macro: 'api-response-ok'


PUT /Base/UserGroup/$id$

Update the user group identified by $id$.


Arguments

Red = required

Name Description
$id$ The unique numeric identifier of the user group
title The title of the user group


Response

<usergroups>
<usergroup>
<id>1</id>
<title>Registered</title>
<grouptype>registered</grouptype>
<ismaster>1</ismaster>
</usergroup>
</usergroups>


POST /Base/UserGroup

Create a user group.


Arguments

Red = required

Name Description
title The title of the user group
grouptype The type of user group('guest' or 'registered')


Response

<usergroups>
<usergroup>
<id>1</id>
<title>Registered</title>
<grouptype>registered</grouptype>
<ismaster>1</ismaster>
</usergroup>
</usergroups>


DELETE /Base/UserGroup/$id$

Delete the user group identified by $id$.


Arguments

Red = required

Name Description
$id$

The unique numeric identifier of the user group

Choose files or drag and drop files
Was this article helpful?
Yes
No
  1. Priyanka Bhotika

  2. Posted

Comments

  1. Rachel Smith

    Fuck she a slut