List badge holders

GET {{baseUrl}}/api/v1/badges/([0-9]+)/users

This API lists a particular number of users with badges, based on the limit defined.

OAuth Scope

  • Desk.settings.READ

Request Params

KeyDatatypeRequiredDescription
fromstringIndex number, starting from which the users must be listed
limitstringNumber of users to list

HEADERS

KeyDatatypeRequiredDescription
Authorizationstring

RESPONSES

status: OK

{"users":[{"name":"Jade Tywin","id":"3000000000455"},{"name":"Steve","id":"3000000000385"}]}