List User badges
GET {{baseUrl}}/api/v1/users/([0-9]+)/badges
This API lists user's default and custom badges, based on the limit defined.
OAuth Scope
Desk.contacts.READ
Desk.settings.READ
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
from | string | Index number, starting from which the badges must be fetched. The default value is 1 | |
limit | string | Number of badges to list. The default value and the maximum value allowed is 50 | |
type | string | Type of badge: default or custom | |
sortBy | string | Sort by the createdTime attribute. The default sorting order is ascending. A - prefix denotes descending order of sorting. | |
startTime | string | Start time should be in GMT time zone | |
endTime | string | End time should be in GMT time zone |
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Authorization | string |
RESPONSES
status: OK
[{"name":"Badge 1","isCustom":"false","description":"Best Contributor","id":"1","iconUrl":"https://www.zylker.com/badge1.jpg"}]