 API: Sign Up Sheets
Sign up sheets in any status. Pass ID for one sheet's groups, slots and who has signed up (groups are returned in items[]; the sheet itself in a sheet object).
Calling the Endpoint
| HTTP Request Type | GET |
| Calling URI | https://www.YourDepartment.com/apps/api/signup/ |
| Request Header | Authorization: Bearer {access_token} |
Parameters
| Parameter | Description |
ID |
Optional. A single sheet ID; the response then contains the sheet detail. |
All |
Optional. 1 = include past sheets in the listing (default is upcoming only). |
Response Properties
| Property | Description |
id |
Sheet ID; in detail mode each group's ID (number) |
title |
Sheet title (string) |
status |
Status: 0 = Pending, 1 = Offline, 2 = Online (number) |
date |
Sheet date (string, yyyy-mm-dd) |
eventDate |
Event date text (string) |
contact |
Detail mode: point of contact (string) |
created |
Created date/time (string) |
createdBy |
List mode: creating member's name (string) |
modified |
Last modified date/time; empty if never modified (string) |
modifiedBy |
List mode: modifying member's name; empty if never modified (string) |
name |
Detail mode: group name (string) |
slots |
Detail mode: array of {id, number, position, signedUp} slots per group |
slots[].signedUp |
Detail mode: array of {name, note, date} per slot |
Sample Request
GET https://www.YourDepartment.com/apps/api/signup/?MaxRows=1
Authorization: Bearer {access_token}
Sample Response
{
"status": 200,
"endpoint": "signup",
"domain": "www.YourDepartment.com",
"generated": "2026-09-06 09:15:00",
"startRow": 1,
"maxRows": 1,
"count": 1,
"totalCount": 3,
"items": [
{
"id": 64,
"title": "Open House Staffing",
"status": 2,
"date": "2026-10-11",
"eventDate": "October 11, 11 AM to 3 PM",
"created": "2026-09-01 12:00:00",
"createdBy": "Jane Doe",
"modified": "",
"modifiedBy": ""
}
]
}
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: