Tags API
The Tag object
Tags are one shared vocabulary across the workspace. The same VIP tag can sit on contacts, leads, companies and deals, and a tag's name is unique within the workspace.
| Field | Type | Notes |
|---|---|---|
id | string | The tag ID. Use it in the bulk endpoints |
name | string | Up to 40 characters, unique in the workspace |
color | string or null | Free-form, up to 20 characters, e.g. amber or #f59e0b |
createdAt | string (ISO 8601) | When the tag was created |
counts | object | How many contacts, leads, companies and deals carry the tag |
Example object
{
"id": "cmq5tag00alk34567890",
"name": "VIP",
"color": "amber",
"createdAt": "2026-09-27T14:02:00.000Z",
"counts": { "contacts": 42, "leads": 3, "companies": 5, "deals": 7 }
}Scopes
| Scope | Allows |
|---|---|
read:tags | GET /api/v1/tags |
write:tags | Create, rename, recolor and delete tags, and add or remove them on records |