This method retrieves the complete list of custom labels defined in the system.
Custom fields can be defined for various entities in the system. For example, to get all project labels, look at the records where LabelCategory equals "Project".
URL
(GET) settings/customlabels
PARAMETERS
token | The token obtained on connection | Required |
RESULTS
Returns a list of ApiCustomLabel records. Each record has these fields:LabelCategoryThe object to which this custom field is attached. This can be any of:CategoryResources (used with TMs, Project memories and segments)CategoryProjectsCategoryJobsCategoryOrdersCategoryCompaniesCategoryPersonsCategoryInvoicesLabelIdThe globally unique ID of the label.LabelNameThe name of the label as provided by the administrator.AlwaysVisibleTrue if the label is always shown or false if the label needs to be attached to an object explicitly by the user.OptionsA list of all label options/colors:DBCode: A code identifying this specific label option. This code uniquely identifies a specific label and option.Name: The administrator given name of the optionColor: The color of the label optionValue: the integer value of the label option