 API: Databases
Member-built custom databases. Without DatabaseID, lists the databases. With DatabaseID, returns that database's records with every field; archived records are included and flagged.
Calling the Endpoint
| HTTP Request Type | GET |
| Calling URI | https://www.YourDepartment.com/apps/api/databases/ |
| Request Header | Authorization: Bearer {access_token} |
Parameters
| Parameter | Description |
DatabaseID |
Optional. The database whose records to return (the id value from the database listing). |
Response Properties
| Property | Description |
id |
List mode: database ID; record mode: record ID (number) |
title |
List mode: database title (string) |
description |
List mode: database description (string) |
type |
List mode: database type (string) |
archived |
Record mode: 1 = archived record (number) |
created |
Record mode: created date/time (string) |
createdBy |
Record mode: creating member's name; empty when unknown (string) |
modified |
Record mode: last modified date/time; empty if never modified (string) |
modifiedBy |
Record mode: modifying member's name; empty when unknown (string) |
(dynamic) |
Record mode: one property per field, named by the field's column name |
fields |
Record mode: array of {name, title, type, primary} describing the database's fields |
Sample Request
GET https://www.YourDepartment.com/apps/api/databases/?DatabaseID=3&MaxRows=1
Authorization: Bearer {access_token}
Sample Response
{
"status": 200,
"endpoint": "databases",
"domain": "www.YourDepartment.com",
"generated": "2026-09-06 09:15:00",
"startRow": 1,
"maxRows": 1,
"count": 1,
"totalCount": 42,
"database": "Apparatus Maintenance Requests",
"databaseId": 3,
"fields": [
{ "name": "Unit", "title": "Unit", "type": "select", "primary": 1 },
{ "name": "Issue", "title": "Issue Description", "type": "textarea", "primary": 1 }
],
"items": [
{
"id": 118,
"archived": 0,
"created": "2026-09-03 14:30:00",
"createdBy": "John Smith",
"modified": "",
"modifiedBy": "",
"Unit": "Engine 71",
"Issue": "Driver side spotlight is out."
}
]
}
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: