Overview

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

• GET /Base/StaffGroup
  • Response
• GET /Base/StaffGroup/$id$
  • Arguments
  • Response
• PUT /Base/StaffGroup/$id$
  • Arguments
  • Response
• POST /Base/StaffGroup/
  • Arguments
  • Response
• DELETE /Base/StaffGroup/$id$
  • Arguments

 

Information

GET /Base/StaffGroup

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

Response

<staffgroups>
  <staffgroup>
    <id>1</id>
    <title>Administrator</title>
    <isadmin>1</isadmin>
  </staffgroup>
</staffgroups>

 

GET /Base/StaffGroup/$id$

Retrieve a staff group identified by $id$.

Arguments

Red = required

Name	Description
$id$	The numeric identifier of the staff group

Response

<staffgroups>
  <staffgroup>
    <id>1</id>
    <title>Administrator</title>
    <isadmin>1</isadmin>
  </staffgroup>
</staffgroups>

 

PUT /Base/StaffGroup/$id$

Update the staff group identified by $id$.

Arguments

Red = required

Name	Description
$id$	The numeric identifier of the staff group
title	The title of the staff group
isadmin	1 or 0, Boolean controlling whether or not staff members assigned to this group are Administrators

Response

<staffgroups>
  <staffgroup>
     <id>1</id>
     <title>Administrator</title>
     <isadmin>1</isadmin>
  </staffgroup>
</staffgroups>

 

POST /Base/StaffGroup/

Create a staff group.

Arguments

Red = required

Name	Description
title	The title of the user group
isadmin	1 or 0, Boolean controlling whether or not staff members assigned to this group are Administrators

Response

<staffgroups>
  <staffgroup>
     <id>1</id>
     <title>Administrator</title>
     <isadmin>1</isadmin>
  </staffgroup>
</staffgroups>

 

DELETE /Base/StaffGroup/$id$

Delete the staff group identified by $id$.

Arguments

Red = required

Name	Description
$id$	The numeric identifier of the staff group