 API: Guestbook
Guestbook entries in any status.
Calling the Endpoint
| HTTP Request Type | GET |
| Calling URI | https://www.YourDepartment.com/apps/api/guestbook/ |
| Request Header | Authorization: Bearer {access_token} |
Parameters
| Parameter | Description |
ID |
Optional. A single entry ID. |
StartDate |
Optional. Only entries on or after this date (yyyy-mm-dd). |
EndDate |
Optional. Only entries on or before this date (yyyy-mm-dd). |
Response Properties
| Property | Description |
id |
Entry ID (number) |
created |
Entry date/time (string) |
status |
Status: 0 = Pending, 1 = Offline, 2 = Online (number) |
name |
Visitor name (string) |
email |
Visitor email address (string) |
rank |
Visitor rank or title (string) |
location |
Visitor location (string) |
website |
Visitor website (string) |
text |
Entry text (string) |
Sample Request
GET https://www.YourDepartment.com/apps/api/guestbook/?MaxRows=1
Authorization: Bearer {access_token}
Sample Response
{
"status": 200,
"endpoint": "guestbook",
"domain": "www.YourDepartment.com",
"generated": "2026-09-06 09:15:00",
"startRow": 1,
"maxRows": 1,
"count": 1,
"totalCount": 128,
"items": [
{
"id": 305,
"created": "2026-09-02 19:47:00",
"status": 2,
"name": "Bob Wilson",
"email": "bwilson@example.com",
"rank": "Retired Captain",
"location": "Peoria, IL",
"website": "",
"text": "Great website! Proud to see my old company doing so well."
}
]
}
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: