Skip to main content
GET
Get a label

Authorizations

api_access_token
string
header
required

This token can be obtained by visiting the profile page or via rails console. Provides access to endpoints based on the user permissions levels. This token can be saved by an external system when user is created via API, to perform activities on behalf of the user.

Path Parameters

id
integer
required

The numeric ID of the label.

Example:

4

Response

Success

A label. title — not id — is the identifier every other endpoint uses: the conversation and contact label endpoints take and return titles.

id
integer

The numeric ID of the label.

title
string

The label text, lower-cased on save. Unique within the account.

description
string | null

Internal note about when to apply the label. Not shown to contacts.

color
string

Hex colour used for the label chip, including the leading #.

show_on_sidebar
boolean

Whether the label gets its own filtered view in the dashboard sidebar.