Forum
A request or response body; the type column links to the schemas it refers to.
Forum
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | yes | — |
| organization_id | string (uuid) | yes | — |
| organization_name | string | yes | — |
| department_id | string (uuid) | yes | The department the forum belongs to. Everyone holding a role in it, or in a department nested beneath it, may read the forum and take part. |
| department_name | string | yes | — |
| name | string | yes | — |
| description | string | null | yes | What belongs in the forum, in plain text. |
| topic_count | integer | yes | How many discussions it holds. minimum 0 |
| last_activity_at | string (date-time) | null | yes | The newest discussion activity in it; null while it holds no discussion. |
| created_at | string (date-time) | yes | — |
| archived_at | string (date-time) | null | yes | Set while the forum is archived: its discussions stay readable, but nobody starts one, replies or edits until it is restored. |
| viewer | ForumViewer | yes | — |
jsonExample
{
"id": "1b671a64-40d5-491e-99b0-da01ff1f3341",
"organization_id": "1b671a64-40d5-491e-99b0-da01ff1f3341",
"organization_name": "string",
"department_id": "1b671a64-40d5-491e-99b0-da01ff1f3341",
"department_name": "string",
"name": "Equipment questions",
"description": "Ask about the bench tools, the hoods and the gauges.",
"topic_count": 0,
"last_activity_at": "2026-01-01T00:00:00.000Z",
"created_at": "2026-01-01T00:00:00.000Z",
"archived_at": "2026-01-01T00:00:00.000Z",
"viewer": {
"post": true,
"manage": true,
"delete": true
}
}