List Starred Views

GET {{baseUrl}}/api/v1/starredViews?module=<string> max chars : 100

This API lists the starred views in a module. Number of resources in the starred view is displayed only for the Tickets module.

OAuth Scope

  • Desk.settings.READ

Request Params

KeyDatatypeRequiredDescription
modulestringModule associated with the view. Values allowed are:tickets, tasks, contacts, accounts, activities, calls or events.
departmentIdstringID of the department in which the view(s) is (are) configured.

HEADERS

KeyDatatypeRequiredDescription
Authorizationstring

RESPONSES

status: OK

{&quot;starredViews&quot;:[{&quot;isCustomView&quot;:false,&quot;name&quot;:&quot;All Tickets&quot;,&quot;count&quot;:&quot;40&quot;,&quot;id&quot;:&quot;4000000007834&quot;},{&quot;isCustomView&quot;:false,&quot;name&quot;:&quot;Open Tickets&quot;,&quot;count&quot;:&quot;22&quot;,&quot;id&quot;:&quot;4000000007844&quot;}],&quot;module&quot;:&quot;tickets&quot;}