 API: Sign Up Sheets
« Back to the API Documentation overview - authentication, security, response codes, and the full endpoint list.
Online sign up sheets. 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).
| HTTP Request Type | GET |
| Calling URI | https://www.YourDepartment.com/apps/api/signup/ |
| Request Header | Authorization: Bearer {access_token} |
| Success Codes | 200 OK |
| Failure Codes | 400, 401, 403, 404, 405, 429, 500 - see the error reference |
Parameters
| Parameter | Description |
ID |
Optional. A Signup_ID; response then contains the sheet detail. |
Past |
Optional. 1 = include past sheets in the listing (default is upcoming only). |
All data endpoints also accept the common MaxRows
(default 100, maximum 500) and StartRow paging parameters.
Response Properties
| Property | Description |
Signup_ID / Signup_Title |
Sheet ID and title |
Signup_Date |
Sheet date (string, yyyy-mm-dd) |
Signup_EventDate / Signup_POC |
Event date text and point of contact (string) |
Signup_CreatedDate / Signup_ModifiedDate |
Created and last modified date/time (string) |
Author / ModifiedBy |
List mode: creating and modifying member names (string) |
SignupGroup_ID / SignupGroup_Name / Slots |
Detail mode: each item is a group with a Slots array |
Slots[].SignedUp |
Detail mode: array of {Name, Note, SignedUpDate} per slot |
Records are returned in the items array of the
standard response envelope.
Sample Code
Exchange your refresh token for an access token, then request data. The same two steps
work in any language; JavaScript and Python are shown here.
JavaScript
const BASE = "https://www.YourDepartment.com/apps/api";
const REFRESH_TOKEN = "your-refresh-token-here";
// 1. Exchange the refresh token for an access token (do this from a server,
// not from a public web page, so the refresh token stays secret)
const tokenRes = await fetch(`${BASE}/refresh/`, {
method: "POST",
headers: { "Authorization": `Bearer ${REFRESH_TOKEN}` }
});
const tokenData = await tokenRes.json();
// 2. Call the signup endpoint (reuse the token for up to 24 hours)
const res = await fetch(`${BASE}/signup/?MaxRows=10`, {
headers: { "Authorization": `Bearer ${tokenData.access_token}` }
});
const data = await res.json();
data.items.forEach(item => console.log(item));
Python
import requests
BASE = "https://www.YourDepartment.com/apps/api"
REFRESH_TOKEN = "your-refresh-token-here"
# 1. Exchange the refresh token for an access token
token = requests.post(f"{BASE}/refresh/",
headers={"Authorization": f"Bearer {REFRESH_TOKEN}"}).json()
# 2. Call the signup endpoint (reuse the token for up to 24 hours)
data = requests.get(f"{BASE}/signup/",
params={"MaxRows": 10},
headers={"Authorization": f"Bearer {token['access_token']}"}).json()
for item in data["items"]:
print(item)
|
August 15, 2026: