Skip to main content

Labels

EntityLabel

Labels are tags that can be attached to any entity in TribeCRM for categorisation and filtering. They are grouped into label categories.

Use the Label endpoint to query and manage labels. You can also access them via the Labels navigation property on any entity.

Endpoints

List Labels

GET/v1/odata/Label

Single Label

GET/v1/odata/Label({id})

Create Label

POST/v1/odata/Label

Update Label

PUT/v1/odata/Label({id})

Delete Label

DELETE/v1/odata/Label({id})

Fields

Label Fields

FieldTypeDescription
NameStringLabel name
IsInactiveBooleanWhether the label is inactive

Relationships

RelationshipTarget EntityCardinalityDescription
EntitiesEntity1:NEntities tagged with this label
LabelCategoryLabelCategoryN:1Label category

Expanding Relationships

GET/v1/odata/Label({id})?$expand=Entities
GET/v1/odata/Label({id})/Entities

Filtering Examples

GET/v1/odata/Label?$filter=Name eq '{Name}'&$top={top}
GET/v1/odata/Label?$filter=contains(Name, '{Name}')&$top={top}
GET/v1/odata/Label?$filter=IsInactive eq {IsInactive}&$top={top}