REST-Staff
This topic provides details about the REST - Staff API call that GFI HelpDesk uses, including its field types, arguments, and responses.
GET /Base/Staff
Retrieve a list of all staff users in the help desk.
Response
<staff>
<id>1</id>
<staffgroupid>1</staffgroupid>
<firstname>John</firstname>
<lastname>Doe</lastname>
<fullname>John Doe</fullname>
<username>admin</username>
<email>john.doe@kayako.com</email>
<designation>CEO</designation>
<greeting>Hello, How may I help you?</greeting>
<mobilenumber>123456</mobilenumber>
<isenabled>1</isenabled>
<timezone>GMT</timezone>
<enabledst>1</enabledst>
<signature>John Doe (+1 909 23232344)</signature>
</staff>
</staffusers>
GET /Base/Staff/$id$
Retrieve a staff identified by $id$.
Arguments
| Name | Description |
|---|---|
| $id$ | The numeric identifier of the staff |
Response
<staff>
<id>1</id>
<staffgroupid>1</staffgroupid>
<firstname>John</firstname>
<lastname>Doe</lastname>
<fullname>John Doe</fullname>
<username>admin</username>
<email>john.doe@kayako.com</email>
<designation>CEO</designation>
<greeting>Hello, How may I help you?</greeting>
<mobilenumber>123456</mobilenumber>
<isenabled>1</isenabled>
<timezone>GMT</timezone>
<enabledst>1</enabledst>
<signature>John Doe (+1 909 23232344)</signature>
</staff>
</staffusers>
PUT /Base/Staff/$id$
Update the staff account identified by $id$.
Arguments
| Name | Description |
|---|---|
| firstname | The first name |
| lastname | The last name |
| username | The login username |
| password | Is only updated if it is specified with the request |
| staffgroupid | The staff group ID |
| The staff email address | |
| designation | The Designation/Title of Staff |
| mobilenumber | The mobile number of Staff user |
| staffsignature | The Signature to append to each reply made by staff |
| isenabled | Toggle the enabled/disabled property using this flag |
| greeting | The default greeting message when the staff accepts a live chat request |
| timezone | The default time zone for Staff |
| enabledst | Toggle the enabling/disabling of automatic DST calculation |
Response
<staff>
<id>1</id>
<staffgroupid>1</staffgroupid>
<firstname>John</firstname>
<lastname>Doe</lastname>
<fullname>John Doe</fullname>
<username>admin</username>
<email>john.doe@kayako.com</email>
<designation>CEO</designation>
<greeting>Hello, How may I help you?</greeting>
<mobilenumber>123456</mobilenumber>
<isenabled>1</isenabled>
<timezone>GMT</timezone>
<enabledst>1</enabledst>
<signature>John Doe (+1 909 23232344)</signature>
</staff>
</staffusers>
POST /Base/Staff
Create a new Staff account.
Arguments
| Name | Description |
|---|---|
| firstname | The first name |
| lastname | The last name |
| username | The login username |
| password | The staff password |
| staffgroupid | The staff group ID |
| The staff email address | |
| designation | The Designation/Title of Staff |
| mobilenumber | The mobile number of Staff user |
| staffsignature | The Signature to append to each reply made by staff |
| isenabled | Toggle the enabled/disabled property using this flag |
| greeting | The default greeting message when the staff accepts a live chat request |
| timezone | The default time zone for Staff |
| enabledst | Toggle the enabling/disabling of automatic DST calculation |
Response
<staff>
<id>1</id>
<staffgroupid>1</staffgroupid>
<firstname>John</firstname>
<lastname>Doe</lastname>
<fullname>John Doe</fullname>
<username>admin</username>
<email>john.doe@kayako.com</email>
<designation>CEO</designation>
<greeting>Hello, How may I help you?</greeting>
<mobilenumber>123456</mobilenumber>
<isenabled>1</isenabled>
<timezone>GMT</timezone>
<enabledst>1</enabledst>
<signature>John Doe (+1 909 23232344)</signature>
</staff>
</staffusers>
DELETE /Base/Staff/$id$
Delete the staff identified by $id$.
Arguments
| Name | Description |
|---|---|
| $id$ | The numeric identifier of the staff |