Texa Desk Application API · Labels

Get a label

GET/api/v1/accounts/{account_id}/labels/{id}

Get the details of a label in the account

Authorization

api_access_tokenheaderrequired

A person's access token (Texa Desk, Profile settings → Access token) or an agent bot's token, in the api_access_token header. It acts as that person, with their role's permissions.

Path parameters

account_idintegerrequired

The numeric ID of the account

idnumberrequired

ID of the label

Responses

200

Success

idnumber

The ID of the label

titlestring

The title of the label

descriptionstring

The description of the label

colorstring

Hex color code for the label

show_on_sidebarboolean

Whether the label should appear in the sidebar

401

Unauthorized

descriptionstring

errorsarray of object

errors[].fieldstring

errors[].messagestring

errors[].codestring

404

The given label ID does not exist in the account

descriptionstring

errorsarray of object

errors[].fieldstring

errors[].messagestring

errors[].codestring