Skip to Content
API ReferenceRegistrations

Registrations

A Registration defines the signup window, capacity, and payment settings for a league or tournament. Teams register through the public registration link.

Endpoint: /api/v1/registrations Required scope: read:registrations (read) / write:registrations or admin (write)

Endpoints

MethodPathAuthDescription
GET/api/v1/registrations?league=:idRecommendedList registrations for a league
GET/api/v1/registrations/:idRecommendedGet a single registration
POST/api/v1/registrationsRequiredCreate a registration for a league
PUT/api/v1/registrations/:idRequiredUpdate registration settings

Allowed ?include= roots: contests, paymentProduct, tournament, contest, league, organization. A common combination: ?include=contests,paymentProduct,tournament,contest. See Query Parameter: ?include=.

Fields

FieldTypeDefaultDescription
_idObjectId—Unique identifier
messagestring—Custom message shown to registrants
activebooleantrueWhether registration is accepting submissions
hiddenbooleanfalseHide from public listing
startDatedatenowRegistration open date (with config.gateByStartDate, blocks sign-ups before this instant)
endDatedate—Registration close date; with config.gateByEndDate, blocks new-team sign-ups after this instant (existing teams stay editable)
timeZonestringbrowser zoneIANA time zone (e.g. America/Los_Angeles) governing how startDate/endDate are interpreted and displayed
deadlineDatedatenowLegacy display-only deadline (the enforced close gate is endDate)
contestTypestring""Contest type (Mens / Womens / Co-ed / Open)
sportsstring[][]Sports for this registration
requirePlayersboolean—Teams must add players
hasPaymentsboolean—Payments are required
allowCoachesboolean—Allow coaches to be added
requireReleaseStatementboolean—Require team waiver agreement
releaseStatementstring—Team waiver text
requireThankYouMessagebooleanfalseShow thank you message on completion
thankYouMessagestring""Thank you message text
costCostSchema—Fee structure
settingsRegistrationSettingsSchema—Advanced settings
teamFieldsRegistrationField[][]Custom fields for teams
managerFieldsRegistrationField[][]Custom fields for managers
fieldsRegistrationField[][]General custom fields
playerWaiversPlayerWaiver[][]Player waiver requirements
organizationObjectId—Owning organization
tournamentObjectId—Parent tournament (ref: Tournament)
leagueObjectId—Parent league (ref: League)
paymentProductObjectId—Payment product (ref: PaymentProduct)
donationProductObjectId—Donation product (ref: PaymentProduct)
contestObjectId—League ref alias
contestsstring[][]Multiple league refs

CostSchema

FieldTypeDescription
amountnumberFee amount in cents
perPlayerbooleanCharge per player
perTeambooleanCharge per team

RegistrationSettingsSchema

FieldTypeDescription
numDaysToRemindTeamnumberDays before deadline to send reminder
emailReminderTeambooleanSend email reminders
rosterLockDatedateDate after which rosters are locked
rosterLockbooleanWhether roster is locked
hurryFinishTeamRegistration.enabledbooleanUrgency mode enabled
hurryFinishTeamRegistration.numDaysAgonumberDays before deadline to trigger urgency

RegistrationFieldSchema

Custom fields for collecting additional info from teams and players:

FieldTypeDescription
namestringField label
fieldIdstringUnique field identifier
requiredbooleanWhether field is required
helperTextstringHelper text shown under the field
ordernumberDisplay order
primitiveTypestringData type (text, number, boolean, etc.)
fieldTypestringUI control type (input, select, checkbox, email, etc.)
permanentbooleanCannot be removed once set
includebooleanWhether field is included in the form
optionsstring[]Options for select/radio fields

Fields with fieldType: "email" render a dedicated email input (whitespace stripped, lowercased as you type) and are format-validated on submit: a malformed address blocks the form.

Create a Registration

curl -X POST https://api.staty.io/api/v1/registrations \ -H "Authorization: Bearer sk_live_..." \ -H "Content-Type: application/json" \ -d '{ "league": "league_abc123", "startDate": "2026-03-01", "deadlineDate": "2026-03-28", "active": true, "requirePlayers": true, "cost": { "amount": 15000, "perTeam": true } }'

Response:

{ "success": true, "data": { "_id": "reg_ghi789", "league": "league_abc123", "startDate": "2026-03-01T00:00:00.000Z", "deadlineDate": "2026-03-28T00:00:00.000Z", "active": true, "requirePlayers": true, "cost": { "amount": 15000, "perTeam": true }, "created": "2026-03-15T10:00:00.000Z" } }
Last updated on