Registrations
These endpoints work with a member token from Sign in with Crewcade. The token needs the registrations scope. An API key does not work here.
Your app can sign a member up for a free ticket. Your app can cancel a free signup. A paid ticket stays on the Crewcade event page. Your app sends the member there.
List the registrations of a member
Section titled “List the registrations of a member”GET /me/registrations| Query | Type | Meaning |
|---|---|---|
when | string | upcoming or past. Default upcoming. |
status | string | Statuses to keep, separated by commas. Pick from pending, confirmed, waitlisted, cancelled and no_show. Default: all. |
page | number | The page to read. Starts at 1. Default 1. |
pageSize | number | Registrations per page. From 1 to 100. Default 20. |
upcomingmeans the start time is still ahead. Soonest first.pastmeans the start time has passed. Latest first.- A live event shows under
past.
Each registration has these fields.
| Field | Meaning |
|---|---|
id | The registration id. |
status | pending, confirmed, waitlisted, cancelled or no_show. |
registeredAt | When the member signed up. |
cancelledAt | When the member cancelled. null if not cancelled. |
tier | The ticket: id, name and nameText. Can be null. |
paymentState | none, awaiting, paid, refunded or refund_owed. none means free, or a payment that failed. |
event | The date: id, seriesId, publicId, urlKey, title, titleText, start, end, status and coverImageUrl. |
Read one registration
Section titled “Read one registration”GET /events/{id}/registrationPass the id of one date. You get the registration of the member for that date. You get 404 with not_registered when the member has none.
Sign a member up
Section titled “Sign a member up”POST /events/{id}/registrationThis works for free tickets only. If the member has several free tickets, send tierId in the JSON body. Read the tiers with GET /events/{id}. See Events API.
- The first call answers
201with the registration. - A second call answers
200with the same registration.
Cancel a free signup
Section titled “Cancel a free signup”DELETE /events/{id}/registrationYou get 204 with no body. Cancelling a signup that is already cancelled also gives 204.
Errors
Section titled “Errors”Every error body has code and message.
| Status | Code | Meaning |
|---|---|---|
| 400 | tier_required | The member can take more than one free ticket. Send tierId. The body lists tierIds. |
| 400 | tier_not_available | This ticket is not on sale for this date. |
| 400 | event_past | The date has already started. |
| 400 | registration_refused | The club does not allow this signup. The message says why. |
| 401 | invalid_token | The token is bad. |
| 403 | insufficient_scope | The token has no registrations scope. |
| 403 | TICKET_TIER_ROLE_RESTRICTED | The ticket is only for members with a certain role. |
| 404 | not_registered | The member has no registration for this date. |
| 404 | event_not_found | The event does not exist, or the member cannot open it. |
| 404 | event_is_series | You sent the id of a recurring series. Send the id of one date. |
| 409 | payment_required | The ticket costs money. Send the member to eventUrl in the body. |
| 409 | form_required | The event asks questions first. Send the member to eventUrl in the body. |
| 409 | event_full | The event has no seat left. |
| 409 | tier_sold_out | This ticket has no seat left. |
| 409 | refund_open | A refund for an earlier ticket is still open. Send the member to eventUrl. |
| 409 | already_registered | The member already holds a registration for this date. Look at eventUrl. |
| 409 | cancel_on_event_page | The ticket is paid, or was bought with others. The member cancels on eventUrl. |
| 429 | rate_limited | Too many requests. Wait the seconds in the Retry-After header. |