List labels
GET {{baseUrl}}/api/v1/labels
This API lists a particular number of labels, based on the limit defined.
OAuth Scope
Desk.contacts.READDesk.settings.READ
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
from | string | Index number, starting from which the labels must be fetched. The default value is 1. | |
limit | string | Number of labels to list. The default value and the maximum value allowed is 50. | |
sortBy | string | Key that sorts the list of labels by a particular attribute: -(createdTime or modifiedTime, or name) | |
searchBy | string | Search keyword to use for finding a particular label. The keyword must contain at least two characters. Three types of search are supported: keyword* (search for values that start with the keyword, *keyword* (search for values that contain the keyword), and keyword (search for values that are exact matches of the keyword) | |
helpCenterId | string | ID of the help center from which the labels must be fetched |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Authorization | string |
RESPONSES
status: OK
{"data":[{"modifiedTime":"2017-09-19T04:58:50.000Z","preferences":{"shape":"ROUNDED","bgColor":"#FFEE","textColor":"#FFEE"},"creator":{"photoURL":"https://desk.zoho.com/portal/api/user/6000000015895/photo?orgId=143315","name":"SupportAdmin","id":"310975130121"},"modifier":{"photoURL":"https://desk.zoho.com/portal/api/user/6000000015895/photo?orgId=143315","name":"SupportAdmin","id":"310975130121"},"name":"Pro Customer","count":"892","createdTime":"2017-09-19T04:58:50.000Z","id":"310975130110","helpCenterId":"310975130119","logoUrl":"https://desk.zoho.com/portal/api/publicImages/310975130121?portalId=5c9470fcc808cc98932703e28221d6c302e105dc4da8b23fafb6719abeecaa48"}]}