Client Labels

Get Client Labels

Returns the whole client label dictionary, system and custom alike. Unpaginated: the dictionary is small and consumers need the full set to render chips and filter controls.

GET
/api/v2/client-labels

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/v2/client-labels"
{  "total": 0,  "data": [    {      "code": "deposited",      "name": "Deposited",      "kind": "system",      "colour": "#8E44AD",      "id": 1    }  ]}
{  "error": {    "message": "Unauthorized"  }}
{  "error": {    "message": "Forbidden"  }}
{  "error": {    "message": "Too Many Requests"  }}
{  "error": {    "message": "Service Unavailable"  }}