Models
Label
Properties
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Yes | The label's identifier, used wherever a label is assigned or unassigned. Example: "lbl_01JQZ8X0M4T7RB6K9V2NDHW3PA" |
teamId | string | Yes | The team the label belongs to. Labels are team-wide, not per company |
externalId | string | null | Yes | Your own identifier for the label, if you set one. It is unique within the team, so you can address a label by the id your system already uses. Example: "erp-routing-inbox" |
name | string | Yes | The label's name, as it is shown in the dashboard and returned on the documents and suppliers it is assigned to. Example: "ERP" |
colorHex | string | Yes | The colour the label is shown in, as a hex code. Example: "#3B82F6" |
createdAt | string (date-time) | Yes | When the label was created. Format: date-time |
updatedAt | string (date-time) | Yes | When the label was last changed. Format: date-time |