List badges

GET {{baseUrl}}/api/v1/badges

This API lists a particular number of default and custom badges, based on the limit defined.

OAuth Scope

  • Desk.settings.READ

Request Params

KeyDatatypeRequiredDescription
fromstringIndex number starting from which the badges must be listed
limitstringNumber of badges to list
typestringType of badge: default or custom

HEADERS

KeyDatatypeRequiredDescription
Authorizationstring

RESPONSES

status: OK

[{"name":"Badge 1","isCustom":"false","description":"Best Contributor","levelName":null,"id":"1","iconUrl":"https://www.zylker.com/badge1.jpg"}]