Document the v2 schedule endpoint

2026-09-11 18:16:08 -05:00
parent 5f4116b8e8
commit c177e7953d
2 changed files with 119 additions and 0 deletions
@@ -97,6 +97,22 @@ Requires API key.

 ---

+# Schedule (v2)
+
+Endpoint:
+
+GET /api/v2/schedule?email=<email>&licenseKey=<key>
+
+Authenticates with the paired `email` + `licenseKey` query parameters and
+validates only that the key belongs to the account (not that the license is
+active/entitled). Returns the user's Blocks with start/end times and the IDs of
+the selected Proclamations (content is fetched separately via
+`/api/v2/proclamations`). Rate limited to 10 requests per minute per IP.
+Failure messages follow the existing v2 shape:
+`not-authorized` or `this key doesn't appear to belong to you`.
+
+---
+
 # GHL Account Creation Webhook

 Endpoint: