Skip to main content

get_label_list

Get the list of labels available for tagging items.
Property
Read-onlyYes

Parameters

None.

Returns

A list of LabelDto objects, each containing:
FieldDescription
labelIdLabel ID
nameLabel display name
bgColorBackground color (hex)

create_label

Create a label with a name and background color. Requires super admin.
Property
Read-onlyNo

Parameters

ParameterTypeRequiredDescription
namestringYesLabel display name.
bgColorstringYesBackground color (hex, e.g. #ff0000).

Returns

A LabelDto with the created label’s details.

update_label

Update a label’s name and/or background color. Only provided fields are updated. Requires super admin.
Property
Read-onlyNo

Parameters

ParameterTypeRequiredDescription
labelIdstringYesLabel ID. Use get_label_list.
namestringNoNew label name.
bgColorstringNoNew background color (hex).

Returns

A LabelDto with the updated label details.

delete_label

Delete a label. Requires super admin.
Property
Read-onlyNo

Parameters

ParameterTypeRequiredDescription
labelIdstringYesLabel ID. Use get_label_list.

Returns

A confirmation message with the deleted label’s name.