Skip to main content

ContactCategory

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

Returned by GET /contact-category, POST /contact-category, GET /contact-category/:id, PUT /contact-category/:id.

Example​

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

{
"_id": "6a957377859eafb47bf226d2",
"name": "Customer",
"description": "Has bought at least once.",
"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"
},
"createdAt": "2026-08-31T12:28:39.936Z",
"updatedAt": "2026-08-31T12:28:39.936Z",
"__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​

FieldTypeNotes
namestring
descriptionstring
companyObjectId -> Company
createdByObjectId -> Member
updatedByObjectId -> Member
_idObjectId
createdAtdateset once
updatedAtdate