 API: Discussion Forum
Forum topics in any status. Pass ID to get a single topic with its replies (returned in items[]; the topic itself is returned in a topic object).
Calling the Endpoint
| HTTP Request Type | GET |
| Calling URI | https://www.YourDepartment.com/apps/api/discuss/ |
| Request Header | Authorization: Bearer {access_token} |
Parameters
| Parameter | Description |
ID |
Optional. A single topic ID; the response then contains the topic plus its replies. |
StartDate |
Optional. Only topics with a last post on or after this date (yyyy-mm-dd). |
EndDate |
Optional. Only topics with a last post on or before this date (yyyy-mm-dd). |
Response Properties
| Property | Description |
id |
Topic ID; in single-topic mode each reply's ID (number) |
title |
Topic title (string) |
status |
Status: 1 = Online, 2 = Offline, 3 = Locked (number) |
locked |
1 = topic is locked (number) |
created |
Created date/time (string) |
createdBy |
Posting member's name (string) |
lastPost |
Last post date/time (string) |
replyCount |
List mode: number of online replies (number) |
text |
Single-topic mode: topic or reply text (string) |
Sample Request
GET https://www.YourDepartment.com/apps/api/discuss/?MaxRows=1
Authorization: Bearer {access_token}
Sample Response
{
"status": 200,
"endpoint": "discuss",
"domain": "www.YourDepartment.com",
"generated": "2026-09-06 09:15:00",
"startRow": 1,
"maxRows": 1,
"count": 1,
"totalCount": 58,
"items": [
{
"id": 96,
"title": "Ideas for the Fall Open House",
"status": 1,
"locked": 0,
"created": "2026-08-28 20:15:00",
"createdBy": "Jane Doe",
"lastPost": "2026-09-05 21:02:00",
"replyCount": 4
}
]
}
Records are returned in the items array. count is the
number of records in this response; totalCount is all matching records regardless of paging. Page with
StartRow and MaxRows (default 100, maximum 1000) until count + startRow exceeds totalCount.
Back to the API Documentation
|
September 21, 2026: