 API: Online Members
The active member roster: rank, member type, three phone numbers with types, email, and mailing address.
Calling the Endpoint
| HTTP Request Type | GET |
| Calling URI | https://www.YourDepartment.com/apps/api/members/ |
| Request Header | Authorization: Bearer {access_token} |
Parameters
| Parameter | Description |
ID |
Optional. A single member ID. |
Response Properties
| Property | Description |
id |
Member ID (number) |
deptId |
Department ID (string) |
firstName |
First name (string) |
middleInitial |
Middle initial (string) |
lastName |
Last name (string) |
rankId |
Rank ID (number) |
rank |
Rank name (string) |
memberTypeId |
Membership type ID (number) |
memberType |
Membership type name (string) |
phone1 |
Phone 1 (string) |
phone1Type |
Phone 1 type, e.g. Cell, Home, Work; empty when not set (string) |
phone2 |
Phone 2 (string) |
phone2Type |
Phone 2 type; empty when not set (string) |
phone3 |
Phone 3 (string) |
phone3Type |
Phone 3 type; empty when not set (string) |
email |
Email address (string) |
address1 |
Street address line 1 (string) |
address2 |
Street address line 2 (string) |
city |
City (string) |
state |
State name; empty when not set (string) |
zip |
ZIP code (string) |
Sample Request
GET https://www.YourDepartment.com/apps/api/members/?MaxRows=1
Authorization: Bearer {access_token}
Sample Response
{
"status": 200,
"endpoint": "members",
"domain": "www.YourDepartment.com",
"generated": "2026-09-06 09:15:00",
"startRow": 1,
"maxRows": 1,
"count": 1,
"totalCount": 64,
"items": [
{
"id": 87,
"deptId": "71-12",
"firstName": "John",
"middleInitial": "A",
"lastName": "Smith",
"rankId": 4,
"rank": "Captain",
"memberTypeId": 1,
"memberType": "Active",
"phone1": "301-555-0142",
"phone1Type": "Cell",
"phone2": "301-555-0107",
"phone2Type": "Home",
"phone3": "",
"phone3Type": "",
"email": "jsmith@example.com",
"address1": "123 Main Street",
"address2": "",
"city": "Mechanicsville",
"state": "Maryland",
"zip": "20659"
}
]
}
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: