 API: Document Library
Documents in any status with their categories and attached files.
Calling the Endpoint
| HTTP Request Type | GET |
| Calling URI | https://www.YourDepartment.com/apps/api/documents/ |
| Request Header | Authorization: Bearer {access_token} |
Parameters
| Parameter | Description |
ID |
Optional. A single document ID. |
CategoryID |
Optional. Limit to one category (the categoryId value). |
Public |
Optional. 1 = only documents marked public. |
StartDate |
Optional. Only documents posted on or after this date (yyyy-mm-dd). |
EndDate |
Optional. Only documents posted on or before this date (yyyy-mm-dd). |
Response Properties
| Property | Description |
id |
Document ID (number) |
title |
Document title (string) |
text |
Document body, may contain HTML (string) |
status |
Status: 0 = Pending, 1 = Offline, 2 = Online (number) |
public |
1 = visible on the public website (number) |
categoryId |
Category ID (number) |
category |
Category name (string) |
created |
Posted date/time (string) |
createdBy |
Posting member's name (string) |
modified |
Last modified date/time; empty if never modified (string) |
modifiedBy |
Modifying member's name; empty if never modified (string) |
files |
Array of {id, fileName, extension, fileSize} attached files |
Sample Request
GET https://www.YourDepartment.com/apps/api/documents/?MaxRows=1
Authorization: Bearer {access_token}
Sample Response
{
"status": 200,
"endpoint": "documents",
"domain": "www.YourDepartment.com",
"generated": "2026-09-06 09:15:00",
"startRow": 1,
"maxRows": 1,
"count": 1,
"totalCount": 34,
"items": [
{
"id": 52,
"title": "Standard Operating Guidelines",
"text": "Current SOGs for all fireground operations. See the attached PDF.",
"status": 2,
"public": 0,
"categoryId": 2,
"category": "Operations",
"created": "2026-06-12 09:00:00",
"createdBy": "Chief Miller",
"modified": "2026-08-20 16:40:00",
"modifiedBy": "Jane Doe",
"files": [
{
"id": 77,
"fileName": "SOG2026.pdf",
"extension": "pdf",
"fileSize": 482113
}
]
}
]
}
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: