- /api (v1) answers 410 API_V1_REMOVED, except provider webhooks (/api/webhooks/*, /api/whatsapp/webhook) and links in sent messages (308s, one-click POST). 43 v1 route files and deprecation.ts removed; /docs redirects to /docs/v2; API_DOCUMENTATION.md points there. - Read-only and impersonation lists name v2 paths only. The campus scope route test now runs over v2 routes (v2CampusScope.test.ts). - Passwords hashed with Argon2id (@node-rs/argon2); bcrypt hashes still sign in and are re-hashed at the next sign-in. - e2e on /api/v2 only (v2() helper); Playwright waits on /api/v2. - MIGRATING-TO-2.md with the full v1 -> v2 table. - Two documented response shapes corrected. Backend 690 tests and e2e 102/102 (PayFast sandbox skipped) pass. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
409 lines
30 KiB
Markdown
409 lines
30 KiB
Markdown
# Moving to Cross Events 2.0
|
|
|
|
Cross Events 2.0 removes version 1 of the API (`/api/…`). Everything the app does has been on
|
|
version 2 (`/api/v2/…`) since 1.51.16, so **a church that only uses the app has nothing to do** —
|
|
the update looks the same as any other. This guide is for anyone with their own integration (a
|
|
script, a website plug-in, a spreadsheet import) that calls the API directly, and for whoever runs
|
|
the server.
|
|
|
|
## What still works without changes
|
|
|
|
- **Payment and WhatsApp webhooks.** Yoco, PayFast and WAWP keep posting to the addresses they were
|
|
registered with: `/api/webhooks/yoco`, `/api/webhooks/payfast`, `/api/webhooks/whatsapp` and the
|
|
oldest WAWP address, `/api/whatsapp/webhook`. New registrations use `/api/v2/webhooks/…`.
|
|
- **Links in messages already sent.** "Add to calendar" links (`/api/events/{id}/ics`) and one-click
|
|
unsubscribe links (`/api/privacy/unsubscribe/{token}/one-click`) answer `308` with their v2
|
|
address; a mail app's one-click `POST` to the old address is still handled.
|
|
- **Outbound webhooks** (Site settings → Webhooks) send the same events and payloads as before.
|
|
- **Pages people open** — event pages, consent forms, ticket transfers, waitlist offers — are app
|
|
pages, not API addresses, so they were never affected.
|
|
|
|
Any other `/api/…` address now answers **`410 Gone`**:
|
|
|
|
```json
|
|
{ "code": "API_V1_REMOVED", "message": "API v1 was removed in Cross Events 2.0. Use /api/v2 — it is described at /docs/v2." }
|
|
```
|
|
|
|
`/docs` (the v1 reference) redirects to `/docs/v2`.
|
|
|
|
## How v2 differs
|
|
|
|
The full reference is at `/docs/v2` on your site (sign in as an admin), generated from the code so
|
|
it is always current. The OpenAPI 3.1 document is `GET /api/v2/openapi.json`.
|
|
|
|
| | v1 | v2 |
|
|
|---|---|---|
|
|
| Answers | whatever each endpoint returned | always `{ "data": … }` |
|
|
| Lists | plain arrays, some paged | `{ "data": [ … ], "meta": { "page", "limit", "total", "pages" } }`, `?page=` and `?limit=` (most lists up to 100) |
|
|
| Errors | `{ "message", "code"? }`, often `400` | `{ "error": { "code", "message", "reason"?, "fields"? } }` — `code` is one of a fixed set (`VALIDATION_FAILED`, `UNAUTHENTICATED`, `FORBIDDEN`, `NOT_FOUND`, `CONFLICT`, `READ_ONLY`, `RATE_LIMITED`, `UNAVAILABLE`, `INTERNAL`); v1's `code` is now `reason` |
|
|
| Input | anything | checked against the documented schema; mistakes are `VALIDATION_FAILED` with `fields` |
|
|
| Changing a record | mostly `PUT` | `PATCH` for partial changes (events, ticket options, variants, series, users, coupons…) |
|
|
| Dates | mixed | ISO 8601, UTC |
|
|
|
|
Things that behave differently, not just live at a new address:
|
|
|
|
- **Signing in:** `POST /api/v2/auth/login` takes `{ identifier, password }` (an email or phone
|
|
number). If two-step sign-in is on, the answer is `status: "code_sent"` with a `challengeId`;
|
|
finish with `POST /api/v2/auth/login/code`.
|
|
- **Signing up:** `POST /api/v2/auth/signup` needs `acceptTerms: true`; the phone number is
|
|
`phone`. The answer's `data` holds `token` and `user`.
|
|
- **Checking a ticket in:** `POST /api/v2/checkin/{qrCode}` with `{ people? }` (was `qty`). Every
|
|
normal result is a `200` with an `outcome` — `checked_in`, `already_used`, `consent_required`,
|
|
`wrong_event`, … — where v1 used `403`s. Look a ticket up first with `GET /api/v2/checkin/{qrCode}`.
|
|
- **Paying online:** `POST /api/v2/registrations/{id}/checkout` (the registration is in the path,
|
|
not the body).
|
|
- **Cancelling a registration:** `POST /api/v2/registrations/{id}/cancel` (was `DELETE`).
|
|
- **Staff lists of registrations** are paged (up to 200 a page).
|
|
- **A suspended or unlicensed site** refuses new events, registrations and payments with
|
|
`READ_ONLY` / reason `LICENCE_READ_ONLY`.
|
|
|
|
## For whoever runs the server
|
|
|
|
1. Deploy as usual: `bash scripts/deploy.sh v2.0.0` (it backs up, migrates, builds and rolls back
|
|
on failure). Run `bash scripts/deploy.sh --check` first if anyone may have changed files by hand.
|
|
2. Two migrations run: `20261030120000_ai_helpers` (the AI call log) and anything newer listed in the
|
|
CHANGELOG.
|
|
3. **AI helpers** need the site connected to the Hub (Site settings → Licence) and a monthly AI cap
|
|
above R0 on the licence. The Hub must run 1.6.0 or later. With no cap the AI buttons don't show
|
|
and nothing else changes.
|
|
4. If something outside Cross Events still calls `/api/…`, it will get `410` after the update — look
|
|
for those in the nginx access log before updating (`grep -v '/api/v2/' access.log | grep ' /api/'`,
|
|
leaving out the webhook and link addresses above).
|
|
5. Passwords are re-hashed with a stronger method the next time each person signs in; nothing to do.
|
|
|
|
## Every v1 address and its v2 replacement
|
|
|
|
`{id}` is the record's id. `{a|b}` means either. Methods that changed are shown in the v2 column.
|
|
|
|
| v1 | v2 |
|
|
|---|---|
|
|
| `GET /api/events` | `GET /api/v2/events` |
|
|
| `GET /api/events/{id}` | `GET /api/v2/events/{id}/full` |
|
|
| `GET /api/events/{id}/ics` | `GET /api/v2/events/{id}/calendar.ics` |
|
|
| `GET /api/events/by-alias/{id}` | `GET /api/v2/events/by-alias/{id}` |
|
|
| `POST /api/events/{id}/options` | `POST /api/v2/events/{id}/ticket-options` |
|
|
| `PUT /api/events/options/{id}` | `PATCH /api/v2/ticket-options/{id}` |
|
|
| `DELETE /api/events/options/{id}` | `DELETE /api/v2/ticket-options/{id}` |
|
|
| `POST /api/events/options/{id}/variants` | `POST /api/v2/ticket-options/{id}/variants` |
|
|
| `PUT /api/events/variants/{id}` | `PATCH /api/v2/variants/{id}` |
|
|
| `DELETE /api/events/variants/{id}` | `DELETE /api/v2/variants/{id}` |
|
|
| `GET /api/events/attachments/status` | `GET /api/v2/attachments/status` |
|
|
| `POST /api/events/attachments/sync` | `POST /api/v2/attachments/sync` |
|
|
| `GET /api/events/{id}/attachments` | `GET /api/v2/events/{id}/attachments` |
|
|
| `POST /api/events/{id}/attachments` | `POST /api/v2/events/{id}/attachments` |
|
|
| `DELETE /api/events/{id}/attachments/{id2}` | `DELETE /api/v2/events/{id}/attachments/{id2}` |
|
|
| `GET /api/sections` | `GET /api/v2/sections` |
|
|
| `POST /api/sections` | `POST /api/v2/sections` |
|
|
| `PUT /api/sections/{id}` | `PATCH /api/v2/sections/{id}` |
|
|
| `DELETE /api/sections/{id}` | `DELETE /api/v2/sections/{id}` |
|
|
| `GET /api/events/{id}/costs` | `GET /api/v2/events/{id}/costs` |
|
|
| `POST /api/events/{id}/costs` | `POST /api/v2/events/{id}/costs` |
|
|
| `PUT /api/costs/{id}` | `PATCH /api/v2/costs/{id}` |
|
|
| `DELETE /api/costs/{id}` | `DELETE /api/v2/costs/{id}` |
|
|
| `POST /api/uploads/{event-image|logo|favicon}` | `POST /api/v2/uploads/{event-image|logo|favicon}` |
|
|
| `GET /api/events/all` | `GET /api/v2/events/manage` |
|
|
| `POST /api/events` | `POST /api/v2/events` |
|
|
| `PUT /api/events/{id}` | `PATCH /api/v2/events/{id}` |
|
|
| `DELETE /api/events/{id}` | `DELETE /api/v2/events/{id}` |
|
|
| `POST /api/events/{id}/copy-from` | `POST /api/v2/events/{id}/copy-from` |
|
|
| `GET /api/events/{id}/notify-recipients` | `GET /api/v2/events/{id}/notify-recipients` |
|
|
| `PUT /api/events/{id}/notify-recipients` | `PUT /api/v2/events/{id}/notify-recipients` |
|
|
| `POST /api/webhooks/{yoco|payfast|whatsapp}` | `POST /api/v2/webhooks/{yoco|payfast|whatsapp}` |
|
|
| `POST /api/whatsapp/webhook` | `POST /api/v2/webhooks/whatsapp` |
|
|
| `POST /api/privacy/unsubscribe/{id}/one-click` | `POST /api/v2/unsubscribe/{id}/one-click` |
|
|
| `GET /api/privacy/me` | `GET /api/v2/me/privacy` |
|
|
| `PUT /api/privacy/me/news` | `PUT /api/v2/me/privacy/news` |
|
|
| `GET /api/privacy/me/export` | `GET /api/v2/me/privacy/export` |
|
|
| `POST /api/privacy/me/requests` | `POST /api/v2/me/privacy/requests` |
|
|
| `POST /api/privacy/me/notice/accept` | `POST /api/v2/me/privacy/notice/accept` |
|
|
| `GET /api/privacy/notice` | `GET /api/v2/privacy/notice` |
|
|
| `GET /api/privacy/unsubscribe/{id}` | `GET /api/v2/unsubscribe/{id}` |
|
|
| `POST /api/privacy/unsubscribe/{id}` | `POST /api/v2/unsubscribe/{id}` |
|
|
| `GET /api/privacy/requests` | `GET /api/v2/privacy/requests` |
|
|
| `POST /api/privacy/requests/{id}/{complete|reject}` | `POST /api/v2/privacy/requests/{id}/{complete|reject}` |
|
|
| `GET /api/privacy/notice/draft` | `GET /api/v2/privacy/notice/draft` |
|
|
| `PUT /api/privacy/notice/draft` | `PUT /api/v2/privacy/notice/draft` |
|
|
| `DELETE /api/privacy/notice/draft` | `DELETE /api/v2/privacy/notice/draft` |
|
|
| `POST /api/privacy/notice/{publish|builtin-reviewed}` | `POST /api/v2/privacy/notice/{publish|builtin-reviewed}` |
|
|
| `GET /api/privacy/operators` | `GET /api/v2/privacy/operators` |
|
|
| `POST /api/privacy/operators` | `POST /api/v2/privacy/operators` |
|
|
| `PUT /api/privacy/operators/{id}` | `PUT /api/v2/privacy/operators/{id}` |
|
|
| `DELETE /api/privacy/operators/{id}` | `DELETE /api/v2/privacy/operators/{id}` |
|
|
| `GET /api/privacy/{consent-log|access-log|readiness|retention|breaches}` | `GET /api/v2/privacy/{consent-log|access-log|readiness|retention|breaches}` |
|
|
| `PUT /api/privacy/retention` | `PUT /api/v2/privacy/retention` |
|
|
| `POST /api/privacy/retention/run` | `POST /api/v2/privacy/retention/run` |
|
|
| `POST /api/privacy/breaches` | `POST /api/v2/privacy/breaches` |
|
|
| `PUT /api/privacy/breaches/{id}` | `PUT /api/v2/privacy/breaches/{id}` |
|
|
| `GET /api/admin/{audit-log|jobs|impersonation-sessions}` | `GET /api/v2/admin/{audit-log|jobs|impersonation-sessions}` |
|
|
| `POST /api/admin/jobs/{id}/run` | `POST /api/v2/admin/jobs/{id}/run` |
|
|
| `POST /api/admin/impersonate/{end|log}` | `POST /api/v2/me/impersonation/{end|log}` |
|
|
| `GET /api/admin/impersonate/current` | `GET /api/v2/me/impersonation` |
|
|
| `POST /api/admin/impersonate/{id}` | `POST /api/v2/admin/impersonate/{id}` |
|
|
| `GET /api/settings/needs-setup` | `GET /api/v2/setup/needed` |
|
|
| `GET /api/settings/all` | `GET /api/v2/settings/all` |
|
|
| `GET /api/settings` | `GET /api/v2/settings` |
|
|
| `PUT /api/settings` | `PUT /api/v2/settings` |
|
|
| `POST /api/settings/test-smtp` | `POST /api/v2/settings/test-smtp` |
|
|
| `POST /api/setup/register` | `POST /api/v2/setup/register` |
|
|
| `POST /api/setup` | `POST /api/v2/setup` |
|
|
| `GET /api/hub/{status|notices}` | `GET /api/v2/hub/{status|notices}` |
|
|
| `POST /api/hub/{connect|heartbeat|update-request|update-snooze}` | `POST /api/v2/hub/{connect|heartbeat|update-request|update-snooze}` |
|
|
| `POST /api/hub/update-request/cancel` | `POST /api/v2/hub/update-request/cancel` |
|
|
| `GET /api/outbound-webhooks` | `GET /api/v2/outbound-webhooks` |
|
|
| `POST /api/outbound-webhooks` | `POST /api/v2/outbound-webhooks` |
|
|
| `POST /api/outbound-webhooks/deliveries/{id}/resend` | `POST /api/v2/outbound-webhook-deliveries/{id}/resend` |
|
|
| `PUT /api/outbound-webhooks/{id}` | `PATCH /api/v2/outbound-webhooks/{id}` |
|
|
| `DELETE /api/outbound-webhooks/{id}` | `DELETE /api/v2/outbound-webhooks/{id}` |
|
|
| `POST /api/outbound-webhooks/{id}/{rotate-secret|test}` | `POST /api/v2/outbound-webhooks/{id}/{rotate-secret|test}` |
|
|
| `GET /api/outbound-webhooks/{id}/deliveries` | `GET /api/v2/outbound-webhooks/{id}/deliveries` |
|
|
| `GET /api/backups` | `GET /api/v2/backups` |
|
|
| `POST /api/backups/run` | `POST /api/v2/backups/run` |
|
|
| `GET /api/backups/{id}/download` | `GET /api/v2/backups/{id}/download` |
|
|
| `GET /api/{yoco|payfast}/config` | `GET /api/v2/payments/{yoco|payfast}/config` |
|
|
| `PUT /api/{yoco|payfast}/config` | `PUT /api/v2/payments/{yoco|payfast}/config` |
|
|
| `GET /api/yoco/webhooks` | `GET /api/v2/payments/yoco/webhooks` |
|
|
| `POST /api/yoco/webhooks` | `POST /api/v2/payments/yoco/webhooks` |
|
|
| `DELETE /api/yoco/webhooks/{id}` | `DELETE /api/v2/payments/yoco/webhooks/{id}` |
|
|
| `POST /api/payfast/test` | `POST /api/v2/payments/payfast/test` |
|
|
| `POST /api/users/login/2fa/resend` | `POST /api/v2/auth/login/code/resend` |
|
|
| `POST /api/users/forgot` | `POST /api/v2/auth/password/forgot` |
|
|
| `POST /api/users/reset` | `POST /api/v2/auth/password/reset` |
|
|
| `POST /api/users/activate` | `POST /api/v2/auth/activate` |
|
|
| `POST /api/users/revoke-sessions` | `POST /api/v2/me/sessions/revoke` |
|
|
| `POST /api/users/close-account` | `POST /api/v2/me/close` |
|
|
| `GET /api/users/activity` | `GET /api/v2/me/activity` |
|
|
| `POST /api/users/verify-password` | `POST /api/v2/me/verify-password` |
|
|
| `POST /api/users/2fa/{enable|confirm|disable}` | `POST /api/v2/me/two-factor/{enable|confirm|disable}` |
|
|
| `GET /api/users/check-exists` | `GET /api/v2/users/exists` |
|
|
| `POST /api/users/{id}/revoke-sessions` | `POST /api/v2/users/{id}/sessions/revoke` |
|
|
| `POST /api/users/{id}/anonymize` | `POST /api/v2/users/{id}/anonymize` |
|
|
| `GET /api/users` | `GET /api/v2/users` |
|
|
| `GET /api/users/{?!profile$}{id}` | `GET /api/v2/users/{?!profile$}` |
|
|
| `PUT /api/users/{?!profile$}{id}` | `PATCH /api/v2/users/{?!profile$}` |
|
|
| `DELETE /api/users/{id}` | `DELETE /api/v2/users/{id}` |
|
|
| `GET /api/events/admin/all` | `GET /api/v2/admin/events` |
|
|
| `POST /api/events/{id}/{email|whatsapp}-attendees` | `POST /api/v2/events/{id}/{email|whatsapp}-attendees` |
|
|
| `POST /api/events/{id}/{email|whatsapp}-attendees/schedule` | `POST /api/v2/events/{id}/{email|whatsapp}-attendees/schedule` |
|
|
| `POST /api/broadcasts/{preview|send|schedule}` | `POST /api/v2/broadcasts/email/{preview|send|schedule}` |
|
|
| `POST /api/whatsapp-broadcasts/{preview|send|schedule}` | `POST /api/v2/broadcasts/whatsapp/{preview|send|schedule}` |
|
|
| `GET /api/scheduled-emails` | `GET /api/v2/scheduled-messages` |
|
|
| `PATCH /api/scheduled-emails/{id}` | `PATCH /api/v2/scheduled-messages/{id}` |
|
|
| `DELETE /api/scheduled-emails/{id}` | `DELETE /api/v2/scheduled-messages/{id}` |
|
|
| `POST /api/automations/schedule` | `POST /api/v2/automations/schedule` |
|
|
| `GET /api/whatsapp/{config|status|qr}` | `GET /api/v2/whatsapp/{config|status|qr}` |
|
|
| `POST /api/whatsapp/config` | `GET/PUT /api/v2/whatsapp/config` |
|
|
| `POST /api/whatsapp/create-instance` | `POST /api/v2/whatsapp/instance` |
|
|
| `POST /api/whatsapp/delete-instance` | `POST /api/v2/whatsapp/instance` |
|
|
| `POST /api/whatsapp/{request-code|logout|start|restart}` | `POST /api/v2/whatsapp/{request-code|logout|start|restart}` |
|
|
| `GET /api/banner` | `GET /api/v2/banner` |
|
|
| `POST /api/banner` | `GET/PUT /api/v2/banner` |
|
|
| `GET /api/saved-filters` | `GET /api/v2/saved-filters` |
|
|
| `POST /api/saved-filters` | `POST /api/v2/saved-filters` |
|
|
| `PUT /api/saved-filters/{id}` | `PUT /api/v2/saved-filters/{id}` |
|
|
| `DELETE /api/saved-filters/{id}` | `DELETE /api/v2/saved-filters/{id}` |
|
|
| `GET /api/dashboard/{today|search}` | `GET /api/v2/dashboard/{today|search}` |
|
|
| `GET /api/stats/{staff|supervisor|admin|overview}` | `GET /api/v2/stats/{staff|supervisor|admin|overview}` |
|
|
| `POST /api/analytics/track` | `POST /api/v2/analytics/track` |
|
|
| `GET /api/analytics/funnel` | `GET /api/v2/analytics/funnel` |
|
|
| `POST /api/reports/{pdf|excel|email|whatsapp}` | `POST /api/v2/reports/{pdf|excel|email|whatsapp}` |
|
|
| `GET /api/kids/me` | `GET /api/v2/me/family` |
|
|
| `POST /api/kids/me` | `POST /api/v2/me/family` |
|
|
| `PUT /api/kids/me` | `PATCH /api/v2/me/family` |
|
|
| `DELETE /api/kids/me` | `DELETE /api/v2/me/family` |
|
|
| `POST /api/kids/me/{children|adults}` | `POST /api/v2/me/family/{children|adults}` |
|
|
| `PUT /api/kids/me/{children|adults}/{id}` | `PUT /api/v2/me/family/{children|adults}/{id}` |
|
|
| `DELETE /api/kids/me/{children|adults}/{id}` | `DELETE /api/v2/me/family/{children|adults}/{id}` |
|
|
| `GET /api/kids/setup-events` | `GET /api/v2/kids/setup-events` |
|
|
| `GET /api/kids/events` | `GET /api/v2/kids/events` |
|
|
| `GET /api/kids/events/{id}/{settings|board|families|offline}` | `GET /api/v2/events/{id}/kids/{settings|board|families|offline}` |
|
|
| `PUT /api/kids/events/{id}/settings` | `PUT /api/v2/events/{id}/kids/settings` |
|
|
| `POST /api/kids/events/{id}/{families|check-in|check-out|duty|sync}` | `POST /api/v2/events/{id}/kids/{families|check-in|check-out|duty|sync}` |
|
|
| `GET /api/kids/events/{id}/families/qr/{id2}` | `GET /api/v2/events/{id}/kids/families/qr/{id2}` |
|
|
| `GET /api/kids/events/{id}/families/{id2}` | `GET /api/v2/events/{id}/kids/families/{id2}` |
|
|
| `POST /api/kids/events/{id}/families/{id2}/{parents|children|adults}` | `POST /api/v2/events/{id}/kids/families/{id2}/{parents|children|adults}` |
|
|
| `PUT /api/kids/events/{id}/families/{id2}/children/{id3}` | `PUT /api/v2/events/{id}/kids/families/{id2}/children/{id3}` |
|
|
| `GET /api/kids/events/{id}/code/{id2}` | `GET /api/v2/events/{id}/kids/code/{id2}` |
|
|
| `POST /api/kids/check-ins/{id}/{override|page}` | `POST /api/v2/kids/check-ins/{id}/{override|page}` |
|
|
| `PUT /api/kids/check-ins/{id}/room` | `PUT /api/v2/kids/check-ins/{id}/room` |
|
|
| `POST /api/kids/alerts/{id}/resolve` | `POST /api/v2/kids/alerts/{id}/resolve` |
|
|
| `GET /api/volunteers/me` | `GET /api/v2/me/volunteering` |
|
|
| `GET /api/volunteers/events/{id}` | `GET /api/v2/events/{id}/volunteer-roles` |
|
|
| `POST /api/volunteers/roles/{id}/sign-up` | `POST /api/v2/volunteer-roles/{id}/sign-up` |
|
|
| `DELETE /api/volunteers/slots/{id}` | `DELETE /api/v2/volunteer-slots/{id}` |
|
|
| `POST /api/volunteers/slots/{id}/swap` | `POST /api/v2/volunteer-slots/{id}/swap` |
|
|
| `DELETE /api/volunteers/swaps/{id}` | `DELETE /api/v2/volunteer-swaps/{id}` |
|
|
| `POST /api/volunteers/swaps/{id}/accept` | `POST /api/v2/volunteer-swaps/{id}/accept` |
|
|
| `POST /api/volunteers/check-in` | `POST /api/v2/volunteering/check-in` |
|
|
| `GET /api/volunteers/manage/events` | `GET /api/v2/volunteering/events` |
|
|
| `GET /api/volunteers/manage/hours` | `GET /api/v2/volunteering/hours` |
|
|
| `GET /api/volunteers/manage/events/{id}` | `GET /api/v2/events/{id}/volunteers` |
|
|
| `GET /api/volunteers/manage/events/{id}/{qr|settings}` | `GET /api/v2/events/{id}/volunteers/{qr|settings}` |
|
|
| `PUT /api/volunteers/manage/events/{id}/settings` | `PUT /api/v2/events/{id}/volunteers/settings` |
|
|
| `POST /api/volunteers/manage/events/{id}/roles` | `POST /api/v2/events/{id}/volunteer-roles` |
|
|
| `PUT /api/volunteers/manage/roles/{id}` | `PATCH /api/v2/volunteer-roles/{id}` |
|
|
| `DELETE /api/volunteers/manage/roles/{id}` | `DELETE /api/v2/volunteer-roles/{id}` |
|
|
| `POST /api/volunteers/manage/roles/{id}/assign` | `POST /api/v2/volunteer-roles/{id}/assign` |
|
|
| `POST /api/volunteers/manage/slots/{id}/check-in` | `POST /api/v2/volunteer-slots/{id}/check-in` |
|
|
| `DELETE /api/volunteers/manage/slots/{id}` | `POST /api/v2/volunteer-slots/{id}/remove` |
|
|
| `GET /api/tickets/mytickets` | `GET /api/v2/me/tickets` |
|
|
| `POST /api/tickets/email` | `POST /api/v2/me/tickets/email` |
|
|
| `GET /api/tickets/scans/recent` | `GET /api/v2/tickets/scans/recent` |
|
|
| `GET /api/tickets/scans/stats` | `GET /api/v2/tickets/scans/stats` |
|
|
| `POST /api/tickets/send-to` | `POST /api/v2/tickets/send` |
|
|
| `POST /api/tickets/generate` | `POST /api/v2/tickets/generate` |
|
|
| `PUT /api/tickets/email-sent` | `POST /api/v2/tickets/email-sent` |
|
|
| `GET /api/tickets/qr/{id}` | `GET /api/v2/tickets/qr/{id}` |
|
|
| `GET /api/tickets/event/{id}` | `GET /api/v2/events/{id}/tickets` |
|
|
| `GET /api/tickets/transfer-offer/{id}` | `GET /api/v2/ticket-transfers/{id}` |
|
|
| `POST /api/tickets/transfer-offer/{id}/{accept|decline}` | `POST /api/v2/ticket-transfers/{id}/{accept|decline}` |
|
|
| `GET /api/tickets` | `GET /api/v2/tickets` |
|
|
| `GET /api/tickets/{id}/transfers` | `GET /api/v2/tickets/{id}/transfers` |
|
|
| `POST /api/tickets/{id}/transfer` | `POST /api/v2/tickets/{id}/transfer` |
|
|
| `DELETE /api/tickets/{id}/transfer` | `DELETE /api/v2/tickets/{id}/transfer` |
|
|
| `GET /api/tickets/{id}` | `GET /api/v2/tickets/{id}` |
|
|
| `GET /api/scan-locks` | `GET /api/v2/scan-locks` |
|
|
| `POST /api/scan-locks` | `POST /api/v2/scan-locks` |
|
|
| `GET /api/scan-locks/reports` | `GET /api/v2/scan-locks/reports` |
|
|
| `POST /api/scan-locks/reports/{id}/review` | `POST /api/v2/scan-locks/reports/{id}/review` |
|
|
| `GET /api/scan-locks/{id}/snapshot` | `GET /api/v2/scan-locks/{id}/snapshot` |
|
|
| `POST /api/scan-locks/{id}/{sync|force-release}` | `POST /api/v2/scan-locks/{id}/{sync|force-release}` |
|
|
| `DELETE /api/scan-locks/{id}` | `DELETE /api/v2/scan-locks/{id}` |
|
|
| `GET /api/attendance/certificates/verify/{id}` | `GET /api/v2/certificates/verify/{id}` |
|
|
| `GET /api/attendance/certificates/mine` | `GET /api/v2/me/certificates` |
|
|
| `POST /api/attendance/certificates/preview` | `POST /api/v2/certificates/preview` |
|
|
| `GET /api/attendance/certificates/{id}/pdf` | `GET /api/v2/certificates/{id}/pdf` |
|
|
| `POST /api/attendance/certificates/{id}/revoke` | `POST /api/v2/certificates/{id}/revoke` |
|
|
| `GET /api/attendance/{id}/export` | `GET /api/v2/events/{id}/attendance/export` |
|
|
| `POST /api/attendance/{id}/mark` | `POST /api/v2/events/{id}/attendance` |
|
|
| `POST /api/attendance/{id}/certificates` | `POST /api/v2/events/{id}/certificates` |
|
|
| `POST /api/attendance/{id}/certificates/send` | `POST /api/v2/events/{id}/certificates/send` |
|
|
| `GET /api/attendance/{id}/certificates.pdf` | `GET /api/v2/events/{id}/certificates.pdf` |
|
|
| `GET /api/attendance/{id}` | `GET /api/v2/events/{id}/attendance` |
|
|
| `GET /api/allocations/my-groups` | `GET /api/v2/me/allocation-groups` |
|
|
| `GET /api/allocations/event/{id}` | `GET /api/v2/events/{id}/allocations` |
|
|
| `POST /api/allocations/sets` | `POST /api/v2/allocation-sets` |
|
|
| `PUT /api/allocations/sets/{id}` | `PATCH /api/v2/allocation-sets/{id}` |
|
|
| `DELETE /api/allocations/sets/{id}` | `DELETE /api/v2/allocation-sets/{id}` |
|
|
| `GET /api/allocations/sets/{id}/lists` | `GET /api/v2/allocation-sets/{id}/lists` |
|
|
| `POST /api/allocations/sets/{id}/{groups|auto}` | `POST /api/v2/allocation-sets/{id}/{groups|auto}` |
|
|
| `PUT /api/allocations/sets/{id}/assignments` | `PUT /api/v2/allocation-sets/{id}/assignments` |
|
|
| `DELETE /api/allocations/sets/{id}/assignments` | `DELETE /api/v2/allocation-sets/{id}/assignments` |
|
|
| `PUT /api/allocations/groups/{id}` | `PATCH /api/v2/allocation-groups/{id}` |
|
|
| `DELETE /api/allocations/groups/{id}` | `DELETE /api/v2/allocation-groups/{id}` |
|
|
| `GET /api/payments/providers` | `GET /api/v2/payments/providers` |
|
|
| `GET /api/payments/providers/settings` | `GET /api/v2/payments/providers/settings` |
|
|
| `PUT /api/payments/providers/settings` | `PUT /api/v2/payments/providers/settings` |
|
|
| `GET /api/payments/pay/{id}` | `GET /api/v2/payment-links/{id}` |
|
|
| `POST /api/payments/pay/{id}` | `POST /api/v2/payment-links/{id}` |
|
|
| `GET /api/payments/checkouts/open` | `GET /api/v2/payments/open-checkouts` |
|
|
| `POST /api/payments/checkouts/check` | `POST /api/v2/payments/open-checkouts/check` |
|
|
| `POST /api/payments/[yoco-]checkout/send` | `POST /api/v2/registrations/{id}/payment-link` |
|
|
| `GET /api/payments/mypayments` | `GET /api/v2/me/payments` |
|
|
| `GET /api/payments/admin/stats` | `GET /api/v2/payments/stats` |
|
|
| `GET /api/payments/registration/{id}` | `GET /api/v2/registrations/{id}/payments` |
|
|
| `GET /api/payments/event/{id}` | `GET /api/v2/events/{id}/payments` |
|
|
| `PUT /api/payments/assign-donation` | `POST /api/v2/payments/donations/assign` |
|
|
| `POST /api/payments/unassign-donation` | `POST /api/v2/payments/donations/unassign` |
|
|
| `POST /api/payments/refund` | `POST /api/v2/payments/refunds` |
|
|
| `POST /api/payments/{id}/send-receipt` | `POST /api/v2/payments/{id}/receipt` |
|
|
| `GET /api/payments` | `GET /api/v2/payments` |
|
|
| `POST /api/payments` | `POST /api/v2/payments` |
|
|
| `GET /api/payments/{id}` | `GET /api/v2/payments/{id}` |
|
|
| `GET /api/cashups/audit` | `GET /api/v2/cashups/audit` |
|
|
| `GET /api/cashups/event/{id}` | `GET /api/v2/events/{id}/cashup` |
|
|
| `GET /api/cashups/event/{id}/cash-by-user` | `GET /api/v2/events/{id}/cashup/cash-by-user` |
|
|
| `PUT /api/cashups/event/{id}/person-cash/{id2}` | `PUT /api/v2/events/{id}/cashup/person-cash/{id2}` |
|
|
| `PUT /api/cashups/event/{id}/draft` | `PUT /api/v2/events/{id}/cashup/draft` |
|
|
| `POST /api/cashups/event/{id}/close` | `POST /api/v2/events/{id}/cashup/close` |
|
|
| `POST /api/cashups/event/{id}/reopen` | `POST /api/v2/events/{id}/cashup/reopen` |
|
|
| `POST /api/cashups/lines/{id}/pending` | `POST /api/v2/cashup-lines/{id}/pending` |
|
|
| `GET /api/{provider|yoco}-transactions` | `GET /api/v2/provider-transactions` |
|
|
| `GET /api/{provider|yoco}-transactions/unreconciled` | `GET /api/v2/provider-transactions/unreconciled` |
|
|
| `POST /api/{?:provider|yoco}-transactions/{id}/reconcile` | `POST /api/v2/provider-transactions/{?:provider|yoco}/reconcile` |
|
|
| `POST /api/{?:provider|yoco}-transactions/{id}/ignore` | `POST /api/v2/provider-transactions/{?:provider|yoco}/ignore` |
|
|
| `POST /api/waitlist` | `POST /api/v2/waitlist` |
|
|
| `GET /api/waitlist/mine` | `GET /api/v2/me/waitlist` |
|
|
| `GET /api/waitlist/claim/{id}` | `GET /api/v2/waitlist/claims/{id}` |
|
|
| `GET /api/waitlist/events/{id}` | `GET /api/v2/events/{id}/waitlist` |
|
|
| `POST /api/waitlist/{id}/{offer|move|remove}` | `POST /api/v2/waitlist/{id}/{offer|move|remove}` |
|
|
| `DELETE /api/waitlist/{id}` | `DELETE /api/v2/waitlist/{id}` |
|
|
| `GET /api/sponsorships/event/{id}` | `GET /api/v2/events/{id}/sponsorship` |
|
|
| `GET /api/sponsorships/event/{id}/pool` | `GET /api/v2/events/{id}/sponsorship/pool` |
|
|
| `POST /api/sponsorships/checkout` | `POST /api/v2/sponsorships/checkout` |
|
|
| `GET /api/consent/events/{id}` | `GET /api/v2/events/{id}/consent` |
|
|
| `GET /api/consent/events/{id}/medical` | `GET /api/v2/events/{id}/consent/medical` |
|
|
| `POST /api/consent/events/{id}/{resend-pending|rerequest}` | `POST /api/v2/events/{id}/consent/{resend-pending|rerequest}` |
|
|
| `POST /api/consent/requests/{id}/resend` | `POST /api/v2/consent-requests/{id}/resend` |
|
|
| `GET /api/consent/{id}` | `GET /api/v2/consent/{id}` |
|
|
| `POST /api/consent/{id}` | `POST /api/v2/consent/{id}` |
|
|
| `GET /api/forms/responses` | `GET /api/v2/form-responses` |
|
|
| `GET /api/feedback/summary` | `GET /api/v2/feedback/summary` |
|
|
| `GET /api/feedback/public/{id}` | `GET /api/v2/feedback-forms/{id}` |
|
|
| `POST /api/feedback/public/{id}` | `POST /api/v2/feedback-forms/{id}` |
|
|
| `GET /api/feedback/event/{id}` | `GET /api/v2/events/{id}/feedback` |
|
|
| `PUT /api/feedback/event/{id}` | `PUT /api/v2/events/{id}/feedback` |
|
|
| `DELETE /api/feedback/event/{id}` | `DELETE /api/v2/events/{id}/feedback` |
|
|
| `POST /api/feedback/event/{id}/send-now` | `POST /api/v2/events/{id}/feedback/send-now` |
|
|
| `GET /api/registrations` | `GET /api/v2/registrations` |
|
|
| `GET /api/registrations/myregistrations` | `GET /api/v2/me/registrations/full` |
|
|
| `GET /api/registrations/event/{id}` | `GET /api/v2/events/{id}/registrations` |
|
|
| `POST /api/registrations/manual` | `GET /api/v2/registrations/manual` |
|
|
| `POST /api/registrations/bulk` | `GET /api/v2/registrations/bulk` |
|
|
| `PUT /api/registrations/{id}/options` | `PUT /api/v2/registrations/{id}/items` |
|
|
| `POST /api/registrations/{id}/send-invoice` | `POST /api/v2/registrations/{id}/invoice` |
|
|
| `POST /api/registrations/{id}/coupon` | `POST /api/v2/registrations/{id}/coupon` |
|
|
| `DELETE /api/registrations/{id}/coupon` | `DELETE /api/v2/registrations/{id}/coupon` |
|
|
| `PUT /api/registrations/{id}/attendees` | `PUT /api/v2/registrations/{id}/attendees` |
|
|
| `POST /api/registrations/{id}/attendees/{id2}/send-form-link` | `POST /api/v2/registrations/{id}/attendees/{id2}/form-link` |
|
|
| `GET /api/registrations/{id}/forms/draft` | `GET /api/v2/registrations/{id}/form-draft` |
|
|
| `PUT /api/registrations/{id}/forms/draft` | `PUT /api/v2/registrations/{id}/form-draft` |
|
|
| `POST /api/registrations/{id}/forms/responses` | `POST /api/v2/registrations/{id}/form-responses` |
|
|
| `PUT /api/registrations/{id}/forms/responses` | `PUT /api/v2/registrations/{id}/form-responses` |
|
|
| `GET /api/registrations/{id}` | `GET /api/v2/registrations/{id}/full` |
|
|
| `PUT /api/registrations/{id}` | `PATCH /api/v2/registrations/{id}/status` |
|
|
| `GET /api/series` | `GET /api/v2/series` |
|
|
| `POST /api/series` | `POST /api/v2/series` |
|
|
| `GET /api/series/by-slug/{id}` | `GET /api/v2/series/by-slug/{id}` |
|
|
| `GET /api/series/{id}/compare` | `GET /api/v2/series/{id}/compare` |
|
|
| `POST /api/series/{id}/follow` | `PUT/DELETE /api/v2/series/{id}/follow` |
|
|
| `DELETE /api/series/{id}/follow` | `DELETE /api/v2/series/{id}/follow` |
|
|
| `PUT /api/series/{id}` | `PATCH /api/v2/series/{id}` |
|
|
| `DELETE /api/series/{id}` | `DELETE /api/v2/series/{id}` |
|
|
| `GET /api/season-passes/mine` | `GET /api/v2/me/season-passes` |
|
|
| `POST /api/season-passes/purchases/{id}/checkout` | `POST /api/v2/season-pass-purchases/{id}/checkout` |
|
|
| `POST /api/season-passes/{id}/buy` | `POST /api/v2/season-passes/{id}/buy` |
|
|
| `GET /api/season-passes` | `GET /api/v2/season-passes` |
|
|
| `POST /api/season-passes` | `POST /api/v2/season-passes` |
|
|
| `PUT /api/season-passes/{id}` | `PATCH /api/v2/season-passes/{id}` |
|
|
| `DELETE /api/season-passes/{id}` | `DELETE /api/v2/season-passes/{id}` |
|
|
| `POST /api/bundles/quote` | `PATCH/DELETE /api/v2/bundles/quote` |
|
|
| `GET /api/bundles/event/{id}` | `GET /api/v2/events/{id}/bundles` |
|
|
| `POST /api/bundles/event/{id}` | `POST /api/v2/events/{id}/bundles` |
|
|
| `PUT /api/bundles/{id}` | `PATCH /api/v2/bundles/{id}` |
|
|
| `DELETE /api/bundles/{id}` | `DELETE /api/v2/bundles/{id}` |
|
|
| `POST /api/coupons/validate` | `GET/PATCH /api/v2/coupons/check` |
|
|
| `GET /api/coupons/redemptions` | `GET /api/v2/coupons/redemptions` |
|
|
| `GET /api/coupons` | `GET /api/v2/coupons` |
|
|
| `POST /api/coupons` | `POST /api/v2/coupons` |
|
|
| `GET /api/coupons/{id}` | `GET /api/v2/coupons/{id}` |
|
|
| `PUT /api/coupons/{id}` | `PATCH /api/v2/coupons/{id}` |
|
|
| `GET /api/campuses` | `GET /api/v2/campuses` |
|
|
| `GET /api/campuses/admin` | `GET /api/v2/campuses/admin` |
|
|
| `GET /api/campuses/by-slug/{id}` | `GET /api/v2/campuses/by-slug/{id}` |
|
|
| `PUT /api/campuses/settings` | `PUT /api/v2/campuses/enabled` |
|
|
| `PUT /api/campuses/order` | `PUT /api/v2/campuses/order` |
|
|
| `POST /api/campuses` | `POST /api/v2/campuses` |
|
|
| `GET /api/campuses/{id}/audience` | `GET /api/v2/campuses/{id}/audience` |
|
|
| `PUT /api/campuses/{id}` | `PATCH /api/v2/campuses/{id}` |
|
|
| `DELETE /api/campuses/{id}` | `DELETE /api/v2/campuses/{id}` |
|
|
| `GET /api/users/profile` | `GET /api/v2/me` |
|
|
| `PUT /api/users/profile` | `PATCH /api/v2/me` |
|
|
| `POST /api/users` | `POST /api/v2/auth/signup` |
|
|
| `POST /api/users/login` | `POST /api/v2/auth/login` |
|
|
| `POST /api/users/login/2fa` | `POST /api/v2/auth/login/code` |
|
|
| `POST /api/registrations` | `POST /api/v2/registrations` |
|
|
| `DELETE /api/registrations/{id}` | `POST /api/v2/registrations/{id}/cancel` |
|
|
| `POST /api/payments/checkout` | `POST /api/v2/registrations/{id}/checkout` |
|
|
| `GET /api/tickets/scan-preview/{id}` | `GET /api/v2/checkin/{id}` |
|
|
| `POST /api/tickets/scan/{id}` | `POST /api/v2/checkin/{id}` |
|