Labels help group other records for reporting and organisational purposes.
Label objects provide a way to group, categorise or tag other records for reporting and organisational purposes.
The Label Object
Label Object| Attribute | Data Type | Description |
|---|---|---|
| id | Integer | The unique ID for the label given by Claimable. |
| slug | String | Read Only A unique key representing the label, formed from the name. |
| for | String | Read Only The type of record for which this label applies, e.g. "claims", "contacts" etc. |
| name | String | The name of the label as displayed in the Claimable UI. |
| color | String | Read Only A hex colour code for the label's display colour. |
| created_at | Timestamp | Read Only The date/time the label was created. |
| created_by | Integer | Read Only The id of the user who created the label. |
Example Label Object
{
"id": 1234,
"slug": "awaiting-repair",
"for": "claims",
"name": "Awaiting Repair",
"color": "#ff54bc",
"created_at": "2022-11-12T17:17:35.693Z",
"created_by": 1234
}