Tag

Stored in the tags collection. createdAt and updatedAt are maintained automatically.

Returned by GET /tag, POST /tag, GET /tag/:id, PUT /tag/:id.

Example

One real Tag as returned by GET /tag, taken from the data array. Recorded from a live response, so the defaults, denormalised snapshots and populated fields are the actual ones:

{
  "_id": "6a957377859eafb47bf226b0",
  "name": "Hot",
  "description": "Ready to buy.",
  "company": "6a9572df859eafb47bf225d7",
  "createdBy": {
    "_id": "6a9572df859eafb47bf225d9",
    "name": "Docs Test User",
    "email": "test@test.test",
    "status": "owner"
  },
  "updatedBy": {
    "_id": "6a9572df859eafb47bf225d9",
    "name": "Docs Test User",
    "email": "test@test.test",
    "status": "owner"
  },
  "color": "oklch(0.977 0.013 236.62)",
  "createdAt": "2026-08-31T12:28:39.870Z",
  "updatedAt": "2026-08-31T12:28:39.870Z",
  "__v": 0
}

:::note Trimmed for reading A populated reference is shown by the fields that identify it rather than in full — it arrives as the entire referenced document. Long arrays are cut to the first two entries and marked, long strings are truncated, and any field that could carry a credential is dropped rather than masked. :::

Fields

Field	Type	Notes
`name`	string	required
`description`	string
`color`	string	default `oklch(0.923 0.003 48.717)`
`company`	ObjectId -> Company
`createdBy`	ObjectId -> Member
`updatedBy`	ObjectId -> Member
`_id`	ObjectId
`createdAt`	date	set once
`updatedAt`	date

Example​

Fields​

Example

Fields