Events
Scheduled activities including classes, clinics, leagues, and recurring programs.
post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
eventIdstringRequiredExample:
3857358a-59e8-4944-8c48-3345c4375b43Body
idstringRequired
typestring · enumRead-onlyRequiredPossible values:
startTimestring · date-timeRead-onlyRequired
endTimestring · date-timeRead-onlyRequired
Responses
200
Returns an Unlock
application/json
idstringRequired
typestring · enumRead-onlyRequiredPossible values:
startTimestring · date-timeRead-onlyRequired
endTimestring · date-timeRead-onlyRequired
422
Returns an error
application/json
post/events/{eventId}/accesses
POST /apis/v2/events/{eventId}/accesses HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 13
{
"id": "text"
}{
"id": "text",
"type": "OPEN",
"startTime": "2026-01-01T00:00:00.000Z",
"endTime": "2026-01-01T00:00:00.000Z"
}get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
eventIdstringRequiredExample:
3857358a-59e8-4944-8c48-3345c4375b43Responses
200
Returns a Reservation
application/json
typestring · enumRequiredPossible values:
statusstring · enumRead-onlyRequiredPossible values:
reasonstring · enum · nullableRead-onlyOptionalPossible values:
reasonTextstring · nullableOptional
Optional free-text reason when reason is OTHER. Max 40 characters.
get/events/{eventId}/cancellation
GET /apis/v2/events/{eventId}/cancellation HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200
Returns a Reservation
{
"type": "PREVIEW",
"status": "DRAFT",
"reason": "WEATHER",
"reasonText": "text",
"summary": {
"policy": "FREE_OF_CHARGE",
"policySubtype": {},
"policyDescription": {},
"extensionId": {},
"cancellingUser": {
"id": "text",
"user": {
"id": "text"
},
"type": "REGULAR",
"firstName": "text",
"lastName": "text",
"gender": "text",
"birthday": "2026-01-01T00:00:00.000Z",
"initials": "text",
"description": "text",
"picture": {},
"usattRating": 1,
"duprProfileUrl": "text",
"memberSince": "2026-01-01T00:00:00.000Z",
"membershipEnrollment": {},
"kids": {},
"_links": {}
},
"cancellationTime": "2026-01-01T00:00:00.000Z",
"validUntilTime": "2026-01-01T00:00:00.000Z",
"cancellationFee": 1,
"refund": {
"reimbursement": 1,
"virtualCredits": 1,
"passes": {
"items": [
{
"id": {},
"available": 1,
"quantity": 1,
"displayName": "text",
"displayNamePlural": "text",
"rate": 1
}
],
"_total": 1,
"_links": {}
}
},
"errors": [
{
"code": "text",
"message": "text",
"details": {}
}
]
}
}post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
eventIdstringRequiredExample:
3857358a-59e8-4944-8c48-3345c4375b43Body
typestring · enumRequiredPossible values:
statusstring · enumRead-onlyRequiredPossible values:
reasonstring · enum · nullableRead-onlyOptionalPossible values:
reasonTextstring · nullableOptional
Optional free-text reason when reason is OTHER. Max 40 characters.
Responses
200
Returns an EventCancellation
application/json
typestring · enumRequiredPossible values:
statusstring · enumRead-onlyRequiredPossible values:
reasonstring · enum · nullableRead-onlyOptionalPossible values:
reasonTextstring · nullableOptional
Optional free-text reason when reason is OTHER. Max 40 characters.
422
Returns an error
application/json
post/events/{eventId}/cancellation
POST /apis/v2/events/{eventId}/cancellation HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 38
{
"type": "PREVIEW",
"reasonText": "text"
}{
"type": "PREVIEW",
"status": "DRAFT",
"reason": "WEATHER",
"reasonText": "text",
"summary": {
"policy": "FREE_OF_CHARGE",
"policySubtype": {},
"policyDescription": {},
"extensionId": {},
"cancellingUser": {
"id": "text",
"user": {
"id": "text"
},
"type": "REGULAR",
"firstName": "text",
"lastName": "text",
"gender": "text",
"birthday": "2026-01-01T00:00:00.000Z",
"initials": "text",
"description": "text",
"picture": {},
"usattRating": 1,
"duprProfileUrl": "text",
"memberSince": "2026-01-01T00:00:00.000Z",
"membershipEnrollment": {},
"kids": {},
"_links": {}
},
"cancellationTime": "2026-01-01T00:00:00.000Z",
"validUntilTime": "2026-01-01T00:00:00.000Z",
"cancellationFee": 1,
"refund": {
"reimbursement": 1,
"virtualCredits": 1,
"passes": {
"items": [
{
"id": {},
"available": 1,
"quantity": 1,
"displayName": "text",
"displayNamePlural": "text",
"rate": 1
}
],
"_total": 1,
"_links": {}
}
},
"errors": [
{
"code": "text",
"message": "text",
"details": {}
}
]
}
}get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
eventIdstringRequiredExample:
3857358a-59e8-4944-8c48-3345c4375b43Query parameters
expandstring[]Optional
Responses
200
Returns a EventNoteCollection
application/json
_totalnumberRequired
get/events/{eventId}/notes
GET /apis/v2/events/{eventId}/notes HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200
Returns a EventNoteCollection
{
"items": [
{
"id": "text",
"comment": "text"
}
],
"_total": 1,
"_links": {
"self": {
"href": "text"
}
}
}get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
noteIdstringRequiredExample:
security-noteeventIdstringRequiredExample:
3857358a-59e8-4944-8c48-3345c4375b43Query parameters
expandstring[]Optional
Responses
200
Returns a EventNote
application/json
idstringRequired
commentstringRequired
get/events/{eventId}/notes/{noteId}
GET /apis/v2/events/{eventId}/notes/{noteId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200
Returns a EventNote
{
"id": "text",
"comment": "text"
}put
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
eventIdstringRequiredExample:
3857358a-59e8-4944-8c48-3345c4375b43noteIdstringRequiredExample:
security-noteQuery parameters
expandstring[]Optional
Body
idstringRequired
commentstringRequired
Responses
200
Returns a EventNote
application/json
idstringRequired
commentstringRequired
put/events/{eventId}/notes/{noteId}
PUT /apis/v2/events/{eventId}/notes/{noteId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 30
{
"id": "text",
"comment": "text"
}200
Returns a EventNote
{
"id": "text",
"comment": "text"
}get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
openInvitationIdstringRequired
eventIdstringRequiredExample:
3857358a-59e8-4944-8c48-3345c4375b43Responses
200
Returns an OpenInvitation
application/json
idstringRead-onlyRequired
visibilitystring · enumRequiredPossible values:
chargeTypestring · enum · nullableRequiredPossible values:
typestring · enum · nullableRequiredPossible values:
sharingKeystringRead-onlyRequired
redeemUrlstringRead-onlyRequired
maxRedeemsnumber · nullableRead-onlyRequired
The number of times the invitation can be redeemed. Includes the owner's redemption.
redeemsRemainingnumberRead-onlyRequired
onBehalfOfEventOwnerbooleanWrite-onlyRequired
_linksobjectRead-onlyRequired
422
Returns an error
application/json
get/events/{eventId}/open-invitations/{openInvitationId}
GET /apis/v2/events/{eventId}/open-invitations/{openInvitationId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"id": "text",
"owner": {
"id": "text"
},
"visibility": "LISTED",
"chargeType": "FREE",
"type": "SHARE",
"sharingKey": "text",
"redeemUrl": "text",
"maxRedeems": 1,
"redeemsRemaining": 1,
"_links": {}
}get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
eventIdstringRequiredExample:
3857358a-59e8-4944-8c48-3345c4375b43Query parameters
includeCanceledbooleanOptionalExample:
Include canceled open invitations.
falseResponses
200
Returns an OpenInvitation
application/json
idstringRead-onlyRequired
visibilitystring · enumRequiredPossible values:
chargeTypestring · enum · nullableRequiredPossible values:
typestring · enum · nullableRequiredPossible values:
sharingKeystringRead-onlyRequired
redeemUrlstringRead-onlyRequired
maxRedeemsnumber · nullableRead-onlyRequired
The number of times the invitation can be redeemed. Includes the owner's redemption.
redeemsRemainingnumberRead-onlyRequired
onBehalfOfEventOwnerbooleanWrite-onlyRequired
_linksobjectRead-onlyRequired
422
Returns an error
application/json
get/events/{eventId}/open-invitations
GET /apis/v2/events/{eventId}/open-invitations HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"id": "text",
"owner": {
"id": "text"
},
"visibility": "LISTED",
"chargeType": "FREE",
"type": "SHARE",
"sharingKey": "text",
"redeemUrl": "text",
"maxRedeems": 1,
"redeemsRemaining": 1,
"_links": {}
}post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
eventIdstringRequiredExample:
3857358a-59e8-4944-8c48-3345c4375b43Body
idstringRead-onlyRequired
visibilitystring · enumRequiredPossible values:
chargeTypestring · enum · nullableRequiredPossible values:
typestring · enum · nullableRequiredPossible values:
sharingKeystringRead-onlyRequired
redeemUrlstringRead-onlyRequired
maxRedeemsnumber · nullableRead-onlyRequired
The number of times the invitation can be redeemed. Includes the owner's redemption.
redeemsRemainingnumberRead-onlyRequired
onBehalfOfEventOwnerbooleanWrite-onlyRequired
_linksobjectRead-onlyRequired
Responses
200
Returns an OpenInvitation
application/json
idstringRead-onlyRequired
visibilitystring · enumRequiredPossible values:
chargeTypestring · enum · nullableRequiredPossible values:
typestring · enum · nullableRequiredPossible values:
sharingKeystringRead-onlyRequired
redeemUrlstringRead-onlyRequired
maxRedeemsnumber · nullableRead-onlyRequired
The number of times the invitation can be redeemed. Includes the owner's redemption.
redeemsRemainingnumberRead-onlyRequired
onBehalfOfEventOwnerbooleanWrite-onlyRequired
_linksobjectRead-onlyRequired
422
Returns an error
application/json
post/events/{eventId}/open-invitations
POST /apis/v2/events/{eventId}/open-invitations HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 86
{
"visibility": "LISTED",
"chargeType": "FREE",
"type": "SHARE",
"onBehalfOfEventOwner": true
}{
"id": "text",
"owner": {
"id": "text"
},
"visibility": "LISTED",
"chargeType": "FREE",
"type": "SHARE",
"sharingKey": "text",
"redeemUrl": "text",
"maxRedeems": 1,
"redeemsRemaining": 1,
"_links": {}
}post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
openInvitationIdstringRequired
eventIdstringRequiredExample:
3857358a-59e8-4944-8c48-3345c4375b43Body
idstringRead-onlyRequired
recipientEmailstringRequired
Responses
200
Returns an OpenInvitationEmail
application/json
idstringRead-onlyRequired
recipientEmailstringRequired
422
Returns an error
application/json
post/events/{eventId}/open-invitations/{openInvitationId}/emails
POST /apis/v2/events/{eventId}/open-invitations/{openInvitationId}/emails HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 25
{
"recipientEmail": "text"
}{
"id": "text",
"recipientEmail": "text",
"openInvitation": {
"id": "text"
},
"_links": {
"self": {
"href": "text"
}
}
}post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
openInvitationIdstringRequired
eventIdstringRequiredExample:
3857358a-59e8-4944-8c48-3345c4375b43Body
idstringRead-onlyRequired
recipientPhoneNumberstringRequired
Responses
200
Returns an OpenInvitationSMS
application/json
idstringRead-onlyRequired
recipientPhoneNumberstringRequired
422
Returns an error
application/json
post/events/{eventId}/open-invitations/{openInvitationId}/smses
POST /apis/v2/events/{eventId}/open-invitations/{openInvitationId}/smses HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 31
{
"recipientPhoneNumber": "text"
}{
"id": "text",
"recipientPhoneNumber": "text",
"openInvitation": {
"id": "text"
},
"_links": {
"self": {
"href": "text"
}
}
}post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
eventIdstringRequiredExample:
3857358a-59e8-4944-8c48-3345c4375b43Body
typestring · enumRequiredPossible values:
statusstring · enumRequiredPossible values:
bookingTotalnumberRead-onlyRequired
eventRevenuenumberRead-onlyRequired
Pre-tax revenue (base for percentage coach calculations)
taxesTotalnumberRead-onlyRequired
Total taxes collected
signupsTotalnumberRead-onlyRequired
coachingTotalnumberRead-onlyRequired
virtualCreditsTotalnumberRead-onlyRequired
totalnumberRead-onlyRequired
currencystringRead-onlyRequired
_linksobjectRequired
Responses
201
Returns a EventSettlement
application/json
typestring · enumRequiredPossible values:
statusstring · enumRequiredPossible values:
bookingTotalnumberRead-onlyRequired
eventRevenuenumberRead-onlyRequired
Pre-tax revenue (base for percentage coach calculations)
taxesTotalnumberRead-onlyRequired
Total taxes collected
signupsTotalnumberRead-onlyRequired
coachingTotalnumberRead-onlyRequired
virtualCreditsTotalnumberRead-onlyRequired
totalnumberRead-onlyRequired
currencystringRead-onlyRequired
_linksobjectRequired
post/events/{eventId}/settlement
POST /apis/v2/events/{eventId}/settlement HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 49
{
"type": "PREVIEW",
"status": "PENDING",
"_links": {}
}201
Returns a EventSettlement
{
"type": "PREVIEW",
"status": "PENDING",
"bookingTotal": 1,
"eventRevenue": 1,
"taxesTotal": 1,
"signupsTotal": 1,
"coachingTotal": 1,
"virtualCreditsTotal": 1,
"total": 1,
"currency": "text",
"errors": [
{
"code": "text",
"message": "text",
"details": {}
}
],
"details": [
{
"items": [
{
"user": {
"id": "text",
"user": {
"id": "text"
},
"type": "REGULAR",
"firstName": "text",
"lastName": "text",
"gender": "text",
"birthday": "2026-01-01T00:00:00.000Z",
"initials": "text",
"description": "text",
"picture": {},
"usattRating": 1,
"duprProfileUrl": "text",
"memberSince": "2026-01-01T00:00:00.000Z",
"membershipEnrollment": {},
"kids": {},
"_links": {}
},
"total": 1,
"virtualCredits": 1,
"_links": {}
}
],
"_total": 1,
"_links": {
"self": {
"href": "text"
}
}
}
],
"coachingDetails": {
"items": [
{
"coach": {
"id": "text",
"user": {
"id": "text"
},
"type": "REGULAR",
"firstName": "text",
"lastName": "text",
"gender": "text",
"birthday": "2026-01-01T00:00:00.000Z",
"initials": "text",
"description": "text",
"picture": {},
"usattRating": 1,
"duprProfileUrl": "text",
"memberSince": "2026-01-01T00:00:00.000Z",
"membershipEnrollment": {},
"kids": {},
"_links": {}
},
"rateType": "FIXED",
"rate": 1,
"amount": 1,
"order": {
"id": "text"
}
}
],
"_total": 1
},
"messages": [
{
"code": "text",
"message": "text"
}
],
"_links": {}
}get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
eventIdstringRequiredExample:
3857358a-59e8-4944-8c48-3345c4375b43Responses
200
Returns a PaymentCollection
application/json
_totalnumberRequired
get/events/{eventId}/payments
GET /apis/v2/events/{eventId}/payments HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200
Returns a PaymentCollection
[
{
"items": [
{
"id": "text",
"type": "CASH",
"stripe": {
"id": "text",
"paymentId": "text",
"failureCode": "text",
"failureMessage": "text",
"createdAt": "2026-01-01T00:00:00.000Z",
"amount": 1,
"description": "text",
"statementDescriptor": "text",
"status": "text",
"outcome": {
"status": "text",
"networkStatus": "text",
"reason": "text",
"riskLevel": "text",
"sellerMessage": "text",
"type": "text"
},
"card": {
"id": "text",
"status": "text",
"stripe": {
"paymentMethodId": "text"
},
"brand": "text",
"numberPreview": "text",
"expirationMonth": 1,
"expirationYear": 1,
"funding": "text",
"_links": {
"self": {
"href": "text"
}
}
},
"bankAccount": {
"id": "text",
"bankName": "text",
"accountHolderType": "text",
"last4": "text"
},
"paymentElement": {
"id": "text"
},
"_links": {}
},
"currency": "text",
"authorizedAmount": 1,
"capturedAmount": 1,
"refundAmount": 1,
"refundVirtualCredits": 1,
"status": "CAPTURED",
"createdDate": "2026-01-01T00:00:00.000Z",
"captureDate": "2026-01-01T00:00:00.000Z",
"user": {
"id": "text"
},
"_links": {}
}
],
"_total": 1,
"_links": {
"self": {
"href": "text"
}
}
}
]get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
eventIdstringRequiredExample:
3857358a-59e8-4944-8c48-3345c4375b43Responses
200
Returns a EventStats
application/json
idstringRequired
_linksobjectRequired
get/events/{eventId}/stats
GET /apis/v2/events/{eventId}/stats HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200
Returns a EventStats
{
"id": "text",
"tags": [
"FIRST_USER_BOOKED_EVENT"
],
"revenue": {
"id": "text"
},
"_links": {}
}get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
eventIdstringRequiredExample:
3857358a-59e8-4944-8c48-3345c4375b43Responses
200
Returns a EventStatsRevenue
application/json
couponCodestring · nullableRequired
_linksobjectRequired
get/events/{eventId}/stats/revenue
GET /apis/v2/events/{eventId}/stats/revenue HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200
Returns a EventStatsRevenue
{
"couponCode": "text",
"bookingProceeds": {
"subtotal": 1,
"virtualCredits": 1,
"cash": 1,
"discount": 1,
"total": 1
},
"eventSignupProceeds": {
"subtotal": 1,
"virtualCredits": 1,
"cash": 1,
"discount": 1,
"total": 1
},
"purchasesProceeds": {
"subtotal": 1,
"virtualCredits": 1,
"cash": 1,
"discount": 1,
"total": 1
},
"totalProceeds": {
"subtotal": 1,
"virtualCredits": 1,
"cash": 1,
"discount": 1,
"total": 1
},
"orderItems": {
"id": "text"
},
"_links": {}
}get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
eventIdstringRequiredExample:
3857358a-59e8-4944-8c48-3345c4375b43Responses
200
Returns a OrderItemCollection
application/json
_totalnumberRequired
get/events/{eventId}/stats/revenue/items
GET /apis/v2/events/{eventId}/stats/revenue/items HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200
Returns a OrderItemCollection
[
{
"items": [
{
"id": "text",
"type": "BOOKING",
"name": "text",
"description": "text",
"quantity": 1,
"price": 1,
"subtotal": 1,
"tax": 1,
"fee": 1,
"discount": 1,
"virtualCredits": 1,
"total": 1,
"productOffering": {
"id": "text"
},
"posProductOffering": {
"id": "text"
},
"product": {
"id": "text"
},
"event": {
"id": "text"
},
"replay": {
"id": "text"
}
}
],
"_total": 1,
"_links": {
"self": {
"href": "text"
}
}
}
]get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
eventIdstringRequiredExample:
65d283a0-3a78-4792-8e0d-6499c5f1bd29Query parameters
expandstring[]Optional
Responses
200
Returns a EventReplayCollection
application/json
_totalnumberRequired
get/events/{eventId}/replays
GET /apis/v2/events/{eventId}/replays HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200
Returns a EventReplayCollection
{
"items": [
{
"id": "text",
"type": "QUICK_REPLAY",
"actionType": "PREVIEW",
"chargeStrategy": "CHARGE_CUSTOMER_FULL",
"status": "ORDERED",
"table": {
"id": "text"
},
"startTime": "2026-01-01T00:00:00.000Z",
"endTime": "2026-01-01T00:00:00.000Z",
"lengthMilliseconds": 1,
"video": {
"low": {
"href": "text"
},
"medium": {
"href": "text"
},
"high": {
"href": "text"
},
"web": {
"href": "text"
},
"hls": {
"href": "text"
}
},
"preview": {
"id": "text",
"small": {
"href": "text"
},
"medium": {
"href": "text"
},
"large": {
"href": "text"
},
"_links": {
"self": {
"href": "text"
}
}
},
"likes": {},
"enhancedVideoUrl": "text",
"flags": [
"AUTO_ENHANCE"
],
"summary": {
"currency": "text",
"subtotal": 1,
"taxes": [
{
"name": "text",
"amount": 1,
"percentage": 1
}
],
"total": 1,
"chargeOptions": [
{
"id": "CHARGE_CUSTOMER_FULL",
"label": "text",
"pricing": {
"subtotal": 1,
"taxes": [
{
"name": "text",
"amount": 1,
"percentage": 1
}
],
"total": 1
}
}
],
"errors": [
{
"code": "text",
"message": "text",
"details": {}
}
],
"messages": [
{
"code": "text",
"message": "text"
}
]
},
"user": {
"id": "text"
},
"_links": {}
}
],
"_total": 1,
"_links": {
"self": {
"href": "text"
}
}
}post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
eventIdstringRequiredExample:
65d283a0-3a78-4792-8e0d-6499c5f1bd29Query parameters
expandstring[]Optional
Body
idstringRead-onlyRequired
typestring · enumRequiredPossible values:
actionTypestring · enumOptionalPossible values:
Action type: PREVIEW to simulate order, ORDER to create
paymentModestring · enumWrite-onlyOptionalPossible values:
Payment mode: PAID (default) or FREE_OF_CHARGE. FREE_OF_CHARGE is only available for admins/managers/staff from the dashboard.
chargeStrategystring · enumOptionalPossible values:
Charge strategy for enhanced replays (admin only). Determines how costs are split between customer and club.
statusstring · enumRead-onlyRequiredPossible values:
startTimestring · date-timeRequired
endTimestring · date-timeRequired
lengthMillisecondsnumberRead-onlyRequired
likesobjectRead-onlyRequired
enhancedVideoUrlstringRead-onlyRequired
URL to the AI-enhanced analysis page
flagsstring[]Read-onlyRequiredExample:
Feature flags for this replay (e.g. "AUTO_ENHANCE")
["AUTO_ENHANCE"]_linksobjectRead-onlyRequired
Responses
201
Returns a EventReplay
application/json
idstringRead-onlyRequired
typestring · enumRequiredPossible values:
actionTypestring · enumOptionalPossible values:
Action type: PREVIEW to simulate order, ORDER to create
paymentModestring · enumWrite-onlyOptionalPossible values:
Payment mode: PAID (default) or FREE_OF_CHARGE. FREE_OF_CHARGE is only available for admins/managers/staff from the dashboard.
chargeStrategystring · enumOptionalPossible values:
Charge strategy for enhanced replays (admin only). Determines how costs are split between customer and club.
statusstring · enumRead-onlyRequiredPossible values:
startTimestring · date-timeRequired
endTimestring · date-timeRequired
lengthMillisecondsnumberRead-onlyRequired
likesobjectRead-onlyRequired
enhancedVideoUrlstringRead-onlyRequired
URL to the AI-enhanced analysis page
flagsstring[]Read-onlyRequiredExample:
Feature flags for this replay (e.g. "AUTO_ENHANCE")
["AUTO_ENHANCE"]_linksobjectRead-onlyRequired
post/events/{eventId}/replays
POST /apis/v2/events/{eventId}/replays HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 233
{
"type": "QUICK_REPLAY",
"actionType": "PREVIEW",
"paymentMode": "PAID",
"chargeStrategy": "CHARGE_CUSTOMER_FULL",
"billingUser": {
"id": "text"
},
"table": {
"id": "text"
},
"startTime": "2026-01-01T00:00:00.000Z",
"endTime": "2026-01-01T00:00:00.000Z"
}201
Returns a EventReplay
{
"id": "text",
"type": "QUICK_REPLAY",
"actionType": "PREVIEW",
"chargeStrategy": "CHARGE_CUSTOMER_FULL",
"status": "ORDERED",
"table": {
"id": "text"
},
"startTime": "2026-01-01T00:00:00.000Z",
"endTime": "2026-01-01T00:00:00.000Z",
"lengthMilliseconds": 1,
"video": {
"low": {
"href": "text"
},
"medium": {
"href": "text"
},
"high": {
"href": "text"
},
"web": {
"href": "text"
},
"hls": {
"href": "text"
}
},
"preview": {
"id": "text",
"small": {
"href": "text"
},
"medium": {
"href": "text"
},
"large": {
"href": "text"
},
"_links": {
"self": {
"href": "text"
}
}
},
"likes": {},
"enhancedVideoUrl": "text",
"flags": [
"AUTO_ENHANCE"
],
"summary": {
"currency": "text",
"subtotal": 1,
"taxes": [
{
"name": "text",
"amount": 1,
"percentage": 1
}
],
"total": 1,
"chargeOptions": [
{
"id": "CHARGE_CUSTOMER_FULL",
"label": "text",
"pricing": {
"subtotal": 1,
"taxes": [
{
"name": "text",
"amount": 1,
"percentage": 1
}
],
"total": 1
}
}
],
"errors": [
{
"code": "text",
"message": "text",
"details": {}
}
],
"messages": [
{
"code": "text",
"message": "text"
}
]
},
"user": {
"id": "text"
},
"_links": {}
}get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
replayIdstringRequiredExample:
mj8LMDK7DUMRUxldfQPW6yHCUW2ToJV3VUHQwaL1i2MeventIdstringRequiredExample:
65d283a0-3a78-4792-8e0d-6499c5f1bd29Query parameters
expandstring[]Optional
Responses
200
Returns a EventReplay
application/json
idstringRead-onlyRequired
typestring · enumRequiredPossible values:
actionTypestring · enumOptionalPossible values:
Action type: PREVIEW to simulate order, ORDER to create
paymentModestring · enumWrite-onlyOptionalPossible values:
Payment mode: PAID (default) or FREE_OF_CHARGE. FREE_OF_CHARGE is only available for admins/managers/staff from the dashboard.
chargeStrategystring · enumOptionalPossible values:
Charge strategy for enhanced replays (admin only). Determines how costs are split between customer and club.
statusstring · enumRead-onlyRequiredPossible values:
startTimestring · date-timeRequired
endTimestring · date-timeRequired
lengthMillisecondsnumberRead-onlyRequired
likesobjectRead-onlyRequired
enhancedVideoUrlstringRead-onlyRequired
URL to the AI-enhanced analysis page
flagsstring[]Read-onlyRequiredExample:
Feature flags for this replay (e.g. "AUTO_ENHANCE")
["AUTO_ENHANCE"]_linksobjectRead-onlyRequired
get/events/{eventId}/replays/{replayId}
GET /apis/v2/events/{eventId}/replays/{replayId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200
Returns a EventReplay
{
"id": "text",
"type": "QUICK_REPLAY",
"actionType": "PREVIEW",
"chargeStrategy": "CHARGE_CUSTOMER_FULL",
"status": "ORDERED",
"table": {
"id": "text"
},
"startTime": "2026-01-01T00:00:00.000Z",
"endTime": "2026-01-01T00:00:00.000Z",
"lengthMilliseconds": 1,
"video": {
"low": {
"href": "text"
},
"medium": {
"href": "text"
},
"high": {
"href": "text"
},
"web": {
"href": "text"
},
"hls": {
"href": "text"
}
},
"preview": {
"id": "text",
"small": {
"href": "text"
},
"medium": {
"href": "text"
},
"large": {
"href": "text"
},
"_links": {
"self": {
"href": "text"
}
}
},
"likes": {},
"enhancedVideoUrl": "text",
"flags": [
"AUTO_ENHANCE"
],
"summary": {
"currency": "text",
"subtotal": 1,
"taxes": [
{
"name": "text",
"amount": 1,
"percentage": 1
}
],
"total": 1,
"chargeOptions": [
{
"id": "CHARGE_CUSTOMER_FULL",
"label": "text",
"pricing": {
"subtotal": 1,
"taxes": [
{
"name": "text",
"amount": 1,
"percentage": 1
}
],
"total": 1
}
}
],
"errors": [
{
"code": "text",
"message": "text",
"details": {}
}
],
"messages": [
{
"code": "text",
"message": "text"
}
]
},
"user": {
"id": "text"
},
"_links": {}
}post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
replayIdstringRequiredExample:
mj8LMDK7DUMRUxldfQPW6yHCUW2ToJV3VUHQwaL1i2MeventIdstringRequiredExample:
65d283a0-3a78-4792-8e0d-6499c5f1bd29Responses
200
Returns a EventReplay
application/json
idstringRead-onlyRequired
typestring · enumRequiredPossible values:
actionTypestring · enumOptionalPossible values:
Action type: PREVIEW to simulate order, ORDER to create
paymentModestring · enumWrite-onlyOptionalPossible values:
Payment mode: PAID (default) or FREE_OF_CHARGE. FREE_OF_CHARGE is only available for admins/managers/staff from the dashboard.
chargeStrategystring · enumOptionalPossible values:
Charge strategy for enhanced replays (admin only). Determines how costs are split between customer and club.
statusstring · enumRead-onlyRequiredPossible values:
startTimestring · date-timeRequired
endTimestring · date-timeRequired
lengthMillisecondsnumberRead-onlyRequired
likesobjectRead-onlyRequired
enhancedVideoUrlstringRead-onlyRequired
URL to the AI-enhanced analysis page
flagsstring[]Read-onlyRequiredExample:
Feature flags for this replay (e.g. "AUTO_ENHANCE")
["AUTO_ENHANCE"]_linksobjectRead-onlyRequired
post/events/{eventId}/replays/{replayId}/retries
POST /apis/v2/events/{eventId}/replays/{replayId}/retries HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200
Returns a EventReplay
{
"id": "text",
"type": "QUICK_REPLAY",
"actionType": "PREVIEW",
"chargeStrategy": "CHARGE_CUSTOMER_FULL",
"status": "ORDERED",
"table": {
"id": "text"
},
"startTime": "2026-01-01T00:00:00.000Z",
"endTime": "2026-01-01T00:00:00.000Z",
"lengthMilliseconds": 1,
"video": {
"low": {
"href": "text"
},
"medium": {
"href": "text"
},
"high": {
"href": "text"
},
"web": {
"href": "text"
},
"hls": {
"href": "text"
}
},
"preview": {
"id": "text",
"small": {
"href": "text"
},
"medium": {
"href": "text"
},
"large": {
"href": "text"
},
"_links": {
"self": {
"href": "text"
}
}
},
"likes": {},
"enhancedVideoUrl": "text",
"flags": [
"AUTO_ENHANCE"
],
"summary": {
"currency": "text",
"subtotal": 1,
"taxes": [
{
"name": "text",
"amount": 1,
"percentage": 1
}
],
"total": 1,
"chargeOptions": [
{
"id": "CHARGE_CUSTOMER_FULL",
"label": "text",
"pricing": {
"subtotal": 1,
"taxes": [
{
"name": "text",
"amount": 1,
"percentage": 1
}
],
"total": 1
}
}
],
"errors": [
{
"code": "text",
"message": "text",
"details": {}
}
],
"messages": [
{
"code": "text",
"message": "text"
}
]
},
"user": {
"id": "text"
},
"_links": {}
}get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
replayIdstringRequiredExample:
mj8LMDK7DUMRUxldfQPW6yHCUW2ToJV3VUHQwaL1i2MeventIdstringRequiredExample:
65d283a0-3a78-4792-8e0d-6499c5f1bd29Query parameters
expandstring[]Optional
Responses
200
Returns a LikeCollection
application/json
_totalnumberRequired
get/events/{eventId}/replays/{replayId}/likes
GET /apis/v2/events/{eventId}/replays/{replayId}/likes HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200
Returns a LikeCollection
{
"items": [
{
"id": "text",
"createdAt": "2026-01-01T00:00:00.000Z",
"user": {},
"_links": {}
}
],
"_total": 1,
"_links": {
"self": {
"href": "text"
}
}
}post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
replayIdstringRequiredExample:
mj8LMDK7DUMRUxldfQPW6yHCUW2ToJV3VUHQwaL1i2MeventIdstringRequiredExample:
65d283a0-3a78-4792-8e0d-6499c5f1bd29Query parameters
expandstring[]Optional
Responses
200
Returns a Like
application/json
idstringRequired
createdAtstring · date-timeRequired
userobjectRequired
_linksobjectRequired
post/events/{eventId}/replays/{replayId}/likes
POST /apis/v2/events/{eventId}/replays/{replayId}/likes HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200
Returns a Like
{
"id": "text",
"createdAt": "2026-01-01T00:00:00.000Z",
"user": {},
"_links": {}
}get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
likeIdstringRequired
replayIdstringRequiredExample:
mj8LMDK7DUMRUxldfQPW6yHCUW2ToJV3VUHQwaL1i2MeventIdstringRequiredExample:
65d283a0-3a78-4792-8e0d-6499c5f1bd29Query parameters
expandstring[]Optional
Responses
200
Returns a Like
application/json
idstringRequired
createdAtstring · date-timeRequired
userobjectRequired
_linksobjectRequired
get/events/{eventId}/replays/{replayId}/likes/{likeId}
GET /apis/v2/events/{eventId}/replays/{replayId}/likes/{likeId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200
Returns a Like
{
"id": "text",
"createdAt": "2026-01-01T00:00:00.000Z",
"user": {},
"_links": {}
}delete
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
likeIdstringRequired
replayIdstringRequiredExample:
mj8LMDK7DUMRUxldfQPW6yHCUW2ToJV3VUHQwaL1i2MeventIdstringRequiredExample:
65d283a0-3a78-4792-8e0d-6499c5f1bd29Responses
200
Returns the deleted Like
application/json
idstringRequired
createdAtstring · date-timeRequired
userobjectRequired
_linksobjectRequired
delete/events/{eventId}/replays/{replayId}/likes/{likeId}
DELETE /apis/v2/events/{eventId}/replays/{replayId}/likes/{likeId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200
Returns the deleted Like
{
"id": "text",
"createdAt": "2026-01-01T00:00:00.000Z",
"user": {},
"_links": {}
}get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
eventIdstringRequiredExample:
3857358a-59e8-4944-8c48-3345c4375b43Query parameters
expandstring[]OptionalExample:
["items._links.bookedBy","items._links.pod","items._links.table"]Responses
200
Returns a ReservationCollection
application/json
_totalnumberRequired
get/events/{eventId}/reservations
GET /apis/v2/events/{eventId}/reservations HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200
Returns a ReservationCollection
{
"items": [
{
"id": "text",
"startTime": "2026-01-01T00:00:00.000Z",
"endTime": "2026-01-01T00:00:00.000Z",
"tableAssignment": "PENDING",
"sessions": {
"items": [
{
"id": "text",
"session": {
"id": "text"
},
"coupon": {
"id": "text"
},
"charge": {
"id": "text"
},
"_links": {}
}
],
"_total": 1,
"_links": {
"self": {
"href": "text"
}
}
},
"pod": {
"id": "text"
},
"table": {
"id": "text"
},
"coach": {
"id": "text"
},
"guests": 1,
"charges": {
"_total": 1
},
"quickReplays": {
"_total": 1
},
"customReplays": {
"_total": 1
},
"_links": {}
}
],
"_total": 1,
"_links": {
"self": {
"href": "text"
}
}
}get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
reservationIdstringRequiredExample:
3857358a-59e8-4944-8c48-3345c4375b43eventIdstringRequiredExample:
3857358a-59e8-4944-8c48-3345c4375b43Query parameters
expandstring[]OptionalExample:
["_links.sessions.items._links.session","_links.bookedBy","_links.pod","_links.table","_links.coach"]Responses
200
Returns a Reservation
application/json
idstringRequired
startTimestring · date-timeRequired
endTimestring · date-timeRequired
tableAssignmentstring · enumRequiredPossible values:
guestsnumber · nullableRequired
_linksobjectRequired
get/events/{eventId}/reservations/{reservationId}
GET /apis/v2/events/{eventId}/reservations/{reservationId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200
Returns a Reservation
{
"id": "text",
"startTime": "2026-01-01T00:00:00.000Z",
"endTime": "2026-01-01T00:00:00.000Z",
"tableAssignment": "PENDING",
"sessions": {
"items": [
{
"id": "text",
"session": {
"id": "text"
},
"coupon": {
"id": "text"
},
"charge": {
"id": "text"
},
"_links": {}
}
],
"_total": 1,
"_links": {
"self": {
"href": "text"
}
}
},
"pod": {
"id": "text"
},
"table": {
"id": "text"
},
"coach": {
"id": "text"
},
"guests": 1,
"charges": {
"_total": 1
},
"quickReplays": {
"_total": 1
},
"customReplays": {
"_total": 1
},
"_links": {}
}get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
reservationIdstringRequiredExample:
3857358a-59e8-4944-8c48-3345c4375b43eventIdstringRequiredExample:
3857358a-59e8-4944-8c48-3345c4375b43Query parameters
expandstring[]Optional
Responses
200
Returns a ReservationSessionCollection
application/json
_totalnumberRequired
get/events/{eventId}/reservations/{reservationId}/sessions
GET /apis/v2/events/{eventId}/reservations/{reservationId}/sessions HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200
Returns a ReservationSessionCollection
{
"items": [
{
"id": "text",
"session": {
"id": "text"
},
"coupon": {
"id": "text"
},
"charge": {
"id": "text"
},
"_links": {}
}
],
"_total": 1,
"_links": {
"self": {
"href": "text"
}
}
}get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
startTimestring · date-timeOptionalExample:
If not set, startTime will be defaulted as now
2021-11-01T00:00:00ZendTimestring · date-timeOptionalExample:
If not set, the response will include up to 30 days since startTime
2021-11-03T00:00:00ZselfOnlybooleanOptionalExample:
Return only the events relevant to the logged in user. Only useful to privileged users.
falseuserIdstringOptional
Return only the events related to a specific user, based con current permissions.
excludeUnlistedbooleanOptionalExample:
Exclude unlisted events, typically the ones the user owns or is invited to.
falseexcludeListedbooleanOptionalExample:
Exclude listed events, those that the user hasn't signed up for.
falseincludeSuspendedbooleanOptionalExample:
Include suspended events, those that were canceled by an admin due to an exceptional situation made their physical court to not be available.
falseincludeCanceledInvitationsbooleanOptionalExample:
Include canceled invitations, by default this is set to true.
trueincludePendingbooleanOptionalExample:
Include events that were not yet accepted by the user.
falseincludeCanceledbooleanOptionalExample:
Include canceled events.
trueexcludeClosedSeriesbooleanOptionalExample:
Retrieve series beyond their signup limit date
truepagenumberOptionalExample:
1ippnumberOptionalExample:
30expandstring[]OptionalExample:
["items._links.reservations","items._links.bookedBy","items._links.invitations","items._links.waitlist","items._links.teams"]sortstringOptionalExample:
If not set, sort will be defaulted as startTime (ASC)
-startTimetagstring[]Optional
Return only the events matching a set of tags.
customTypestring[]Optional
Return only the events matching a customType or a set of customTypes.
tableIdstring[]OptionalExample:
["40-allen-1","42-allen-1"]podIdstring[]OptionalExample:
["40-allen","42-allen"]areaIdstring[]OptionalExample:
["les","w37"]regionIdstring[]OptionalExample:
["new-york"]Responses
200
Returns a EventPaginatedCollection
application/json
_totalnumberRequiredDeprecated
get/events
GET /apis/v2/events HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200
Returns a EventPaginatedCollection
{
"items": [
{
"id": "text",
"type": "REGULAR",
"subtype": "OPERATIONS",
"customType": "text",
"name": "text",
"description": "text",
"startTime": "2026-01-01T00:00:00.000Z",
"endTime": "2026-01-01T00:00:00.000Z",
"pods": {
"items": [
{
"id": "text",
"slug": "text",
"displayName": "text",
"displayNameShort": "text",
"description": "text",
"address": {
"street": "text",
"floor": "text",
"city": "text",
"zip": "text",
"displayName": "text"
},
"timezone": "text",
"type": "PRIVATE",
"status": "NOT_AVAILABLE",
"sport": "PICKLEBALL",
"area": {},
"tables": {
"items": [
{
"id": "text",
"slug": "text",
"displayName": "text",
"displayNameShort": "text",
"description": "text",
"type": "STANDARD",
"status": "AVAILABLE",
"features": [
"REPLAYS"
],
"pod": {},
"settings": {
"items": [
{
"id": "text",
"value": {}
}
],
"_total": 1,
"_links": {
"self": {
"href": "text"
}
}
},
"errors": [
{
"code": "text",
"message": "text",
"details": {}
}
],
"_links": {}
}
],
"_total": 1,
"_links": {
"self": {
"href": "text"
}
}
},
"openTime": {
"hours": 1,
"minutes": 1
},
"closeTime": {
"hours": 1,
"minutes": 1
},
"closedTimeOverrides": {
"items": [
{
"id": "text",
"days": [
1
],
"from": {
"hours": 1,
"minutes": 1
},
"to": {
"hours": 1,
"minutes": 1
}
}
],
"_total": 1,
"_links": {
"self": {
"href": "text"
}
}
},
"guests": {
"private": {
"min": "text",
"max": "text"
}
},
"rates": {},
"settings": {
"items": [
{
"id": "text",
"value": {}
}
],
"_total": 1,
"_links": {
"self": {
"href": "text"
}
}
},
"errors": [
{
"code": "text",
"message": "text",
"details": {}
}
],
"_links": {}
}
],
"_total": 1,
"_links": {
"self": {
"href": "text"
}
}
},
"tables": {
"items": [
{
"id": "text",
"type": "FIXED_TABLE",
"table": {
"id": "text"
},
"startTime": "2026-01-01T00:00:00.000Z",
"endTime": "2026-01-01T00:00:00.000Z",
"features": [
"REPLAYS"
],
"status": "INVALID",
"errors": [
{
"code": "text",
"message": "text",
"details": {}
}
],
"_links": {
"self": {
"href": "text"
}
}
}
],
"_total": 1,
"_links": {
"self": {
"href": "text"
}
}
},
"access": {
"id": "text",
"type": "OPEN",
"startTime": "2026-01-01T00:00:00.000Z",
"endTime": "2026-01-01T00:00:00.000Z"
},
"guests": {
"displayName": "text",
"displayNameShort": "text",
"max": 1
},
"reservations": {
"items": [
{
"id": "text",
"startTime": "2026-01-01T00:00:00.000Z",
"endTime": "2026-01-01T00:00:00.000Z",
"tableAssignment": "PENDING",
"sessions": {
"items": [
{
"id": "text",
"session": {
"id": "text"
},
"coupon": {
"id": "text"
},
"charge": {
"id": "text"
},
"_links": {}
}
],
"_total": 1,
"_links": {
"self": {
"href": "text"
}
}
},
"pod": {
"id": "text"
},
"table": {
"id": "text"
},
"coach": {
"id": "text"
},
"guests": 1,
"charges": {
"_total": 1
},
"quickReplays": {
"_total": 1
},
"customReplays": {
"_total": 1
},
"_links": {}
}
],
"_total": 1,
"_links": {
"self": {
"href": "text"
}
}
},
"bookingMode": "USER_BOOKED",
"paymentMethod": "CASH",
"bookedBy": {
"id": "text"
},
"totalTeams": 1,
"teamSize": 1,
"admission": "OPEN",
"admissionRating": {
"minRating": 1,
"maxRating": 1,
"type": "SINGLES"
},
"admissionRate": {
"regular": 1,
"member": 1,
"membersDefault": 1,
"dayPass": {
"id": "text",
"displayName": "text",
"rate": 1
},
"memberships": {
"items": [
{
"membership": {
"id": "text"
},
"rate": 1
}
],
"_total": 1,
"_links": {
"self": {
"href": "text"
}
}
},
"chargingStrategy": "spot+",
"_links": {}
},
"admissionDate": {
"regular": "2026-01-01T00:00:00.000Z",
"member": "2026-01-01T00:00:00.000Z",
"membersDefault": "2026-01-01T00:00:00.000Z",
"memberships": {
"items": [
{
"membership": {
"id": "text"
},
"date": "2026-01-01T00:00:00.000Z"
}
],
"_total": 1,
"_links": {
"self": {
"href": "text"
}
}
},
"_links": {}
},
"admissionKids": "OPEN",
"allowedMemberships": {},
"coachRate": 1,
"freeSignupCancellationHorizonHours": 1,
"tags": [
"text"
],
"picture": {
"id": "text"
},
"visibility": "LISTED",
"invitations": {},
"payments": {},
"replays": {},
"cancellation": {},
"notes": {},
"openInvitations": {},
"signups": {},
"waitlist": {},
"features": [
"WAITLIST"
],
"stats": {},
"series": {
"id": "text"
},
"suspension": {
"id": "text"
},
"status": "INVALID",
"errors": [
{
"code": "text",
"message": "text",
"details": {}
}
],
"tournamentDivision": {
"id": "7229d7d5-5581-4d86-975f-5b7efc9b00e9",
"tournament": "7229d7d5-5581-4d86-975f-5b7efc9b00e9",
"provider": "SWISH",
"swish": {
"eventFormat": "rotating_partners_round_robin",
"gameId": "game123",
"editPlayersPath": "rotating-partners-round-robin"
},
"podplay": {
"eventFormat": "round_robin",
"gameId": "game123",
"url": "https://tournaments.podplay.app/admin/tournaments/game123"
},
"status": "DRAFT",
"createdAt": "2025-07-09T17:32:26.800Z",
"event": "7229d7d5-5581-4d86-975f-5b7efc9b00e9",
"lastSyncedAt": "2025-07-09T17:32:26.800Z",
"visibility": "VISIBLE",
"_links": {}
},
"visibilitySchedules": {
"items": [
{
"id": "text",
"event": {
"id": "text"
},
"listDaysBefore": 1,
"membersOnly": true,
"executed": true,
"status": "INVALID",
"errors": [
{
"code": "text",
"message": "text",
"details": {}
}
],
"_links": {}
}
],
"_total": 1,
"_links": {
"self": {
"href": "text"
}
}
},
"recurrence": {
"id": "text"
},
"teams": {
"items": [
{
"id": "text",
"_links": {
"self": {
"href": "text"
}
},
"teamLeader": {
"id": "text",
"user": {
"id": "text"
},
"type": "REGULAR",
"firstName": "text",
"lastName": "text",
"gender": "text",
"birthday": "2026-01-01T00:00:00.000Z",
"initials": "text",
"description": "text",
"picture": {},
"usattRating": 1,
"duprProfileUrl": "text",
"memberSince": "2026-01-01T00:00:00.000Z",
"membershipEnrollment": {},
"kids": {},
"_links": {}
},
"teamMembers": {
"items": [
{
"id": "text",
"user": {
"id": "text"
},
"type": "REGULAR",
"firstName": "text",
"lastName": "text",
"gender": "text",
"birthday": "2026-01-01T00:00:00.000Z",
"initials": "text",
"description": "text",
"picture": {},
"usattRating": 1,
"duprProfileUrl": "text",
"memberSince": "2026-01-01T00:00:00.000Z",
"membershipEnrollment": {},
"kids": {},
"_links": {}
}
],
"_total": 1,
"_links": {
"self": {
"href": "text"
}
}
},
"teamMemberCount": 1
}
],
"_total": 1,
"_links": {
"self": {
"href": "text"
}
}
},
"_links": {}
}
],
"_pagination": {
"page": 1,
"ipp": 1,
"count": 1,
"total": 1
},
"_links": {
"self": {
"href": "text"
}
}
}get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
expandstring[]OptionalExample:
["items._links.event"]Responses
200
Returns a EventInvitationCollection
application/json
_totalnumberRequired
get/events/invitations
GET /apis/v2/events/invitations HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200
Returns a EventInvitationCollection
{
"items": [
{
"id": "text",
"event": {
"id": "text"
},
"invitation": {
"id": "text"
},
"messages": [
{
"code": "text",
"message": "text"
}
],
"_links": {}
}
],
"_total": 1,
"_links": {
"self": {
"href": "text"
}
}
}post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
expandstring[]OptionalExample:
["_links.event"]Body
sharingKeystringWrite-onlyRequired
redeemUrlstringWrite-onlyRequired
Responses
201
Returns an EventInvitation
application/json
idstringRequired
_linksobjectRequired
422
Returns an error
application/json
post/events/invitations
POST /apis/v2/events/invitations HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 62
{
"sharingKey": "text",
"redeemUrl": "text",
"owner": {
"id": "text"
}
}{
"id": "text",
"event": {
"id": "text"
},
"invitation": {
"id": "text"
},
"messages": [
{
"code": "text",
"message": "text"
}
],
"_links": {}
}get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
eventIdstringRequiredExample:
3857358a-59e8-4944-8c48-3345c4375b43Query parameters
includeCanceledSignupsbooleanOptionalExample:
Include canceled signups.
falseexpandstring[]OptionalExample:
["_links.reservations","_links.bookedBy","_links.invitations"]Responses
200
Returns a Reservation
application/json
idstringRequired
typestring · enumRead-onlyRequiredPossible values:
subtypestring · enumRequiredPossible values:
customTypestringRequired
namestringRequired
descriptionstringRequired
startTimestring · date-timeRequired
endTimestring · date-timeRequired
bookingModestring · enumRead-onlyRequiredPossible values:
paymentMethodstring · enumRead-onlyRequiredPossible values:
totalTeamsnumberRequired
teamSizenumberRequired
admissionstring · enumRequiredPossible values:
admissionKidsstring · enumRequiredPossible values:
allowedMembershipsobjectRequired
coachRatenumberRequired
freeSignupCancellationHorizonHoursnumberRequired
tagsstring[]Required
visibilitystring · enumRequiredPossible values:
invitationsobjectRequired
paymentsobjectRequired
completeInvitationsinteger · max: 10RequiredDeprecated
replaysobjectRequired
cancellationobjectRequired
notesobjectRequired
openInvitationsobjectRequired
signupsobjectRequired
waitlistobjectRequired
statsobjectRequired
statusstring · enumRequiredPossible values:
_linksobjectRequired
get/events/{eventId}
GET /apis/v2/events/{eventId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200
Returns a Reservation
{
"id": "text",
"type": "REGULAR",
"subtype": "OPERATIONS",
"customType": "text",
"name": "text",
"description": "text",
"startTime": "2026-01-01T00:00:00.000Z",
"endTime": "2026-01-01T00:00:00.000Z",
"pods": {
"items": [
{
"id": "text",
"slug": "text",
"displayName": "text",
"displayNameShort": "text",
"description": "text",
"address": {
"street": "text",
"floor": "text",
"city": "text",
"zip": "text",
"displayName": "text"
},
"timezone": "text",
"type": "PRIVATE",
"status": "NOT_AVAILABLE",
"sport": "PICKLEBALL",
"area": {},
"tables": {
"items": [
{
"id": "text",
"slug": "text",
"displayName": "text",
"displayNameShort": "text",
"description": "text",
"type": "STANDARD",
"status": "AVAILABLE",
"features": [
"REPLAYS"
],
"pod": {},
"settings": {
"items": [
{
"id": "text",
"value": {}
}
],
"_total": 1,
"_links": {
"self": {
"href": "text"
}
}
},
"errors": [
{
"code": "text",
"message": "text",
"details": {}
}
],
"_links": {}
}
],
"_total": 1,
"_links": {
"self": {
"href": "text"
}
}
},
"openTime": {
"hours": 1,
"minutes": 1
},
"closeTime": {
"hours": 1,
"minutes": 1
},
"closedTimeOverrides": {
"items": [
{
"id": "text",
"days": [
1
],
"from": {
"hours": 1,
"minutes": 1
},
"to": {
"hours": 1,
"minutes": 1
}
}
],
"_total": 1,
"_links": {
"self": {
"href": "text"
}
}
},
"guests": {
"private": {
"min": "text",
"max": "text"
}
},
"rates": {},
"settings": {
"items": [
{
"id": "text",
"value": {}
}
],
"_total": 1,
"_links": {
"self": {
"href": "text"
}
}
},
"errors": [
{
"code": "text",
"message": "text",
"details": {}
}
],
"_links": {}
}
],
"_total": 1,
"_links": {
"self": {
"href": "text"
}
}
},
"tables": {
"items": [
{
"id": "text",
"type": "FIXED_TABLE",
"table": {
"id": "text"
},
"startTime": "2026-01-01T00:00:00.000Z",
"endTime": "2026-01-01T00:00:00.000Z",
"features": [
"REPLAYS"
],
"status": "INVALID",
"errors": [
{
"code": "text",
"message": "text",
"details": {}
}
],
"_links": {
"self": {
"href": "text"
}
}
}
],
"_total": 1,
"_links": {
"self": {
"href": "text"
}
}
},
"access": {
"id": "text",
"type": "OPEN",
"startTime": "2026-01-01T00:00:00.000Z",
"endTime": "2026-01-01T00:00:00.000Z"
},
"guests": {
"displayName": "text",
"displayNameShort": "text",
"max": 1
},
"reservations": {
"items": [
{
"id": "text",
"startTime": "2026-01-01T00:00:00.000Z",
"endTime": "2026-01-01T00:00:00.000Z",
"tableAssignment": "PENDING",
"sessions": {
"items": [
{
"id": "text",
"session": {
"id": "text"
},
"coupon": {
"id": "text"
},
"charge": {
"id": "text"
},
"_links": {}
}
],
"_total": 1,
"_links": {
"self": {
"href": "text"
}
}
},
"pod": {
"id": "text"
},
"table": {
"id": "text"
},
"coach": {
"id": "text"
},
"guests": 1,
"charges": {
"_total": 1
},
"quickReplays": {
"_total": 1
},
"customReplays": {
"_total": 1
},
"_links": {}
}
],
"_total": 1,
"_links": {
"self": {
"href": "text"
}
}
},
"bookingMode": "USER_BOOKED",
"paymentMethod": "CASH",
"bookedBy": {
"id": "text"
},
"totalTeams": 1,
"teamSize": 1,
"admission": "OPEN",
"admissionRating": {
"minRating": 1,
"maxRating": 1,
"type": "SINGLES"
},
"admissionRate": {
"regular": 1,
"member": 1,
"membersDefault": 1,
"dayPass": {
"id": "text",
"displayName": "text",
"rate": 1
},
"memberships": {
"items": [
{
"membership": {
"id": "text"
},
"rate": 1
}
],
"_total": 1,
"_links": {
"self": {
"href": "text"
}
}
},
"chargingStrategy": "spot+",
"_links": {}
},
"admissionDate": {
"regular": "2026-01-01T00:00:00.000Z",
"member": "2026-01-01T00:00:00.000Z",
"membersDefault": "2026-01-01T00:00:00.000Z",
"memberships": {
"items": [
{
"membership": {
"id": "text"
},
"date": "2026-01-01T00:00:00.000Z"
}
],
"_total": 1,
"_links": {
"self": {
"href": "text"
}
}
},
"_links": {}
},
"admissionKids": "OPEN",
"allowedMemberships": {},
"coachRate": 1,
"freeSignupCancellationHorizonHours": 1,
"tags": [
"text"
],
"picture": {
"id": "text"
},
"visibility": "LISTED",
"invitations": {},
"payments": {},
"replays": {},
"cancellation": {},
"notes": {},
"openInvitations": {},
"signups": {},
"waitlist": {},
"features": [
"WAITLIST"
],
"stats": {},
"series": {
"id": "text"
},
"suspension": {
"id": "text"
},
"status": "INVALID",
"errors": [
{
"code": "text",
"message": "text",
"details": {}
}
],
"tournamentDivision": {
"id": "7229d7d5-5581-4d86-975f-5b7efc9b00e9",
"tournament": "7229d7d5-5581-4d86-975f-5b7efc9b00e9",
"provider": "SWISH",
"swish": {
"eventFormat": "rotating_partners_round_robin",
"gameId": "game123",
"editPlayersPath": "rotating-partners-round-robin"
},
"podplay": {
"eventFormat": "round_robin",
"gameId": "game123",
"url": "https://tournaments.podplay.app/admin/tournaments/game123"
},
"status": "DRAFT",
"createdAt": "2025-07-09T17:32:26.800Z",
"event": "7229d7d5-5581-4d86-975f-5b7efc9b00e9",
"lastSyncedAt": "2025-07-09T17:32:26.800Z",
"visibility": "VISIBLE",
"_links": {}
},
"visibilitySchedules": {
"items": [
{
"id": "text",
"event": {
"id": "text"
},
"listDaysBefore": 1,
"membersOnly": true,
"executed": true,
"status": "INVALID",
"errors": [
{
"code": "text",
"message": "text",
"details": {}
}
],
"_links": {}
}
],
"_total": 1,
"_links": {
"self": {
"href": "text"
}
}
},
"recurrence": {
"id": "text"
},
"teams": {
"items": [
{
"id": "text",
"_links": {
"self": {
"href": "text"
}
},
"teamLeader": {
"id": "text",
"user": {
"id": "text"
},
"type": "REGULAR",
"firstName": "text",
"lastName": "text",
"gender": "text",
"birthday": "2026-01-01T00:00:00.000Z",
"initials": "text",
"description": "text",
"picture": {},
"usattRating": 1,
"duprProfileUrl": "text",
"memberSince": "2026-01-01T00:00:00.000Z",
"membershipEnrollment": {},
"kids": {},
"_links": {}
},
"teamMembers": {
"items": [
{
"id": "text",
"user": {
"id": "text"
},
"type": "REGULAR",
"firstName": "text",
"lastName": "text",
"gender": "text",
"birthday": "2026-01-01T00:00:00.000Z",
"initials": "text",
"description": "text",
"picture": {},
"usattRating": 1,
"duprProfileUrl": "text",
"memberSince": "2026-01-01T00:00:00.000Z",
"membershipEnrollment": {},
"kids": {},
"_links": {}
}
],
"_total": 1,
"_links": {
"self": {
"href": "text"
}
}
},
"teamMemberCount": 1
}
],
"_total": 1,
"_links": {
"self": {
"href": "text"
}
}
},
"_links": {}
}patch
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
eventIdstringRequiredExample:
3857358a-59e8-4944-8c48-3345c4375b43Query parameters
expandstring[]OptionalExample:
["_links.reservations","_links.bookedBy","_links.invitations"]Body
namestringRequired
descriptionstringRequired
startTimestring · date-timeRequired
endTimestring · date-timeRequired
totalTeamsnumberRequired
teamSizenumberRequired
admissionstring · enumRequiredPossible values:
admissionKidsstring · enumRequiredPossible values:
allowedMembershipsobjectRequired
coachRatenumberRequired
freeSignupCancellationHorizonHoursnumberRequired
tagsstring[]Required
visibilitystring · enumRequiredPossible values:
statusstring · enumRequiredPossible values:
Responses
200
Returns an Event
application/json
idstringRequired
typestring · enumRead-onlyRequiredPossible values:
subtypestring · enumRequiredPossible values:
customTypestringRequired
namestringRequired
descriptionstringRequired
startTimestring · date-timeRequired
endTimestring · date-timeRequired
bookingModestring · enumRead-onlyRequiredPossible values:
paymentMethodstring · enumRead-onlyRequiredPossible values:
totalTeamsnumberRequired
teamSizenumberRequired
admissionstring · enumRequiredPossible values:
admissionKidsstring · enumRequiredPossible values:
allowedMembershipsobjectRequired
coachRatenumberRequired
freeSignupCancellationHorizonHoursnumberRequired
tagsstring[]Required
visibilitystring · enumRequiredPossible values:
invitationsobjectRequired
paymentsobjectRequired
completeInvitationsinteger · max: 10RequiredDeprecated
replaysobjectRequired
cancellationobjectRequired
notesobjectRequired
openInvitationsobjectRequired
signupsobjectRequired
waitlistobjectRequired
statsobjectRequired
statusstring · enumRequiredPossible values:
_linksobjectRequired
400
Returns an error
application/json
403
Returns an error
application/json
404
Returns an error
application/json
422
Returns an error
application/json
500
Returns an error
application/json
patch/events/{eventId}
PATCH /apis/v2/events/{eventId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1294
{
"name": "text",
"description": "text",
"startTime": "2026-01-01T00:00:00.000Z",
"endTime": "2026-01-01T00:00:00.000Z",
"guests": {
"displayName": "text",
"displayNameShort": "text",
"max": 1
},
"totalTeams": 1,
"teamSize": 1,
"admission": "OPEN",
"admissionRating": {
"minRating": 1,
"maxRating": 1,
"type": "SINGLES"
},
"admissionRate": {
"regular": 1,
"membersDefault": 1,
"memberships": {
"items": [
{
"membership": {
"id": "text"
},
"rate": 1
}
],
"_total": 1,
"_links": {
"self": {
"href": "text"
}
}
},
"chargingStrategy": "spot+",
"_links": {}
},
"admissionDate": {
"regular": "2026-01-01T00:00:00.000Z",
"membersDefault": "2026-01-01T00:00:00.000Z",
"memberships": {
"items": [
{
"membership": {
"id": "text"
},
"date": "2026-01-01T00:00:00.000Z"
}
],
"_total": 1,
"_links": {
"self": {
"href": "text"
}
}
},
"_links": {}
},
"admissionKids": "OPEN",
"allowedMemberships": {},
"coachRate": 1,
"freeSignupCancellationHorizonHours": 1,
"tags": [
"text"
],
"picture": {
"id": "text"
},
"visibility": "LISTED",
"features": [
"WAITLIST"
],
"status": "INVALID",
"tournamentDivision": {
"provider": "SWISH",
"swish": {
"eventFormat": "rotating_partners_round_robin",
"gameId": "game123",
"editPlayersPath": "rotating-partners-round-robin"
},
"podplay": {
"eventFormat": "round_robin",
"gameId": "game123",
"url": "https://tournaments.podplay.app/admin/tournaments/game123"
},
"lastSyncedAt": "2025-07-09T17:32:26.800Z",
"visibility": "VISIBLE"
}
}{
"id": "text",
"type": "REGULAR",
"subtype": "OPERATIONS",
"customType": "text",
"name": "text",
"description": "text",
"startTime": "2026-01-01T00:00:00.000Z",
"endTime": "2026-01-01T00:00:00.000Z",
"pods": {
"items": [
{
"id": "text",
"slug": "text",
"displayName": "text",
"displayNameShort": "text",
"description": "text",
"address": {
"street": "text",
"floor": "text",
"city": "text",
"zip": "text",
"displayName": "text"
},
"timezone": "text",
"type": "PRIVATE",
"status": "NOT_AVAILABLE",
"sport": "PICKLEBALL",
"area": {},
"tables": {
"items": [
{
"id": "text",
"slug": "text",
"displayName": "text",
"displayNameShort": "text",
"description": "text",
"type": "STANDARD",
"status": "AVAILABLE",
"features": [
"REPLAYS"
],
"pod": {},
"settings": {
"items": [
{
"id": "text",
"value": {}
}
],
"_total": 1,
"_links": {
"self": {
"href": "text"
}
}
},
"errors": [
{
"code": "text",
"message": "text",
"details": {}
}
],
"_links": {}
}
],
"_total": 1,
"_links": {
"self": {
"href": "text"
}
}
},
"openTime": {
"hours": 1,
"minutes": 1
},
"closeTime": {
"hours": 1,
"minutes": 1
},
"closedTimeOverrides": {
"items": [
{
"id": "text",
"days": [
1
],
"from": {
"hours": 1,
"minutes": 1
},
"to": {
"hours": 1,
"minutes": 1
}
}
],
"_total": 1,
"_links": {
"self": {
"href": "text"
}
}
},
"guests": {
"private": {
"min": "text",
"max": "text"
}
},
"rates": {},
"settings": {
"items": [
{
"id": "text",
"value": {}
}
],
"_total": 1,
"_links": {
"self": {
"href": "text"
}
}
},
"errors": [
{
"code": "text",
"message": "text",
"details": {}
}
],
"_links": {}
}
],
"_total": 1,
"_links": {
"self": {
"href": "text"
}
}
},
"tables": {
"items": [
{
"id": "text",
"type": "FIXED_TABLE",
"table": {
"id": "text"
},
"startTime": "2026-01-01T00:00:00.000Z",
"endTime": "2026-01-01T00:00:00.000Z",
"features": [
"REPLAYS"
],
"status": "INVALID",
"errors": [
{
"code": "text",
"message": "text",
"details": {}
}
],
"_links": {
"self": {
"href": "text"
}
}
}
],
"_total": 1,
"_links": {
"self": {
"href": "text"
}
}
},
"access": {
"id": "text",
"type": "OPEN",
"startTime": "2026-01-01T00:00:00.000Z",
"endTime": "2026-01-01T00:00:00.000Z"
},
"guests": {
"displayName": "text",
"displayNameShort": "text",
"max": 1
},
"reservations": {
"items": [
{
"id": "text",
"startTime": "2026-01-01T00:00:00.000Z",
"endTime": "2026-01-01T00:00:00.000Z",
"tableAssignment": "PENDING",
"sessions": {
"items": [
{
"id": "text",
"session": {
"id": "text"
},
"coupon": {
"id": "text"
},
"charge": {
"id": "text"
},
"_links": {}
}
],
"_total": 1,
"_links": {
"self": {
"href": "text"
}
}
},
"pod": {
"id": "text"
},
"table": {
"id": "text"
},
"coach": {
"id": "text"
},
"guests": 1,
"charges": {
"_total": 1
},
"quickReplays": {
"_total": 1
},
"customReplays": {
"_total": 1
},
"_links": {}
}
],
"_total": 1,
"_links": {
"self": {
"href": "text"
}
}
},
"bookingMode": "USER_BOOKED",
"paymentMethod": "CASH",
"bookedBy": {
"id": "text"
},
"totalTeams": 1,
"teamSize": 1,
"admission": "OPEN",
"admissionRating": {
"minRating": 1,
"maxRating": 1,
"type": "SINGLES"
},
"admissionRate": {
"regular": 1,
"member": 1,
"membersDefault": 1,
"dayPass": {
"id": "text",
"displayName": "text",
"rate": 1
},
"memberships": {
"items": [
{
"membership": {
"id": "text"
},
"rate": 1
}
],
"_total": 1,
"_links": {
"self": {
"href": "text"
}
}
},
"chargingStrategy": "spot+",
"_links": {}
},
"admissionDate": {
"regular": "2026-01-01T00:00:00.000Z",
"member": "2026-01-01T00:00:00.000Z",
"membersDefault": "2026-01-01T00:00:00.000Z",
"memberships": {
"items": [
{
"membership": {
"id": "text"
},
"date": "2026-01-01T00:00:00.000Z"
}
],
"_total": 1,
"_links": {
"self": {
"href": "text"
}
}
},
"_links": {}
},
"admissionKids": "OPEN",
"allowedMemberships": {},
"coachRate": 1,
"freeSignupCancellationHorizonHours": 1,
"tags": [
"text"
],
"picture": {
"id": "text"
},
"visibility": "LISTED",
"invitations": {},
"payments": {},
"replays": {},
"cancellation": {},
"notes": {},
"openInvitations": {},
"signups": {},
"waitlist": {},
"features": [
"WAITLIST"
],
"stats": {},
"series": {
"id": "text"
},
"suspension": {
"id": "text"
},
"status": "INVALID",
"errors": [
{
"code": "text",
"message": "text",
"details": {}
}
],
"tournamentDivision": {
"id": "7229d7d5-5581-4d86-975f-5b7efc9b00e9",
"tournament": "7229d7d5-5581-4d86-975f-5b7efc9b00e9",
"provider": "SWISH",
"swish": {
"eventFormat": "rotating_partners_round_robin",
"gameId": "game123",
"editPlayersPath": "rotating-partners-round-robin"
},
"podplay": {
"eventFormat": "round_robin",
"gameId": "game123",
"url": "https://tournaments.podplay.app/admin/tournaments/game123"
},
"status": "DRAFT",
"createdAt": "2025-07-09T17:32:26.800Z",
"event": "7229d7d5-5581-4d86-975f-5b7efc9b00e9",
"lastSyncedAt": "2025-07-09T17:32:26.800Z",
"visibility": "VISIBLE",
"_links": {}
},
"visibilitySchedules": {
"items": [
{
"id": "text",
"event": {
"id": "text"
},
"listDaysBefore": 1,
"membersOnly": true,
"executed": true,
"status": "INVALID",
"errors": [
{
"code": "text",
"message": "text",
"details": {}
}
],
"_links": {}
}
],
"_total": 1,
"_links": {
"self": {
"href": "text"
}
}
},
"recurrence": {
"id": "text"
},
"teams": {
"items": [
{
"id": "text",
"_links": {
"self": {
"href": "text"
}
},
"teamLeader": {
"id": "text",
"user": {
"id": "text"
},
"type": "REGULAR",
"firstName": "text",
"lastName": "text",
"gender": "text",
"birthday": "2026-01-01T00:00:00.000Z",
"initials": "text",
"description": "text",
"picture": {},
"usattRating": 1,
"duprProfileUrl": "text",
"memberSince": "2026-01-01T00:00:00.000Z",
"membershipEnrollment": {},
"kids": {},
"_links": {}
},
"teamMembers": {
"items": [
{
"id": "text",
"user": {
"id": "text"
},
"type": "REGULAR",
"firstName": "text",
"lastName": "text",
"gender": "text",
"birthday": "2026-01-01T00:00:00.000Z",
"initials": "text",
"description": "text",
"picture": {},
"usattRating": 1,
"duprProfileUrl": "text",
"memberSince": "2026-01-01T00:00:00.000Z",
"membershipEnrollment": {},
"kids": {},
"_links": {}
}
],
"_total": 1,
"_links": {
"self": {
"href": "text"
}
}
},
"teamMemberCount": 1
}
],
"_total": 1,
"_links": {
"self": {
"href": "text"
}
}
},
"_links": {}
}get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
eventIdstringRequiredExample:
3857358a-59e8-4944-8c48-3345c4375b43Query parameters
expandstring[]OptionalExample:
["items._links.table"]Responses
200
Returns a EventTableCollection
application/json
_totalnumberRequired
get/events/{eventId}/tables
GET /apis/v2/events/{eventId}/tables HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200
Returns a EventTableCollection
{
"items": [
{
"id": "text",
"type": "FIXED_TABLE",
"table": {
"id": "text"
},
"startTime": "2026-01-01T00:00:00.000Z",
"endTime": "2026-01-01T00:00:00.000Z",
"features": [
"REPLAYS"
],
"status": "INVALID",
"errors": [
{
"code": "text",
"message": "text",
"details": {}
}
],
"_links": {
"self": {
"href": "text"
}
}
}
],
"_total": 1,
"_links": {
"self": {
"href": "text"
}
}
}post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
eventIdstringRequiredExample:
3857358a-59e8-4944-8c48-3345c4375b43Query parameters
expandstring[]OptionalExample:
["_links.pod"]Body
idstringRead-onlyRequired
typestring · enumRequiredPossible values:
startTimestring · date-timeRead-onlyRequired
endTimestring · date-timeRead-onlyRequired
statusstring · enumRead-onlyRequiredPossible values:
Responses
201
Returns the recently added EventTableDto
application/json
idstringRead-onlyRequired
typestring · enumRequiredPossible values:
startTimestring · date-timeRead-onlyRequired
endTimestring · date-timeRead-onlyRequired
statusstring · enumRead-onlyRequiredPossible values:
422
Returns an error
application/json
post/events/{eventId}/tables
POST /apis/v2/events/{eventId}/tables HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 67
{
"type": "FIXED_TABLE",
"table": {
"id": "text"
},
"features": [
"REPLAYS"
]
}{
"id": "text",
"type": "FIXED_TABLE",
"table": {
"id": "text"
},
"startTime": "2026-01-01T00:00:00.000Z",
"endTime": "2026-01-01T00:00:00.000Z",
"features": [
"REPLAYS"
],
"status": "INVALID",
"errors": [
{
"code": "text",
"message": "text",
"details": {}
}
],
"_links": {
"self": {
"href": "text"
}
}
}get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
eventIdstringRequiredExample:
3857358a-59e8-4944-8c48-3345c4375b43Responses
200
Returns a MembershipCollection
application/json
get/events/{eventId}/allowed-memberships
GET /apis/v2/events/{eventId}/allowed-memberships HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200
Returns a MembershipCollection
{
"items": [
{
"id": "text",
"displayName": "text",
"description": "text",
"type": "GLOBAL_MEMBER",
"membershipPlan": {
"id": "text",
"displayName": "text"
},
"status": "ACTIVE",
"yearlyPrice": 1,
"monthlyPrice": 1,
"monthlyDisplayPrice": "text",
"initiationFeeMonthly": 1,
"initiationFeeYearly": 1,
"additionalMemberFee": 1,
"additionalMembersCap": 1,
"bookingHorizonDays": 1,
"benefits": {
"items": [
{}
],
"_links": {
"self": {
"href": "text"
}
},
"_total": 1
},
"showSubscriptionDetails": true,
"allowPublicCancellation": true,
"isGroupMembership": true,
"areas": {
"items": [
"text"
],
"_total": 1,
"_links": {
"self": {
"href": "text"
}
}
},
"membershipAreas": {
"items": [
"text"
],
"_total": 1,
"_links": {
"self": {
"href": "text"
}
}
},
"tags": "MOST_POPULAR",
"settings": {
"items": [
{
"id": "membership.priority",
"value": {}
}
],
"_total": 1,
"_links": {
"self": {
"href": "text"
}
}
},
"subscriptionsCount": 1,
"hasOrHadMembers": true,
"slug": "text",
"taxRegionId": "text",
"allowedChargeTypes": [
"YEARLY"
],
"contactEmail": "text",
"oneTimePriceOptions": {
"items": [
{
"id": "text",
"price": 1,
"durationDays": 1,
"listed": true
}
],
"_links": {
"self": {
"href": "text"
}
},
"_total": 1
},
"priceChangeScope": "ALL_CURRENT",
"presalesEndDateChangeScope": "ADJUST_SUBSCRIPTIONS",
"adjustMonthlyGrantDates": true,
"errors": [
{
"code": "text",
"message": "text",
"details": {}
}
],
"_links": {}
}
],
"_pagination": {
"page": 1,
"ipp": 1,
"count": 1,
"total": 1
},
"_links": {
"self": {
"href": "text"
}
}
}get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
eventIdstringRequiredExample:
c66d718e-e68b-4033-b772-8b7471ada7abResponses
200
Returns a EventTeamCollection
application/json
_totalnumberRequired
get/events/{eventId}/teams
GET /apis/v2/events/{eventId}/teams HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200
Returns a EventTeamCollection
{
"items": [
{
"id": "text",
"_links": {
"self": {
"href": "text"
}
},
"teamLeader": {
"id": "text",
"user": {
"id": "text"
},
"type": "REGULAR",
"firstName": "text",
"lastName": "text",
"gender": "text",
"birthday": "2026-01-01T00:00:00.000Z",
"initials": "text",
"description": "text",
"picture": {},
"usattRating": 1,
"duprProfileUrl": "text",
"memberSince": "2026-01-01T00:00:00.000Z",
"membershipEnrollment": {},
"kids": {},
"_links": {}
},
"teamMembers": {
"items": [
{
"id": "text",
"user": {
"id": "text"
},
"type": "REGULAR",
"firstName": "text",
"lastName": "text",
"gender": "text",
"birthday": "2026-01-01T00:00:00.000Z",
"initials": "text",
"description": "text",
"picture": {},
"usattRating": 1,
"duprProfileUrl": "text",
"memberSince": "2026-01-01T00:00:00.000Z",
"membershipEnrollment": {},
"kids": {},
"_links": {}
}
],
"_total": 1,
"_links": {
"self": {
"href": "text"
}
}
},
"teamMemberCount": 1
}
],
"_total": 1,
"_links": {
"self": {
"href": "text"
}
}
}get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
eventTableIdstringRequiredExample:
c66d718e-e68b-4033-b772-8b7471ada7ab-hudson-multi-1-fixed-1664967600000eventIdstringRequiredExample:
c66d718e-e68b-4033-b772-8b7471ada7abQuery parameters
expandstring[]OptionalExample:
["_links.table"]Responses
200
Returns a EventTable
application/json
idstringRead-onlyRequired
typestring · enumRequiredPossible values:
startTimestring · date-timeRead-onlyRequired
endTimestring · date-timeRead-onlyRequired
statusstring · enumRead-onlyRequiredPossible values:
get/events/{eventId}/tables/{eventTableId}
GET /apis/v2/events/{eventId}/tables/{eventTableId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200
Returns a EventTable
{
"id": "text",
"type": "FIXED_TABLE",
"table": {
"id": "text"
},
"startTime": "2026-01-01T00:00:00.000Z",
"endTime": "2026-01-01T00:00:00.000Z",
"features": [
"REPLAYS"
],
"status": "INVALID",
"errors": [
{
"code": "text",
"message": "text",
"details": {}
}
],
"_links": {
"self": {
"href": "text"
}
}
}delete
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
eventTableIdstringRequiredExample:
c66d718e-e68b-4033-b772-8b7471ada7ab-hudson-multi-1-fixed-1664967600000eventIdstringRequiredExample:
c66d718e-e68b-4033-b772-8b7471ada7abQuery parameters
expandstring[]OptionalExample:
["_links.table"]Responses
200
Returns a EventTable
application/json
idstringRead-onlyRequired
typestring · enumRequiredPossible values:
startTimestring · date-timeRead-onlyRequired
endTimestring · date-timeRead-onlyRequired
statusstring · enumRead-onlyRequiredPossible values:
delete/events/{eventId}/tables/{eventTableId}
DELETE /apis/v2/events/{eventId}/tables/{eventTableId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200
Returns a EventTable
{
"id": "text",
"type": "FIXED_TABLE",
"table": {
"id": "text"
},
"startTime": "2026-01-01T00:00:00.000Z",
"endTime": "2026-01-01T00:00:00.000Z",
"features": [
"REPLAYS"
],
"status": "INVALID",
"errors": [
{
"code": "text",
"message": "text",
"details": {}
}
],
"_links": {
"self": {
"href": "text"
}
}
}patch
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
eventTableIdstringRequiredExample:
c66d718e-e68b-4033-b772-8b7471ada7ab-hudson-multi-1-fixed-1664967600000eventIdstringRequiredExample:
c66d718e-e68b-4033-b772-8b7471ada7abQuery parameters
expandstring[]OptionalExample:
["_links.table"]Body
typestring · enumWrite-onlyRequiredPossible values:
startTimestring · date-timeWrite-onlyRequired
endTimestring · date-timeWrite-onlyRequired
Responses
200
Returns a EventTable
application/json
idstringRead-onlyRequired
typestring · enumRequiredPossible values:
startTimestring · date-timeRead-onlyRequired
endTimestring · date-timeRead-onlyRequired
statusstring · enumRead-onlyRequiredPossible values:
patch/events/{eventId}/tables/{eventTableId}
PATCH /apis/v2/events/{eventId}/tables/{eventTableId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 120
{
"type": "FIXED_TABLE",
"table": {
"id": "text"
},
"startTime": "2026-01-01T00:00:00.000Z",
"endTime": "2026-01-01T00:00:00.000Z"
}200
Returns a EventTable
{
"id": "text",
"type": "FIXED_TABLE",
"table": {
"id": "text"
},
"startTime": "2026-01-01T00:00:00.000Z",
"endTime": "2026-01-01T00:00:00.000Z",
"features": [
"REPLAYS"
],
"status": "INVALID",
"errors": [
{
"code": "text",
"message": "text",
"details": {}
}
],
"_links": {
"self": {
"href": "text"
}
}
}post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
startTimestring · date-timeRequired
endTimestring · date-time · nullableRequired
visibilitystring · enumRequiredPossible values:
membersOnlybooleanRequired
statusstring · enumRequiredPossible values:
Responses
201
Returns an EventClone
application/json
startTimestring · date-timeRequired
endTimestring · date-time · nullableRequired
visibilitystring · enumRequiredPossible values:
membersOnlybooleanRequired
statusstring · enumRequiredPossible values:
400
Returns an error when provided event is of type REGULAR.
application/json
403
Returns an error.
application/json
404
Returns a not found error when provided source event does not exist.
application/json
422
Returns an ErrorDto in case of validation errors or failures.
Possible error codes are:EC000: Events must start at HH:00 or HH:30.EC001: Time range already booked.EC002: And internal error occurred, if the issue persist, please reach out the tech team.EC003: This event ends in the past, please verify the date range and try again.EC004: Wrong publishing schedule settings, please review members and non members publishing schedules and try again.
post/events/clones
POST /apis/v2/events/clones HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 381
{
"startTime": "2026-01-01T00:00:00.000Z",
"endTime": "2026-01-01T00:00:00.000Z",
"courts": {
"items": [
"text"
],
"_total": 1,
"_links": {
"self": {
"href": "text"
}
}
},
"sourceEvent": {
"id": "text"
},
"visibility": "LISTED",
"membersOnly": true,
"visibilitySchedules": {
"items": [
{
"id": "text",
"listDaysBefore": 1,
"membersOnly": true,
"_links": {}
}
],
"_total": 1,
"_links": {
"self": {
"href": "text"
}
}
},
"status": "INVALID"
}{
"startTime": "2026-01-01T00:00:00.000Z",
"endTime": "2026-01-01T00:00:00.000Z",
"courts": {
"items": [
"text"
],
"_total": 1,
"_links": {
"self": {
"href": "text"
}
}
},
"sourceEvent": {
"id": "text"
},
"clonedEvent": {
"id": "text"
},
"visibility": "LISTED",
"membersOnly": true,
"visibilitySchedules": {
"items": [
{
"id": "text",
"event": {
"id": "text"
},
"listDaysBefore": 1,
"membersOnly": true,
"executed": true,
"status": "INVALID",
"errors": [
{
"code": "text",
"message": "text",
"details": {}
}
],
"_links": {}
}
],
"_total": 1,
"_links": {
"self": {
"href": "text"
}
}
},
"status": "INVALID",
"errors": [
{
"code": "text",
"message": "text",
"details": {}
}
]
}post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
eventIdstringRequiredExample:
c66d718e-e68b-4033-b772-8b7471ada7abResponses
200
Returns a EventChatChannel
application/json
idstringRequired
displayNamestringRead-onlyRequired
post/events/{eventId}/chat/channels
POST /apis/v2/events/{eventId}/chat/channels HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200
Returns a EventChatChannel
{
"id": "text",
"displayName": "text"
}get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
eventIdstringRequiredExample:
65d283a0-3a78-4792-8e0d-6499c5f1bd29Query parameters
includeCanceledbooleanOptionalExample:
Include canceled signups
trueexpandstring[]Optional
Responses
200
Returns a EventSignupCollection
application/json
_totalnumberRequired
get/events/{eventId}/signups
GET /apis/v2/events/{eventId}/signups HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200
Returns a EventSignupCollection
{
"items": [
{
"id": "text",
"type": "PREVIEW",
"status": "DRAFT",
"passesStrategy": "USE_ALL",
"availableGuests": {
"items": [
{
"id": "text",
"displayName": "text",
"guests": 1,
"rate": 1
}
],
"_total": 1,
"_links": {
"self": {
"href": "text"
}
}
},
"kids": {
"items": [
"text"
],
"_total": 1,
"_links": {
"self": {
"href": "text"
}
}
},
"coupon": {
"id": "text",
"code": "text",
"discountType": "AMOUNT_OFF",
"value": 1,
"_links": {
"self": {
"href": "text"
}
}
},
"summary": {
"event": {
"id": "text"
},
"invitation": {
"id": "text"
},
"openInvitation": {
"id": "text"
},
"currency": "text",
"rates": {
"signup": 1,
"guests": 1,
"teamLeader": 1,
"teamMember": 1
},
"subtotal": 1,
"taxes": [
{
"name": "text",
"amount": 1,
"percentage": 1
}
],
"virtualCredits": 1,
"couponDiscount": 1,
"passes": {
"items": [
{
"id": {},
"available": 1,
"quantity": 1,
"displayName": "text",
"displayNamePlural": "text",
"rate": 1
}
],
"_total": 1,
"_links": {}
},
"total": 1,
"errors": [
{
"code": "text",
"message": "text",
"details": {}
}
]
},
"owner": {
"id": "text"
},
"order": {
"id": "text"
},
"_links": {}
}
],
"_total": 1,
"_links": {
"self": {
"href": "text"
}
}
}post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
eventIdstringRequiredExample:
3857358a-59e8-4944-8c48-3345c4375b43Query parameters
expandstring[]Optional
Header parameters
user-agentstringRequired
Body
idstringRead-onlyRequired
typestring · enumRequiredPossible values:
statusstring · enumRead-onlyRequiredPossible values:
modestring · enum · nullableWrite-onlyRequiredPossible values:
paymentMethodstring · enum · nullableWrite-onlyRequiredPossible values:
virtualCreditsnumber · nullableWrite-onlyRequired
couponCodestring · nullableWrite-onlyRequired
passesStrategystring · enum · nullableRequiredPossible values:
termsAgreedboolean · nullableWrite-onlyRequired
An optional parameter to tell the User is agreeing the "Terms" along with the signup request.
liabilityWaiverAgreedboolean · nullableWrite-onlyRequired
An optional parameter to tell the User is agreeing the "Liability waiver" along with the signup request.
_linksobjectRequired
Responses
201
Returns an EventSignup
application/json
idstringRead-onlyRequired
typestring · enumRequiredPossible values:
statusstring · enumRead-onlyRequiredPossible values:
modestring · enum · nullableWrite-onlyRequiredPossible values:
paymentMethodstring · enum · nullableWrite-onlyRequiredPossible values:
virtualCreditsnumber · nullableWrite-onlyRequired
couponCodestring · nullableWrite-onlyRequired
passesStrategystring · enum · nullableRequiredPossible values:
termsAgreedboolean · nullableWrite-onlyRequired
An optional parameter to tell the User is agreeing the "Terms" along with the signup request.
liabilityWaiverAgreedboolean · nullableWrite-onlyRequired
An optional parameter to tell the User is agreeing the "Liability waiver" along with the signup request.
_linksobjectRequired
409
Returns an error
application/json
422
Returns an ErrorDto in case of validation errors or failures.
Possible error codes are:ES000: This action requires a logged in user.ES001: You're already invited to this event.ES002: The event has reached its spots capacity.ES003: The guests capacity for this event has been already reached.ES004: Invalid value for virtual credits.ES005: The amount of virtual credits exceeds your balance.ES006: The event admission is closed.ES007: The event is for members only.ES008: You need to add a payment method to your account.ES009: Your payment method is not active. Please, add a new one.ES010: User phone number is required.ES011: Terms of Service agreement is required.ES012: Liability waiver agreement is required.ES013: You are not allowed to signup for free.ES014: The series subscriptions are closed.ES015: Only {{membershipName}} members are allowed.ES016: Only members are allowed.ES017: You are not allowed to make cash signups.ES018: The event is for {{kidsTerm}} only. Please add a {{kidTerm}.ES019: There are only {{spotsLeft}} spots left. Please review your selection.ES020: Liability waiver agreement not found. Please contact support.ES021: There was an issue processing the payment for your membership. Please update your payment method to continue booking.ES022: There was an issue processing the payment for your group membership. Please ask the person paying for the membership to update their payment details to continue using your membership.ES039: You need to cover the full amount with {{virtualCreditsTerm}}ES040: Unable to proceed with the current payment method. Please try using a different one.ES041: Prepaid cards are not accepted, please use a credit or debit card.RA001: Could not confirm the payment. Please try again.ES042: The coupon {{couponCode}} is not valid.ES043: The coupon {{couponCode}} is not applicable to {{podDisplayName}}.ES044: The coupon code {{couponCode}} is not valid.ES045: The coupon {{couponCode}} cannot be reused.ES046: The coupon {{couponCode}} is valid only for the first booking.ES047: The coupon {{couponCode}} is not valid for the selected dates.ES048: The coupon {{couponCode}} is not valid for this event type.ES050: One or more Play Passes aren't valid for this purchase.ES051: One or more Play Passes have expired.ES052: Only {{maxDailyEventSignupsWithPackages}} Play Pass can be redeemed per day. You can continue to sign-up for this event by removing your Play Pass.ES060: You reached the maximum of {{count}} simultaneous upcoming {{eventCustomType}} events.UR009: Your DUPR account is not connected.UR010: Your rating is not available.UR011: Your {{rating}} rating is too low for this event. It must be at least {{minRating}}.UR012: Your {{rating}} rating is too high for this event. It must be at most {{maxRating}}.
post/events/{eventId}/signups
POST /apis/v2/events/{eventId}/signups HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
user-agent: text
Content-Type: application/json
Accept: */*
Content-Length: 304
{
"type": "PREVIEW",
"mode": "USER_BOOKED",
"paymentMethod": "CASH",
"virtualCredits": 1,
"couponCode": "text",
"passesStrategy": "USE_ALL",
"termsAgreed": true,
"liabilityWaiverAgreed": true,
"guests": {
"id": "text"
},
"kids": {
"items": [
"text"
],
"_total": 1,
"_links": {
"self": {
"href": "text"
}
}
},
"owner": {
"id": "text"
},
"_links": {}
}{
"id": "text",
"type": "PREVIEW",
"status": "DRAFT",
"passesStrategy": "USE_ALL",
"availableGuests": {
"items": [
{
"id": "text",
"displayName": "text",
"guests": 1,
"rate": 1
}
],
"_total": 1,
"_links": {
"self": {
"href": "text"
}
}
},
"kids": {
"items": [
"text"
],
"_total": 1,
"_links": {
"self": {
"href": "text"
}
}
},
"coupon": {
"id": "text",
"code": "text",
"discountType": "AMOUNT_OFF",
"value": 1,
"_links": {
"self": {
"href": "text"
}
}
},
"summary": {
"event": {
"id": "text"
},
"invitation": {
"id": "text"
},
"openInvitation": {
"id": "text"
},
"currency": "text",
"rates": {
"signup": 1,
"guests": 1,
"teamLeader": 1,
"teamMember": 1
},
"subtotal": 1,
"taxes": [
{
"name": "text",
"amount": 1,
"percentage": 1
}
],
"virtualCredits": 1,
"couponDiscount": 1,
"passes": {
"items": [
{
"id": {},
"available": 1,
"quantity": 1,
"displayName": "text",
"displayNamePlural": "text",
"rate": 1
}
],
"_total": 1,
"_links": {}
},
"total": 1,
"errors": [
{
"code": "text",
"message": "text",
"details": {}
}
]
},
"owner": {
"id": "text"
},
"order": {
"id": "text"
},
"_links": {}
}get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
signupIdstringRequiredExample:
46c0c528-324a-4e09-81e1-7c2d8e500b42eventIdstringRequiredExample:
65d283a0-3a78-4792-8e0d-6499c5f1bd29Query parameters
expandstring[]Optional
Responses
200
Returns a EventSignup
application/json
idstringRead-onlyRequired
typestring · enumRequiredPossible values:
statusstring · enumRead-onlyRequiredPossible values:
modestring · enum · nullableWrite-onlyRequiredPossible values:
paymentMethodstring · enum · nullableWrite-onlyRequiredPossible values:
virtualCreditsnumber · nullableWrite-onlyRequired
couponCodestring · nullableWrite-onlyRequired
passesStrategystring · enum · nullableRequiredPossible values:
termsAgreedboolean · nullableWrite-onlyRequired
An optional parameter to tell the User is agreeing the "Terms" along with the signup request.
liabilityWaiverAgreedboolean · nullableWrite-onlyRequired
An optional parameter to tell the User is agreeing the "Liability waiver" along with the signup request.
_linksobjectRequired
get/events/{eventId}/signups/{signupId}
GET /apis/v2/events/{eventId}/signups/{signupId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200
Returns a EventSignup
{
"id": "text",
"type": "PREVIEW",
"status": "DRAFT",
"passesStrategy": "USE_ALL",
"availableGuests": {
"items": [
{
"id": "text",
"displayName": "text",
"guests": 1,
"rate": 1
}
],
"_total": 1,
"_links": {
"self": {
"href": "text"
}
}
},
"kids": {
"items": [
"text"
],
"_total": 1,
"_links": {
"self": {
"href": "text"
}
}
},
"coupon": {
"id": "text",
"code": "text",
"discountType": "AMOUNT_OFF",
"value": 1,
"_links": {
"self": {
"href": "text"
}
}
},
"summary": {
"event": {
"id": "text"
},
"invitation": {
"id": "text"
},
"openInvitation": {
"id": "text"
},
"currency": "text",
"rates": {
"signup": 1,
"guests": 1,
"teamLeader": 1,
"teamMember": 1
},
"subtotal": 1,
"taxes": [
{
"name": "text",
"amount": 1,
"percentage": 1
}
],
"virtualCredits": 1,
"couponDiscount": 1,
"passes": {
"items": [
{
"id": {},
"available": 1,
"quantity": 1,
"displayName": "text",
"displayNamePlural": "text",
"rate": 1
}
],
"_total": 1,
"_links": {}
},
"total": 1,
"errors": [
{
"code": "text",
"message": "text",
"details": {}
}
]
},
"owner": {
"id": "text"
},
"order": {
"id": "text"
},
"_links": {}
}get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
signupIdstringRequiredExample:
46c0c528-324a-4e09-81e1-7c2d8e500b42eventIdstringRequiredExample:
3857358a-59e8-4944-8c48-3345c4375b43Responses
200
Returns a Reservation
application/json
typestring · enumRequiredPossible values:
statusstring · enumRead-onlyRequiredPossible values:
reasonstring · enum · nullableRead-onlyOptionalPossible values:
reasonTextstring · nullableOptional
Optional free-text reason when reason is OTHER. Max 40 characters.
get/events/{eventId}/signups/{signupId}/cancellation
GET /apis/v2/events/{eventId}/signups/{signupId}/cancellation HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200
Returns a Reservation
{
"type": "PREVIEW",
"status": "DRAFT",
"reason": "WEATHER",
"reasonText": "text",
"summary": {
"policy": "FREE_OF_CHARGE",
"policySubtype": {},
"policyDescription": {},
"extensionId": {},
"cancellingUser": {
"id": "text",
"user": {
"id": "text"
},
"type": "REGULAR",
"firstName": "text",
"lastName": "text",
"gender": "text",
"birthday": "2026-01-01T00:00:00.000Z",
"initials": "text",
"description": "text",
"picture": {},
"usattRating": 1,
"duprProfileUrl": "text",
"memberSince": "2026-01-01T00:00:00.000Z",
"membershipEnrollment": {},
"kids": {},
"_links": {}
},
"cancellationTime": "2026-01-01T00:00:00.000Z",
"validUntilTime": "2026-01-01T00:00:00.000Z",
"cancellationFee": 1,
"refund": {
"reimbursement": 1,
"virtualCredits": 1,
"passes": {
"items": [
{
"id": {},
"available": 1,
"quantity": 1,
"displayName": "text",
"displayNamePlural": "text",
"rate": 1
}
],
"_total": 1,
"_links": {}
}
},
"errors": [
{
"code": "text",
"message": "text",
"details": {}
}
]
}
}post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
signupIdstringRequiredExample:
46c0c528-324a-4e09-81e1-7c2d8e500b42eventIdstringRequiredExample:
3857358a-59e8-4944-8c48-3345c4375b43Body
typestring · enumRequiredPossible values:
statusstring · enumRead-onlyRequiredPossible values:
reasonstring · enum · nullableRead-onlyOptionalPossible values:
reasonTextstring · nullableOptional
Optional free-text reason when reason is OTHER. Max 40 characters.
Responses
200
Returns an EventSignupCancellation
application/json
typestring · enumRequiredPossible values:
statusstring · enumRead-onlyRequiredPossible values:
reasonstring · enum · nullableRead-onlyOptionalPossible values:
reasonTextstring · nullableOptional
Optional free-text reason when reason is OTHER. Max 40 characters.
422
Returns an error
application/json
post/events/{eventId}/signups/{signupId}/cancellation
POST /apis/v2/events/{eventId}/signups/{signupId}/cancellation HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 38
{
"type": "PREVIEW",
"reasonText": "text"
}{
"type": "PREVIEW",
"status": "DRAFT",
"reason": "WEATHER",
"reasonText": "text",
"summary": {
"policy": "FREE_OF_CHARGE",
"policySubtype": {},
"policyDescription": {},
"extensionId": {},
"cancellingUser": {
"id": "text",
"user": {
"id": "text"
},
"type": "REGULAR",
"firstName": "text",
"lastName": "text",
"gender": "text",
"birthday": "2026-01-01T00:00:00.000Z",
"initials": "text",
"description": "text",
"picture": {},
"usattRating": 1,
"duprProfileUrl": "text",
"memberSince": "2026-01-01T00:00:00.000Z",
"membershipEnrollment": {},
"kids": {},
"_links": {}
},
"cancellationTime": "2026-01-01T00:00:00.000Z",
"validUntilTime": "2026-01-01T00:00:00.000Z",
"cancellationFee": 1,
"refund": {
"reimbursement": 1,
"virtualCredits": 1,
"passes": {
"items": [
{
"id": {},
"available": 1,
"quantity": 1,
"displayName": "text",
"displayNamePlural": "text",
"rate": 1
}
],
"_total": 1,
"_links": {}
}
},
"errors": [
{
"code": "text",
"message": "text",
"details": {}
}
]
}
}get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
eventIdstringRequiredExample:
3857358a-59e8-4944-8c48-3345c4375b43Responses
200
Returns a collection of participants of an event
application/json
_totalnumberRequiredDeprecated
get/events/{eventId}/attendees
GET /apis/v2/events/{eventId}/attendees HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200
Returns a collection of participants of an event
{
"items": [
{
"id": "text",
"displayName": "text",
"flags": [
"ANONYMOUS"
],
"rating": 1,
"team": {
"id": "text"
}
}
],
"_links": {
"self": {
"href": "text"
}
}
}post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
eventIdstringRequiredExample:
3857358a-59e8-4944-8c48-3345c4375b43Body
startTimestring · date-timeRequired
Destination start time for the provided calendar event
endTimestring · date-timeRequired
Destination end time for the provided calendar event
statusstring · enumRead-onlyRequiredPossible values:
Responses
200
Returns an EventReschedule
application/json
startTimestring · date-timeRequired
Destination start time for the provided calendar event
endTimestring · date-timeRequired
Destination end time for the provided calendar event
statusstring · enumRead-onlyRequiredPossible values:
400
Returns an error
application/json
403
Returns an error
application/json
404
Returns an error
application/json
409
Returns an error
application/json
500
Returns an error
application/json
post/events/{eventId}/reschedules
POST /apis/v2/events/{eventId}/reschedules HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 77
{
"startTime": "2026-01-01T00:00:00.000Z",
"endTime": "2026-01-01T00:00:00.000Z"
}{
"startTime": "2026-01-01T00:00:00.000Z",
"endTime": "2026-01-01T00:00:00.000Z",
"status": "INVALID",
"errors": [
{
"code": "text",
"message": "text",
"details": {}
}
]
}get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
eventIdstringRequiredExample:
3857358a-59e8-4944-8c48-3345c4375b43Responses
200
Returns an EventVisibilityScheduleDto
application/json
idstring · nullableRequired
listDaysBeforenumberRequired
membersOnlyboolean · nullableRequired
executedboolean · nullableRead-onlyRequired
statusstring · enum · nullableRead-onlyRequiredPossible values:
_linksobjectRequired
403
User do not have the right permissions to perform this action
application/json
404
Event id not found
application/json
422
Returns an ErrorDto in case of validation errors or failures.
Possible error codes are:ER000: Publishing days before value for non members cannot be greater than the one set for members.
get/events/{eventId}/visibility-schedules
GET /apis/v2/events/{eventId}/visibility-schedules HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"id": "text",
"event": {
"id": "text"
},
"listDaysBefore": 1,
"membersOnly": true,
"executed": true,
"status": "INVALID",
"errors": [
{
"code": "text",
"message": "text",
"details": {}
}
],
"_links": {}
}put
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
eventIdstringRequiredExample:
3857358a-59e8-4944-8c48-3345c4375b43Body
_totalnumberRequired
Responses
200
Returns an EventVisibilityScheduleCollectionDto
application/json
_totalnumberRequired
400
Some of the provided information as part of the request is icorrect or missing
application/json
403
User do not have the right permissions to perform this action
application/json
404
Event id not found
application/json
409
Could not edit shared resource, another operation already in progress
application/json
422
Returns an ErrorDto in case of validation errors or failures.
Possible error codes are:ER000: Publishing days before value for non members cannot be greater than the one set for members.
put/events/{eventId}/visibility-schedules
PUT /apis/v2/events/{eventId}/visibility-schedules HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 120
{
"items": [
{
"id": "text",
"listDaysBefore": 1,
"membersOnly": true,
"_links": {}
}
],
"_total": 1,
"_links": {
"self": {
"href": "text"
}
}
}{
"items": [
{
"id": "text",
"event": {
"id": "text"
},
"listDaysBefore": 1,
"membersOnly": true,
"executed": true,
"status": "INVALID",
"errors": [
{
"code": "text",
"message": "text",
"details": {}
}
],
"_links": {}
}
],
"_total": 1,
"_links": {
"self": {
"href": "text"
}
}
}delete
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
eventIdstringRequiredExample:
3857358a-59e8-4944-8c48-3345c4375b43Responses
204
Deletes a set of EventVisibilityScheduleDto by eventId, and then returns an empty response
No content
403
User do not have the right permissions to perform this action
application/json
404
Event id not found
application/json
delete/events/{eventId}/visibility-schedules
DELETE /apis/v2/events/{eventId}/visibility-schedules HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
No content
get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
eventIdstringRequiredExample:
3857358a-59e8-4944-8c48-3345c4375b43Responses
200
Returns an EventAdmissionRate
application/json
regularnumberRequired
membernumberRead-onlyRequired
membersDefaultnumberRequired
chargingStrategystring · enum · nullableRequiredPossible values:
_linksobjectRequired
get/events/{eventId}/admission-rate
GET /apis/v2/events/{eventId}/admission-rate HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200
Returns an EventAdmissionRate
{
"regular": 1,
"member": 1,
"membersDefault": 1,
"dayPass": {
"id": "text",
"displayName": "text",
"rate": 1
},
"memberships": {
"items": [
{
"membership": {
"id": "text"
},
"rate": 1
}
],
"_total": 1,
"_links": {
"self": {
"href": "text"
}
}
},
"chargingStrategy": "spot+",
"_links": {}
}put
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
eventIdstringRequiredExample:
3857358a-59e8-4944-8c48-3345c4375b43Body
regularnumberRequired
membernumberRead-onlyRequired
membersDefaultnumberRequired
chargingStrategystring · enum · nullableRequiredPossible values:
_linksobjectRequired
Responses
200
Returns an EventAdmissionRate
application/json
regularnumberRequired
membernumberRead-onlyRequired
membersDefaultnumberRequired
chargingStrategystring · enum · nullableRequiredPossible values:
_linksobjectRequired
put/events/{eventId}/admission-rate
PUT /apis/v2/events/{eventId}/admission-rate HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 180
{
"regular": 1,
"membersDefault": 1,
"memberships": {
"items": [
{
"membership": {
"id": "text"
},
"rate": 1
}
],
"_total": 1,
"_links": {
"self": {
"href": "text"
}
}
},
"chargingStrategy": "spot+",
"_links": {}
}200
Returns an EventAdmissionRate
{
"regular": 1,
"member": 1,
"membersDefault": 1,
"dayPass": {
"id": "text",
"displayName": "text",
"rate": 1
},
"memberships": {
"items": [
{
"membership": {
"id": "text"
},
"rate": 1
}
],
"_total": 1,
"_links": {
"self": {
"href": "text"
}
}
},
"chargingStrategy": "spot+",
"_links": {}
}get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
eventIdstringRequiredExample:
3857358a-59e8-4944-8c48-3345c4375b43Responses
200
Returns an EventAdmissionDate
application/json
regularstring · date-time · nullableRequired
memberstring · date-time · nullableRead-onlyRequired
membersDefaultstring · date-time · nullableRequired
_linksobjectRequired
get/events/{eventId}/admission-date
GET /apis/v2/events/{eventId}/admission-date HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200
Returns an EventAdmissionDate
{
"regular": "2026-01-01T00:00:00.000Z",
"member": "2026-01-01T00:00:00.000Z",
"membersDefault": "2026-01-01T00:00:00.000Z",
"memberships": {
"items": [
{
"membership": {
"id": "text"
},
"date": "2026-01-01T00:00:00.000Z"
}
],
"_total": 1,
"_links": {
"self": {
"href": "text"
}
}
},
"_links": {}
}put
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
eventIdstringRequiredExample:
3857358a-59e8-4944-8c48-3345c4375b43Body
regularstring · date-time · nullableRequired
memberstring · date-time · nullableRead-onlyRequired
membersDefaultstring · date-time · nullableRequired
_linksobjectRequired
Responses
200
Returns an EventAdmissionDate
application/json
regularstring · date-time · nullableRequired
memberstring · date-time · nullableRead-onlyRequired
membersDefaultstring · date-time · nullableRequired
_linksobjectRequired
put/events/{eventId}/admission-date
PUT /apis/v2/events/{eventId}/admission-date HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 228
{
"regular": "2026-01-01T00:00:00.000Z",
"membersDefault": "2026-01-01T00:00:00.000Z",
"memberships": {
"items": [
{
"membership": {
"id": "text"
},
"date": "2026-01-01T00:00:00.000Z"
}
],
"_total": 1,
"_links": {
"self": {
"href": "text"
}
}
},
"_links": {}
}200
Returns an EventAdmissionDate
{
"regular": "2026-01-01T00:00:00.000Z",
"member": "2026-01-01T00:00:00.000Z",
"membersDefault": "2026-01-01T00:00:00.000Z",
"memberships": {
"items": [
{
"membership": {
"id": "text"
},
"date": "2026-01-01T00:00:00.000Z"
}
],
"_total": 1,
"_links": {
"self": {
"href": "text"
}
}
},
"_links": {}
}get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
eventIdstringRequiredExample:
3857358a-59e8-4944-8c48-3345c4375b43Responses
200
Returns a CoachProfileCollectionDto
application/json
_totalnumberRequired
403
Forbidden - insufficient permissions
404
Event not found
get/events/{eventId}/coaches
GET /apis/v2/events/{eventId}/coaches HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"items": [
{
"id": "text",
"user": {
"id": "text"
},
"type": "REGULAR",
"firstName": "text",
"lastName": "text",
"gender": "text",
"birthday": "2026-01-01T00:00:00.000Z",
"initials": "text",
"description": "text",
"picture": {},
"usattRating": 1,
"duprProfileUrl": "text",
"memberSince": "2026-01-01T00:00:00.000Z",
"membershipEnrollment": {},
"kids": {},
"_links": {},
"settings": {
"id": "text"
},
"tierSettings": {
"id": "text"
},
"rateSettings": {
"guests": 1,
"hourlyRate": 1
},
"fullName": "text",
"students": {
"_total": 1
},
"slug": "text",
"coachType": "ROBOT"
}
],
"_total": 1,
"_links": {
"self": {
"href": "text"
}
}
}post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
eventIdstringRequiredExample:
3857358a-59e8-4944-8c48-3345c4375b43Body
typestring · enumRequiredPossible values:
PREVIEW to calculate without persisting, ORDER to create and accept the invitation
_linksobjectRead-onlyRequired
Responses
201
Returns the EventCoachAdditionDto with created invitation (if ORDER) or preview summary (if PREVIEW)
application/json
typestring · enumRequiredPossible values:
PREVIEW to calculate without persisting, ORDER to create and accept the invitation
_linksobjectRead-onlyRequired
400
Bad request - validation errors
403
Forbidden - insufficient permissions
404
Event or coach not found
422
Unprocessable entity - validation errors
post/events/{eventId}/coaches
POST /apis/v2/events/{eventId}/coaches HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 74
{
"type": "PREVIEW",
"coach": {
"id": "text"
},
"rate": {
"type": "FIXED",
"value": 1
}
}{
"type": "PREVIEW",
"coach": {
"id": "text"
},
"summary": {
"coachRate": 1,
"effectiveRate": 1,
"discount": 1,
"errors": [
{
"code": "text",
"message": "text",
"details": {}
}
]
},
"invitation": {
"id": "text",
"createdDate": "2026-01-01T00:00:00.000Z",
"lastModifiedDate": "2026-01-01T00:00:00.000Z",
"type": "BOOKING",
"chargeType": "FREE",
"maxChargableAmount": 1,
"coachRate": 1,
"rateType": "FIXED",
"status": "INVITATION_EXTENDED",
"inviterProfile": {
"id": "text"
},
"inviteeProfile": {
"id": "text"
},
"checkIn": {
"id": "text",
"status": "NOT_CHECKED_IN",
"checkedInBy": {
"id": "text",
"user": {
"id": "text"
},
"type": "REGULAR",
"firstName": "text",
"lastName": "text",
"gender": "text",
"birthday": "2026-01-01T00:00:00.000Z",
"initials": "text",
"description": "text",
"picture": {},
"usattRating": 1,
"duprProfileUrl": "text",
"memberSince": "2026-01-01T00:00:00.000Z",
"membershipEnrollment": {},
"kids": {},
"_links": {}
},
"checkedInAt": "2026-01-01T00:00:00.000Z",
"flags": [
"REQUIRES_DAY_PASS"
],
"_links": {}
},
"inviteeVaccination": {
"status": "NOT_CHECKED",
"expiration": "2026-01-01T00:00:00.000Z",
"_links": {
"self": {
"href": "text"
}
}
},
"inviteeMetadata": {
"id": "text"
},
"invitee": {
"fullName": "text",
"email": "text",
"phoneNumber": "text",
"userId": "text"
},
"kid": {
"id": "text"
},
"inviteeNotes": "text",
"acceptUrl": {
"id": "text"
},
"order": {
"id": "text"
},
"openInvitation": {
"id": "text"
},
"errors": [
{
"code": "text",
"message": "text",
"details": {}
}
],
"_links": {}
},
"_links": {}
}get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
eventIdstringRequiredExample:
3857358a-59e8-4944-8c48-3345c4375b43Responses
200
Returns the tournament for the event
application/json
idstringRead-onlyRequiredExample:
Tournament Division ID
7229d7d5-5581-4d86-975f-5b7efc9b00e9providerstring · enumRequiredExample:
SWISHPossible values: statusstring · enumRead-onlyOptionalExample:
Current status of the tournament
DRAFTPossible values: createdAtstring · date-timeRead-onlyOptionalExample:
When the tournament was created
2025-07-09T17:32:26.800ZlastSyncedAtstring · date-timeOptionalExample:
Last time the tournament was synced with the provider
2025-07-09T17:32:26.800Zvisibilitystring · enumOptionalExample:
Visibility status: HIDDEN (admin only), VISIBLE (shown to users), or null
VISIBLEPossible values: _linksobjectRead-onlyRequired
403
Forbidden - insufficient permissions
application/json
404
Event not found or tournament not found
application/json
get/events/{eventId}/tournament-division
GET /apis/v2/events/{eventId}/tournament-division HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"id": "7229d7d5-5581-4d86-975f-5b7efc9b00e9",
"tournament": "7229d7d5-5581-4d86-975f-5b7efc9b00e9",
"provider": "SWISH",
"swish": {
"eventFormat": "rotating_partners_round_robin",
"gameId": "game123",
"editPlayersPath": "rotating-partners-round-robin"
},
"podplay": {
"eventFormat": "round_robin",
"gameId": "game123",
"url": "https://tournaments.podplay.app/admin/tournaments/game123"
},
"status": "DRAFT",
"createdAt": "2025-07-09T17:32:26.800Z",
"event": "7229d7d5-5581-4d86-975f-5b7efc9b00e9",
"lastSyncedAt": "2025-07-09T17:32:26.800Z",
"visibility": "VISIBLE",
"_links": {}
}post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
eventIdstringRequiredExample:
3857358a-59e8-4944-8c48-3345c4375b43Body
providerstring · enumRequiredExample:
SWISHPossible values: visibilitystring · enumOptionalExample:
Visibility status: HIDDEN (admin only), VISIBLE (shown to users), or null
VISIBLEPossible values: Responses
201
Tournament division created successfully
application/json
idstringRead-onlyRequiredExample:
Tournament Division ID
7229d7d5-5581-4d86-975f-5b7efc9b00e9providerstring · enumRequiredExample:
SWISHPossible values: statusstring · enumRead-onlyOptionalExample:
Current status of the tournament
DRAFTPossible values: createdAtstring · date-timeRead-onlyOptionalExample:
When the tournament was created
2025-07-09T17:32:26.800ZlastSyncedAtstring · date-timeOptionalExample:
Last time the tournament was synced with the provider
2025-07-09T17:32:26.800Zvisibilitystring · enumOptionalExample:
Visibility status: HIDDEN (admin only), VISIBLE (shown to users), or null
VISIBLEPossible values: _linksobjectRead-onlyRequired
400
Tournament division already exists for this event
application/json
403
Forbidden - insufficient permissions
application/json
404
Event not found
application/json
post/events/{eventId}/tournament-division
POST /apis/v2/events/{eventId}/tournament-division HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 293
{
"provider": "SWISH",
"swish": {
"eventFormat": "rotating_partners_round_robin",
"gameId": "game123",
"editPlayersPath": "rotating-partners-round-robin"
},
"podplay": {
"eventFormat": "round_robin",
"gameId": "game123",
"url": "https://tournaments.podplay.app/admin/tournaments/game123"
},
"visibility": "VISIBLE"
}{
"id": "7229d7d5-5581-4d86-975f-5b7efc9b00e9",
"tournament": "7229d7d5-5581-4d86-975f-5b7efc9b00e9",
"provider": "SWISH",
"swish": {
"eventFormat": "rotating_partners_round_robin",
"gameId": "game123",
"editPlayersPath": "rotating-partners-round-robin"
},
"podplay": {
"eventFormat": "round_robin",
"gameId": "game123",
"url": "https://tournaments.podplay.app/admin/tournaments/game123"
},
"status": "DRAFT",
"createdAt": "2025-07-09T17:32:26.800Z",
"event": "7229d7d5-5581-4d86-975f-5b7efc9b00e9",
"lastSyncedAt": "2025-07-09T17:32:26.800Z",
"visibility": "VISIBLE",
"_links": {}
}patch
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
eventIdstringRequiredExample:
3857358a-59e8-4944-8c48-3345c4375b43Body
visibilitystring · enumOptionalExample:
Visibility status: HIDDEN (admin only), VISIBLE (shown to users), or null
VISIBLEPossible values: Responses
200
Tournament division updated successfully
application/json
idstringRead-onlyRequiredExample:
Tournament Division ID
7229d7d5-5581-4d86-975f-5b7efc9b00e9providerstring · enumRequiredExample:
SWISHPossible values: statusstring · enumRead-onlyOptionalExample:
Current status of the tournament
DRAFTPossible values: createdAtstring · date-timeRead-onlyOptionalExample:
When the tournament was created
2025-07-09T17:32:26.800ZlastSyncedAtstring · date-timeOptionalExample:
Last time the tournament was synced with the provider
2025-07-09T17:32:26.800Zvisibilitystring · enumOptionalExample:
Visibility status: HIDDEN (admin only), VISIBLE (shown to users), or null
VISIBLEPossible values: _linksobjectRead-onlyRequired
403
Forbidden - insufficient permissions
application/json
404
Event or tournament division not found
application/json
patch/events/{eventId}/tournament-division
PATCH /apis/v2/events/{eventId}/tournament-division HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 274
{
"swish": {
"eventFormat": "rotating_partners_round_robin",
"gameId": "game123",
"editPlayersPath": "rotating-partners-round-robin"
},
"podplay": {
"eventFormat": "round_robin",
"gameId": "game123",
"url": "https://tournaments.podplay.app/admin/tournaments/game123"
},
"visibility": "VISIBLE"
}{
"id": "7229d7d5-5581-4d86-975f-5b7efc9b00e9",
"tournament": "7229d7d5-5581-4d86-975f-5b7efc9b00e9",
"provider": "SWISH",
"swish": {
"eventFormat": "rotating_partners_round_robin",
"gameId": "game123",
"editPlayersPath": "rotating-partners-round-robin"
},
"podplay": {
"eventFormat": "round_robin",
"gameId": "game123",
"url": "https://tournaments.podplay.app/admin/tournaments/game123"
},
"status": "DRAFT",
"createdAt": "2025-07-09T17:32:26.800Z",
"event": "7229d7d5-5581-4d86-975f-5b7efc9b00e9",
"lastSyncedAt": "2025-07-09T17:32:26.800Z",
"visibility": "VISIBLE",
"_links": {}
}get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
eventIdstringRequiredExample:
3857358a-59e8-4944-8c48-3345c4375b43Query parameters
expandstring[]Optional
Responses
200
Returns a InvitationCollection
application/json
_totalnumberRequired
get/events/{eventId}/invitations
GET /apis/v2/events/{eventId}/invitations HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200
Returns a InvitationCollection
{
"items": [
{
"id": "text",
"createdDate": "2026-01-01T00:00:00.000Z",
"lastModifiedDate": "2026-01-01T00:00:00.000Z",
"type": "BOOKING",
"chargeType": "FREE",
"maxChargableAmount": 1,
"coachRate": 1,
"rateType": "FIXED",
"status": "INVITATION_EXTENDED",
"inviterProfile": {
"id": "text"
},
"inviteeProfile": {
"id": "text"
},
"checkIn": {
"id": "text",
"status": "NOT_CHECKED_IN",
"checkedInBy": {
"id": "text",
"user": {
"id": "text"
},
"type": "REGULAR",
"firstName": "text",
"lastName": "text",
"gender": "text",
"birthday": "2026-01-01T00:00:00.000Z",
"initials": "text",
"description": "text",
"picture": {},
"usattRating": 1,
"duprProfileUrl": "text",
"memberSince": "2026-01-01T00:00:00.000Z",
"membershipEnrollment": {},
"kids": {},
"_links": {}
},
"checkedInAt": "2026-01-01T00:00:00.000Z",
"flags": [
"REQUIRES_DAY_PASS"
],
"_links": {}
},
"inviteeVaccination": {
"status": "NOT_CHECKED",
"expiration": "2026-01-01T00:00:00.000Z",
"_links": {
"self": {
"href": "text"
}
}
},
"inviteeMetadata": {
"id": "text"
},
"invitee": {
"fullName": "text",
"email": "text",
"phoneNumber": "text",
"userId": "text"
},
"kid": {
"id": "text"
},
"inviteeNotes": "text",
"acceptUrl": {
"id": "text"
},
"order": {
"id": "text"
},
"openInvitation": {
"id": "text"
},
"errors": [
{
"code": "text",
"message": "text",
"details": {}
}
],
"_links": {}
}
],
"_total": 1,
"_links": {
"self": {
"href": "text"
}
}
}post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
eventIdstringRequiredExample:
3857358a-59e8-4944-8c48-3345c4375b43Body
idstringRead-onlyRequired
createdDatestring · date-timeRead-onlyRequired
lastModifiedDatestring · date-timeRead-onlyRequired
typestring · enumRead-onlyRequiredPossible values:
chargeTypestring · enum · nullableRequiredPossible values:
maxChargableAmountnumberRead-onlyRequired
coachRatenumber · nullableRequired
rateTypestring · enum · nullableRead-onlyRequiredPossible values:
statusstring · enumRead-onlyRequiredPossible values:
inviteeNotesstringRead-onlyRequired
_linksobjectRead-onlyRequired
Responses
201
Returns the created Invitation
application/json
idstringRead-onlyRequired
createdDatestring · date-timeRead-onlyRequired
lastModifiedDatestring · date-timeRead-onlyRequired
typestring · enumRead-onlyRequiredPossible values:
chargeTypestring · enum · nullableRequiredPossible values:
maxChargableAmountnumberRead-onlyRequired
coachRatenumber · nullableRequired
rateTypestring · enum · nullableRead-onlyRequiredPossible values:
statusstring · enumRead-onlyRequiredPossible values:
inviteeNotesstringRead-onlyRequired
_linksobjectRead-onlyRequired
post/events/{eventId}/invitations
POST /apis/v2/events/{eventId}/invitations HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 137
{
"chargeType": "FREE",
"coachRate": 1,
"invitee": {
"fullName": "text",
"email": "text",
"phoneNumber": "text",
"userId": "text"
},
"kid": {
"id": "text"
}
}201
Returns the created Invitation
{
"id": "text",
"createdDate": "2026-01-01T00:00:00.000Z",
"lastModifiedDate": "2026-01-01T00:00:00.000Z",
"type": "BOOKING",
"chargeType": "FREE",
"maxChargableAmount": 1,
"coachRate": 1,
"rateType": "FIXED",
"status": "INVITATION_EXTENDED",
"inviterProfile": {
"id": "text"
},
"inviteeProfile": {
"id": "text"
},
"checkIn": {
"id": "text",
"status": "NOT_CHECKED_IN",
"checkedInBy": {
"id": "text",
"user": {
"id": "text"
},
"type": "REGULAR",
"firstName": "text",
"lastName": "text",
"gender": "text",
"birthday": "2026-01-01T00:00:00.000Z",
"initials": "text",
"description": "text",
"picture": {},
"usattRating": 1,
"duprProfileUrl": "text",
"memberSince": "2026-01-01T00:00:00.000Z",
"membershipEnrollment": {},
"kids": {},
"_links": {}
},
"checkedInAt": "2026-01-01T00:00:00.000Z",
"flags": [
"REQUIRES_DAY_PASS"
],
"_links": {}
},
"inviteeVaccination": {
"status": "NOT_CHECKED",
"expiration": "2026-01-01T00:00:00.000Z",
"_links": {
"self": {
"href": "text"
}
}
},
"inviteeMetadata": {
"id": "text"
},
"invitee": {
"fullName": "text",
"email": "text",
"phoneNumber": "text",
"userId": "text"
},
"kid": {
"id": "text"
},
"inviteeNotes": "text",
"acceptUrl": {
"id": "text"
},
"order": {
"id": "text"
},
"openInvitation": {
"id": "text"
},
"errors": [
{
"code": "text",
"message": "text",
"details": {}
}
],
"_links": {}
}get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
invitationIdstringRequiredExample:
76ef8398-df11-43b1-a1bb-3126b16bff0deventIdstringRequiredExample:
3857358a-59e8-4944-8c48-3345c4375b43Query parameters
expandstring[]Optional
Responses
200
Returns a Invitation
application/json
idstringRead-onlyRequired
createdDatestring · date-timeRead-onlyRequired
lastModifiedDatestring · date-timeRead-onlyRequired
typestring · enumRead-onlyRequiredPossible values:
chargeTypestring · enum · nullableRequiredPossible values:
maxChargableAmountnumberRead-onlyRequired
coachRatenumber · nullableRequired
rateTypestring · enum · nullableRead-onlyRequiredPossible values:
statusstring · enumRead-onlyRequiredPossible values:
inviteeNotesstringRead-onlyRequired
_linksobjectRead-onlyRequired
get/events/{eventId}/invitations/{invitationId}
GET /apis/v2/events/{eventId}/invitations/{invitationId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200
Returns a Invitation
{
"id": "text",
"createdDate": "2026-01-01T00:00:00.000Z",
"lastModifiedDate": "2026-01-01T00:00:00.000Z",
"type": "BOOKING",
"chargeType": "FREE",
"maxChargableAmount": 1,
"coachRate": 1,
"rateType": "FIXED",
"status": "INVITATION_EXTENDED",
"inviterProfile": {
"id": "text"
},
"inviteeProfile": {
"id": "text"
},
"checkIn": {
"id": "text",
"status": "NOT_CHECKED_IN",
"checkedInBy": {
"id": "text",
"user": {
"id": "text"
},
"type": "REGULAR",
"firstName": "text",
"lastName": "text",
"gender": "text",
"birthday": "2026-01-01T00:00:00.000Z",
"initials": "text",
"description": "text",
"picture": {},
"usattRating": 1,
"duprProfileUrl": "text",
"memberSince": "2026-01-01T00:00:00.000Z",
"membershipEnrollment": {},
"kids": {},
"_links": {}
},
"checkedInAt": "2026-01-01T00:00:00.000Z",
"flags": [
"REQUIRES_DAY_PASS"
],
"_links": {}
},
"inviteeVaccination": {
"status": "NOT_CHECKED",
"expiration": "2026-01-01T00:00:00.000Z",
"_links": {
"self": {
"href": "text"
}
}
},
"inviteeMetadata": {
"id": "text"
},
"invitee": {
"fullName": "text",
"email": "text",
"phoneNumber": "text",
"userId": "text"
},
"kid": {
"id": "text"
},
"inviteeNotes": "text",
"acceptUrl": {
"id": "text"
},
"order": {
"id": "text"
},
"openInvitation": {
"id": "text"
},
"errors": [
{
"code": "text",
"message": "text",
"details": {}
}
],
"_links": {}
}delete
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
invitationIdstringRequiredExample:
76ef8398-df11-43b1-a1bb-3126b16bff0deventIdstringRequiredExample:
3857358a-59e8-4944-8c48-3345c4375b43Responses
200
Returns the deleted Invitation
application/json
idstringRead-onlyRequired
createdDatestring · date-timeRead-onlyRequired
lastModifiedDatestring · date-timeRead-onlyRequired
typestring · enumRead-onlyRequiredPossible values:
chargeTypestring · enum · nullableRequiredPossible values:
maxChargableAmountnumberRead-onlyRequired
coachRatenumber · nullableRequired
rateTypestring · enum · nullableRead-onlyRequiredPossible values:
statusstring · enumRead-onlyRequiredPossible values:
inviteeNotesstringRead-onlyRequired
_linksobjectRead-onlyRequired
delete/events/{eventId}/invitations/{invitationId}
DELETE /apis/v2/events/{eventId}/invitations/{invitationId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200
Returns the deleted Invitation
{
"id": "text",
"createdDate": "2026-01-01T00:00:00.000Z",
"lastModifiedDate": "2026-01-01T00:00:00.000Z",
"type": "BOOKING",
"chargeType": "FREE",
"maxChargableAmount": 1,
"coachRate": 1,
"rateType": "FIXED",
"status": "INVITATION_EXTENDED",
"inviterProfile": {
"id": "text"
},
"inviteeProfile": {
"id": "text"
},
"checkIn": {
"id": "text",
"status": "NOT_CHECKED_IN",
"checkedInBy": {
"id": "text",
"user": {
"id": "text"
},
"type": "REGULAR",
"firstName": "text",
"lastName": "text",
"gender": "text",
"birthday": "2026-01-01T00:00:00.000Z",
"initials": "text",
"description": "text",
"picture": {},
"usattRating": 1,
"duprProfileUrl": "text",
"memberSince": "2026-01-01T00:00:00.000Z",
"membershipEnrollment": {},
"kids": {},
"_links": {}
},
"checkedInAt": "2026-01-01T00:00:00.000Z",
"flags": [
"REQUIRES_DAY_PASS"
],
"_links": {}
},
"inviteeVaccination": {
"status": "NOT_CHECKED",
"expiration": "2026-01-01T00:00:00.000Z",
"_links": {
"self": {
"href": "text"
}
}
},
"inviteeMetadata": {
"id": "text"
},
"invitee": {
"fullName": "text",
"email": "text",
"phoneNumber": "text",
"userId": "text"
},
"kid": {
"id": "text"
},
"inviteeNotes": "text",
"acceptUrl": {
"id": "text"
},
"order": {
"id": "text"
},
"openInvitation": {
"id": "text"
},
"errors": [
{
"code": "text",
"message": "text",
"details": {}
}
],
"_links": {}
}patch
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
invitationIdstringRequiredExample:
76ef8398-df11-43b1-a1bb-3126b16bff0deventIdstringRequiredExample:
3857358a-59e8-4944-8c48-3345c4375b43Body
typestring · enumWrite-onlyRequiredPossible values:
statusstring · enumWrite-onlyRequiredPossible values:
chargeTypestring · enum · nullableWrite-onlyRequiredPossible values:
coachRatenumber · nullableRequired
inviteeNotesstringWrite-onlyRequired
Responses
200
Returns the updated Invitation
application/json
idstringRead-onlyRequired
createdDatestring · date-timeRead-onlyRequired
lastModifiedDatestring · date-timeRead-onlyRequired
typestring · enumRead-onlyRequiredPossible values:
chargeTypestring · enum · nullableRequiredPossible values:
maxChargableAmountnumberRead-onlyRequired
coachRatenumber · nullableRequired
rateTypestring · enum · nullableRead-onlyRequiredPossible values:
statusstring · enumRead-onlyRequiredPossible values:
inviteeNotesstringRead-onlyRequired
_linksobjectRead-onlyRequired
422
Returns an ErrorDto in case of validation errors or failures.
Possible error codes are:I001: You cannot set the same charge typeI002: Charge type cannot be changed after the invitation has been acceptedI004: Virtual credits must be a positive number.I005: User has insufficient virtual credits.I030: User phone number is required.I040: Unable to proceed with the current payment method. Please try using a different one.I041: Prepaid cards are not accepted, please use a credit or debit card.I042: There's no payment method set up.I043: Split payment requires a registered user account.RA001: Could not confirm the payment. Please try again.I050: Liability waiver acceptance is required.I051: Liability Waiver agreement not found. Please contact support.I060: There's already a pending invitation for this event.I061: There are no redeems left in this invitation.I062: There are no spots left in this event.I070: Your DUPR account is not connected.I071: Your rating is not available.I072: Your {{rating}} rating is too low for this event. It must be at least {{minRating}}.I073: Your {{rating}} rating is too high for this event. It must be at most {{maxRating}}.
patch/events/{eventId}/invitations/{invitationId}
PATCH /apis/v2/events/{eventId}/invitations/{invitationId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 122
{
"type": "COACH",
"status": "ACCEPTED",
"chargeType": "FREE",
"coachRate": 1,
"invitee": {
"fullName": "text"
},
"inviteeNotes": "text"
}{
"id": "text",
"createdDate": "2026-01-01T00:00:00.000Z",
"lastModifiedDate": "2026-01-01T00:00:00.000Z",
"type": "BOOKING",
"chargeType": "FREE",
"maxChargableAmount": 1,
"coachRate": 1,
"rateType": "FIXED",
"status": "INVITATION_EXTENDED",
"inviterProfile": {
"id": "text"
},
"inviteeProfile": {
"id": "text"
},
"checkIn": {
"id": "text",
"status": "NOT_CHECKED_IN",
"checkedInBy": {
"id": "text",
"user": {
"id": "text"
},
"type": "REGULAR",
"firstName": "text",
"lastName": "text",
"gender": "text",
"birthday": "2026-01-01T00:00:00.000Z",
"initials": "text",
"description": "text",
"picture": {},
"usattRating": 1,
"duprProfileUrl": "text",
"memberSince": "2026-01-01T00:00:00.000Z",
"membershipEnrollment": {},
"kids": {},
"_links": {}
},
"checkedInAt": "2026-01-01T00:00:00.000Z",
"flags": [
"REQUIRES_DAY_PASS"
],
"_links": {}
},
"inviteeVaccination": {
"status": "NOT_CHECKED",
"expiration": "2026-01-01T00:00:00.000Z",
"_links": {
"self": {
"href": "text"
}
}
},
"inviteeMetadata": {
"id": "text"
},
"invitee": {
"fullName": "text",
"email": "text",
"phoneNumber": "text",
"userId": "text"
},
"kid": {
"id": "text"
},
"inviteeNotes": "text",
"acceptUrl": {
"id": "text"
},
"order": {
"id": "text"
},
"openInvitation": {
"id": "text"
},
"errors": [
{
"code": "text",
"message": "text",
"details": {}
}
],
"_links": {}
}post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
invitationIdstringRequiredExample:
76ef8398-df11-43b1-a1bb-3126b16bff0deventIdstringRequiredExample:
3857358a-59e8-4944-8c48-3345c4375b43Body
typestring · enumRequiredPossible values:
invitationTypestring · enum · nullableWrite-onlyRequiredPossible values:
coachRatenumber · nullableWrite-onlyRequired
virtualCreditsnumber · nullableWrite-onlyRequired
passesStrategystring · enum · nullableWrite-onlyRequiredPossible values:
_linksobjectRead-onlyRequired
Responses
201
Returns the InvitationAcceptanceDto
application/json
typestring · enumRequiredPossible values:
invitationTypestring · enum · nullableWrite-onlyRequiredPossible values:
coachRatenumber · nullableWrite-onlyRequired
virtualCreditsnumber · nullableWrite-onlyRequired
passesStrategystring · enum · nullableWrite-onlyRequiredPossible values:
_linksobjectRead-onlyRequired
422
Returns an ErrorDto in case of validation errors or failures.
Possible error codes are:I001: You cannot set the same charge typeI002: Charge type cannot be changed after the invitation has been acceptedI004: Virtual credits must be a positive number.I005: User has insufficient virtual credits.I030: User phone number is required.I040: Unable to proceed with the current payment method. Please try using a different one.I041: Prepaid cards are not accepted, please use a credit or debit card.I042: There's no payment method set up.I043: Split payment requires a registered user account.RA001: Could not confirm the payment. Please try again.I050: Liability waiver acceptance is required.I051: Liability Waiver agreement not found. Please contact support.I060: There's already a pending invitation for this event.I061: There are no redeems left in this invitation.I062: There are no spots left in this event.I070: Your DUPR account is not connected.I071: Your rating is not available.I072: Your {{rating}} rating is too low for this event. It must be at least {{minRating}}.I073: Your {{rating}} rating is too high for this event. It must be at most {{maxRating}}.
post/events/{eventId}/invitations/{invitationId}/acceptance
POST /apis/v2/events/{eventId}/invitations/{invitationId}/acceptance HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 103
{
"type": "PREVIEW",
"invitationType": "COACH",
"coachRate": 1,
"virtualCredits": 1,
"passesStrategy": "USE_ALL"
}{
"type": "PREVIEW",
"summary": {
"subtotal": 1,
"taxes": [
{
"name": "text",
"amount": 1,
"percentage": 1
}
],
"virtualCredits": 1,
"total": 1,
"passes": {
"items": [
{
"id": {},
"available": 1,
"quantity": 1,
"displayName": "text",
"displayNamePlural": "text",
"rate": 1
}
],
"_total": 1,
"_links": {}
},
"errors": [
{
"code": "text",
"message": "text",
"details": {}
}
],
"messages": [
{
"code": "text",
"message": "text"
}
]
},
"invitation": {
"id": "text"
},
"_links": {}
}get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
invitationIdstringRequiredExample:
76ef8398-df11-43b1-a1bb-3126b16bff0deventIdstringRequiredExample:
3857358a-59e8-4944-8c48-3345c4375b43Responses
200
Returns the InvitationCheckIn
application/json
idstringRead-onlyRequired
createdDatestring · date-timeRead-onlyRequired
lastModifiedDatestring · date-timeRead-onlyRequired
typestring · enumRead-onlyRequiredPossible values:
chargeTypestring · enum · nullableRequiredPossible values:
maxChargableAmountnumberRead-onlyRequired
coachRatenumber · nullableRequired
rateTypestring · enum · nullableRead-onlyRequiredPossible values:
statusstring · enumRead-onlyRequiredPossible values:
inviteeNotesstringRead-onlyRequired
_linksobjectRead-onlyRequired
get/events/{eventId}/invitations/{invitationId}/check-in
GET /apis/v2/events/{eventId}/invitations/{invitationId}/check-in HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200
Returns the InvitationCheckIn
{
"id": "text",
"createdDate": "2026-01-01T00:00:00.000Z",
"lastModifiedDate": "2026-01-01T00:00:00.000Z",
"type": "BOOKING",
"chargeType": "FREE",
"maxChargableAmount": 1,
"coachRate": 1,
"rateType": "FIXED",
"status": "INVITATION_EXTENDED",
"inviterProfile": {
"id": "text"
},
"inviteeProfile": {
"id": "text"
},
"checkIn": {
"id": "text",
"status": "NOT_CHECKED_IN",
"checkedInBy": {
"id": "text",
"user": {
"id": "text"
},
"type": "REGULAR",
"firstName": "text",
"lastName": "text",
"gender": "text",
"birthday": "2026-01-01T00:00:00.000Z",
"initials": "text",
"description": "text",
"picture": {},
"usattRating": 1,
"duprProfileUrl": "text",
"memberSince": "2026-01-01T00:00:00.000Z",
"membershipEnrollment": {},
"kids": {},
"_links": {}
},
"checkedInAt": "2026-01-01T00:00:00.000Z",
"flags": [
"REQUIRES_DAY_PASS"
],
"_links": {}
},
"inviteeVaccination": {
"status": "NOT_CHECKED",
"expiration": "2026-01-01T00:00:00.000Z",
"_links": {
"self": {
"href": "text"
}
}
},
"inviteeMetadata": {
"id": "text"
},
"invitee": {
"fullName": "text",
"email": "text",
"phoneNumber": "text",
"userId": "text"
},
"kid": {
"id": "text"
},
"inviteeNotes": "text",
"acceptUrl": {
"id": "text"
},
"order": {
"id": "text"
},
"openInvitation": {
"id": "text"
},
"errors": [
{
"code": "text",
"message": "text",
"details": {}
}
],
"_links": {}
}post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
invitationIdstringRequiredExample:
76ef8398-df11-43b1-a1bb-3126b16bff0deventIdstringRequiredExample:
3857358a-59e8-4944-8c48-3345c4375b43Responses
201
Returns the checked-in Invitation
application/json
idstringRead-onlyRequired
createdDatestring · date-timeRead-onlyRequired
lastModifiedDatestring · date-timeRead-onlyRequired
typestring · enumRead-onlyRequiredPossible values:
chargeTypestring · enum · nullableRequiredPossible values:
maxChargableAmountnumberRead-onlyRequired
coachRatenumber · nullableRequired
rateTypestring · enum · nullableRead-onlyRequiredPossible values:
statusstring · enumRead-onlyRequiredPossible values:
inviteeNotesstringRead-onlyRequired
_linksobjectRead-onlyRequired
post/events/{eventId}/invitations/{invitationId}/check-in
POST /apis/v2/events/{eventId}/invitations/{invitationId}/check-in HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
201
Returns the checked-in Invitation
{
"id": "text",
"createdDate": "2026-01-01T00:00:00.000Z",
"lastModifiedDate": "2026-01-01T00:00:00.000Z",
"type": "BOOKING",
"chargeType": "FREE",
"maxChargableAmount": 1,
"coachRate": 1,
"rateType": "FIXED",
"status": "INVITATION_EXTENDED",
"inviterProfile": {
"id": "text"
},
"inviteeProfile": {
"id": "text"
},
"checkIn": {
"id": "text",
"status": "NOT_CHECKED_IN",
"checkedInBy": {
"id": "text",
"user": {
"id": "text"
},
"type": "REGULAR",
"firstName": "text",
"lastName": "text",
"gender": "text",
"birthday": "2026-01-01T00:00:00.000Z",
"initials": "text",
"description": "text",
"picture": {},
"usattRating": 1,
"duprProfileUrl": "text",
"memberSince": "2026-01-01T00:00:00.000Z",
"membershipEnrollment": {},
"kids": {},
"_links": {}
},
"checkedInAt": "2026-01-01T00:00:00.000Z",
"flags": [
"REQUIRES_DAY_PASS"
],
"_links": {}
},
"inviteeVaccination": {
"status": "NOT_CHECKED",
"expiration": "2026-01-01T00:00:00.000Z",
"_links": {
"self": {
"href": "text"
}
}
},
"inviteeMetadata": {
"id": "text"
},
"invitee": {
"fullName": "text",
"email": "text",
"phoneNumber": "text",
"userId": "text"
},
"kid": {
"id": "text"
},
"inviteeNotes": "text",
"acceptUrl": {
"id": "text"
},
"order": {
"id": "text"
},
"openInvitation": {
"id": "text"
},
"errors": [
{
"code": "text",
"message": "text",
"details": {}
}
],
"_links": {}
}delete
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
invitationIdstringRequiredExample:
76ef8398-df11-43b1-a1bb-3126b16bff0deventIdstringRequiredExample:
3857358a-59e8-4944-8c48-3345c4375b43Responses
200
Returns the Invitation reflecting the new status
application/json
idstringRead-onlyRequired
createdDatestring · date-timeRead-onlyRequired
lastModifiedDatestring · date-timeRead-onlyRequired
typestring · enumRead-onlyRequiredPossible values:
chargeTypestring · enum · nullableRequiredPossible values:
maxChargableAmountnumberRead-onlyRequired
coachRatenumber · nullableRequired
rateTypestring · enum · nullableRead-onlyRequiredPossible values:
statusstring · enumRead-onlyRequiredPossible values:
inviteeNotesstringRead-onlyRequired
_linksobjectRead-onlyRequired
delete/events/{eventId}/invitations/{invitationId}/check-in
DELETE /apis/v2/events/{eventId}/invitations/{invitationId}/check-in HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200
Returns the Invitation reflecting the new status
{
"id": "text",
"createdDate": "2026-01-01T00:00:00.000Z",
"lastModifiedDate": "2026-01-01T00:00:00.000Z",
"type": "BOOKING",
"chargeType": "FREE",
"maxChargableAmount": 1,
"coachRate": 1,
"rateType": "FIXED",
"status": "INVITATION_EXTENDED",
"inviterProfile": {
"id": "text"
},
"inviteeProfile": {
"id": "text"
},
"checkIn": {
"id": "text",
"status": "NOT_CHECKED_IN",
"checkedInBy": {
"id": "text",
"user": {
"id": "text"
},
"type": "REGULAR",
"firstName": "text",
"lastName": "text",
"gender": "text",
"birthday": "2026-01-01T00:00:00.000Z",
"initials": "text",
"description": "text",
"picture": {},
"usattRating": 1,
"duprProfileUrl": "text",
"memberSince": "2026-01-01T00:00:00.000Z",
"membershipEnrollment": {},
"kids": {},
"_links": {}
},
"checkedInAt": "2026-01-01T00:00:00.000Z",
"flags": [
"REQUIRES_DAY_PASS"
],
"_links": {}
},
"inviteeVaccination": {
"status": "NOT_CHECKED",
"expiration": "2026-01-01T00:00:00.000Z",
"_links": {
"self": {
"href": "text"
}
}
},
"inviteeMetadata": {
"id": "text"
},
"invitee": {
"fullName": "text",
"email": "text",
"phoneNumber": "text",
"userId": "text"
},
"kid": {
"id": "text"
},
"inviteeNotes": "text",
"acceptUrl": {
"id": "text"
},
"order": {
"id": "text"
},
"openInvitation": {
"id": "text"
},
"errors": [
{
"code": "text",
"message": "text",
"details": {}
}
],
"_links": {}
}post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
invitationIdstringRequiredExample:
76ef8398-df11-43b1-a1bb-3126b16bff0deventIdstringRequiredExample:
3857358a-59e8-4944-8c48-3345c4375b43Body
vaccinationProofstring · binaryRequired
customerIdstring · binaryRequired
preCheckOptOutbooleanRequired
Responses
201Success
No content
post/events/{eventId}/invitations/{invitationId}/invitee-vaccination-proof
POST /apis/v2/events/{eventId}/invitations/{invitationId}/invitee-vaccination-proof HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: multipart/form-data
Accept: */*
Content-Length: 73
{
"vaccinationProof": "binary",
"customerId": "binary",
"preCheckOptOut": true
}201Success
No content
get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
invitationIdstringRequiredExample:
76ef8398-df11-43b1-a1bb-3126b16bff0deventIdstringRequiredExample:
3857358a-59e8-4944-8c48-3345c4375b43Responses
200Success
No content
get/events/{eventId}/invitations/{invitationId}/invitee-vaccination-proof/vaccination-proof
GET /apis/v2/events/{eventId}/invitations/{invitationId}/invitee-vaccination-proof/vaccination-proof HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200Success
No content
get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
invitationIdstringRequiredExample:
76ef8398-df11-43b1-a1bb-3126b16bff0deventIdstringRequiredExample:
3857358a-59e8-4944-8c48-3345c4375b43Responses
200Success
No content
get/events/{eventId}/invitations/{invitationId}/invitee-vaccination-proof/customer-id
GET /apis/v2/events/{eventId}/invitations/{invitationId}/invitee-vaccination-proof/customer-id HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200Success
No content
get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
invitationIdstringRequiredExample:
76ef8398-df11-43b1-a1bb-3126b16bff0deventIdstringRequiredExample:
3857358a-59e8-4944-8c48-3345c4375b43Responses
200
Returns the InviteeVaccination
application/json
statusstring · enumRequiredPossible values:
expirationstring · date-time · nullableRequired
get/events/{eventId}/invitations/{invitationId}/invitee-vaccination
GET /apis/v2/events/{eventId}/invitations/{invitationId}/invitee-vaccination HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200
Returns the InviteeVaccination
{
"status": "NOT_CHECKED",
"expiration": "2026-01-01T00:00:00.000Z",
"_links": {
"self": {
"href": "text"
}
}
}post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
invitationIdstringRequiredExample:
76ef8398-df11-43b1-a1bb-3126b16bff0deventIdstringRequiredExample:
3857358a-59e8-4944-8c48-3345c4375b43Body
statusstring · enumRequiredPossible values:
expirationstring · date-time · nullableRequired
Responses
201
Returns the created InviteeVaccination
application/json
statusstring · enumRequiredPossible values:
expirationstring · date-time · nullableRequired
post/events/{eventId}/invitations/{invitationId}/invitee-vaccination
POST /apis/v2/events/{eventId}/invitations/{invitationId}/invitee-vaccination HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 64
{
"status": "NOT_CHECKED",
"expiration": "2026-01-01T00:00:00.000Z"
}201
Returns the created InviteeVaccination
{
"status": "NOT_CHECKED",
"expiration": "2026-01-01T00:00:00.000Z",
"_links": {
"self": {
"href": "text"
}
}
}put
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
invitationIdstringRequiredExample:
76ef8398-df11-43b1-a1bb-3126b16bff0deventIdstringRequiredExample:
3857358a-59e8-4944-8c48-3345c4375b43Responses
200
Returns the updated InviteeVaccination
application/json
statusstring · enumRequiredPossible values:
expirationstring · date-time · nullableRequired
put/events/{eventId}/invitations/{invitationId}/invitee-vaccination
PUT /apis/v2/events/{eventId}/invitations/{invitationId}/invitee-vaccination HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200
Returns the updated InviteeVaccination
{
"status": "NOT_CHECKED",
"expiration": "2026-01-01T00:00:00.000Z",
"_links": {
"self": {
"href": "text"
}
}
}delete
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
invitationIdstringRequiredExample:
76ef8398-df11-43b1-a1bb-3126b16bff0deventIdstringRequiredExample:
3857358a-59e8-4944-8c48-3345c4375b43Responses
200
Returns the InviteeVaccination reflecting the new status
application/json
statusstring · enumRequiredPossible values:
expirationstring · date-time · nullableRequired
delete/events/{eventId}/invitations/{invitationId}/invitee-vaccination
DELETE /apis/v2/events/{eventId}/invitations/{invitationId}/invitee-vaccination HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200
Returns the InviteeVaccination reflecting the new status
{
"status": "NOT_CHECKED",
"expiration": "2026-01-01T00:00:00.000Z",
"_links": {
"self": {
"href": "text"
}
}
}get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
invitationIdstringRequiredExample:
6501176d-5ed1-4e20-abef-c2f7e4299e7deventIdstringRequiredExample:
340e565e-5414-436f-bf04-42c033cd5c9cResponses
200
Returns the InviteeVaccination
application/json
idstringRead-onlyRequired
tagsstring[]Required
get/events/{eventId}/invitations/{invitationId}/invitee-metadata
GET /apis/v2/events/{eventId}/invitations/{invitationId}/invitee-metadata HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200
Returns the InviteeVaccination
{
"id": "text",
"tags": [
"text"
],
"_links": {
"self": {
"href": "text"
}
}
}post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
eventIdstringRequiredExample:
3857358a-59e8-4944-8c48-3345c4375b43Body
typestring · enumRequiredPossible values:
PREVIEW returns calculated costs without creating records. ORDER creates and accepts the invitation.
chargeTypestring · enumRequiredPossible values:
How the guest spot will be charged. SPLIT_PAYMENT charges the invitee, PAID_BY_INVITER charges the booking owner.
virtualCreditsnumber · nullableWrite-onlyRequired
Amount of virtual credits to apply to the invitation (in dollars)
passesStrategystring · enum · nullableWrite-onlyRequiredPossible values:
Whether to apply available play passes. Defaults to USE_ALL.
_linksobjectRead-onlyRequired
HATEOAS links to related resources
Responses
200
PREVIEW: Returns cost summary without creating records
application/json
typestring · enumRequiredPossible values:
PREVIEW returns calculated costs without creating records. ORDER creates and accepts the invitation.
chargeTypestring · enumRequiredPossible values:
How the guest spot will be charged. SPLIT_PAYMENT charges the invitee, PAID_BY_INVITER charges the booking owner.
virtualCreditsnumber · nullableWrite-onlyRequired
Amount of virtual credits to apply to the invitation (in dollars)
passesStrategystring · enum · nullableWrite-onlyRequiredPossible values:
Whether to apply available play passes. Defaults to USE_ALL.
_linksobjectRead-onlyRequired
HATEOAS links to related resources
201
ORDER: Creates and accepts participant invitation
application/json
422
Validation errors
application/json
post/events/{eventId}/participants
POST /apis/v2/events/{eventId}/participants HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 175
{
"type": "PREVIEW",
"invitee": {
"fullName": "text",
"email": "text",
"phoneNumber": "text",
"userId": "text"
},
"chargeType": "SPLIT_PAYMENT",
"virtualCredits": 1,
"passesStrategy": "USE_ALL"
}{
"type": "PREVIEW",
"invitee": {
"fullName": "text",
"email": "text",
"phoneNumber": "text",
"userId": "text"
},
"chargeType": "SPLIT_PAYMENT",
"errors": [
{
"code": "text",
"message": "text",
"details": {}
}
],
"invitation": {
"id": "text",
"createdDate": "2026-01-01T00:00:00.000Z",
"lastModifiedDate": "2026-01-01T00:00:00.000Z",
"type": "BOOKING",
"chargeType": "FREE",
"maxChargableAmount": 1,
"coachRate": 1,
"rateType": "FIXED",
"status": "INVITATION_EXTENDED",
"inviterProfile": {
"id": "text"
},
"inviteeProfile": {
"id": "text"
},
"checkIn": {
"id": "text",
"status": "NOT_CHECKED_IN",
"checkedInBy": {
"id": "text",
"user": {
"id": "text"
},
"type": "REGULAR",
"firstName": "text",
"lastName": "text",
"gender": "text",
"birthday": "2026-01-01T00:00:00.000Z",
"initials": "text",
"description": "text",
"picture": {},
"usattRating": 1,
"duprProfileUrl": "text",
"memberSince": "2026-01-01T00:00:00.000Z",
"membershipEnrollment": {},
"kids": {},
"_links": {}
},
"checkedInAt": "2026-01-01T00:00:00.000Z",
"flags": [
"REQUIRES_DAY_PASS"
],
"_links": {}
},
"inviteeVaccination": {
"status": "NOT_CHECKED",
"expiration": "2026-01-01T00:00:00.000Z",
"_links": {
"self": {
"href": "text"
}
}
},
"inviteeMetadata": {
"id": "text"
},
"invitee": {
"fullName": "text",
"email": "text",
"phoneNumber": "text",
"userId": "text"
},
"kid": {
"id": "text"
},
"inviteeNotes": "text",
"acceptUrl": {
"id": "text"
},
"order": {
"id": "text"
},
"openInvitation": {
"id": "text"
},
"errors": [
{
"code": "text",
"message": "text",
"details": {}
}
],
"_links": {}
},
"summary": {
"subtotal": 1,
"taxes": [
{
"name": "text",
"amount": 1,
"percentage": 1
}
],
"virtualCredits": 1,
"total": 1,
"passes": {
"items": [
{
"id": {},
"available": 1,
"quantity": 1,
"displayName": "text",
"displayNamePlural": "text",
"rate": 1
}
],
"_total": 1,
"_links": {}
},
"errors": [
{
"code": "text",
"message": "text",
"details": {}
}
],
"messages": [
{
"code": "text",
"message": "text"
}
]
},
"_links": {}
}get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
eventIdstringRequiredExample:
3857358a-59e8-4944-8c48-3345c4375b43Query parameters
expandstring[]OptionalExample:
["items._links.userProfile"]Responses
200
Returns a WaitlistedUserCollection
application/json
_totalnumberRequired
get/events/{eventId}/waitlist
GET /apis/v2/events/{eventId}/waitlist HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200
Returns a WaitlistedUserCollection
{
"items": [
{
"id": "text",
"type": "PASSIVE_ENROLLMENT",
"enrollTime": "2026-01-01T00:00:00.000Z",
"errors": [
{
"code": "text",
"message": "text",
"details": {}
}
],
"userProfile": {
"id": "text"
},
"_links": {}
}
],
"_total": 1,
"_links": {
"self": {
"href": "text"
}
}
}post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
eventIdstringRequiredExample:
3857358a-59e8-4944-8c48-3345c4375b43Body
typestring · enumWrite-onlyOptionalPossible values:
The type of enrollment.
Responses
201
Returns the created WaitlistedUser
application/json
idstringRead-onlyRequired
typestring · enumRequiredPossible values:
enrollTimestring · date-timeRead-onlyRequired
_linksobjectRequired
post/events/{eventId}/waitlist
POST /apis/v2/events/{eventId}/waitlist HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 51
{
"owner": {
"id": "text"
},
"type": "PASSIVE_ENROLLMENT"
}201
Returns the created WaitlistedUser
{
"id": "text",
"type": "PASSIVE_ENROLLMENT",
"enrollTime": "2026-01-01T00:00:00.000Z",
"errors": [
{
"code": "text",
"message": "text",
"details": {}
}
],
"userProfile": {
"id": "text"
},
"_links": {}
}get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
waitlistedUserIdstringRequired
eventIdstringRequiredExample:
3857358a-59e8-4944-8c48-3345c4375b43Query parameters
expandstring[]Optional
Responses
200
Returns a WaitlistedUser
application/json
idstringRead-onlyRequired
typestring · enumRequiredPossible values:
enrollTimestring · date-timeRead-onlyRequired
_linksobjectRequired
get/events/{eventId}/waitlist/{waitlistedUserId}
GET /apis/v2/events/{eventId}/waitlist/{waitlistedUserId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200
Returns a WaitlistedUser
{
"id": "text",
"type": "PASSIVE_ENROLLMENT",
"enrollTime": "2026-01-01T00:00:00.000Z",
"errors": [
{
"code": "text",
"message": "text",
"details": {}
}
],
"userProfile": {
"id": "text"
},
"_links": {}
}delete
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
waitlistedUserIdstringRequired
eventIdstringRequiredExample:
3857358a-59e8-4944-8c48-3345c4375b43Query parameters
expandstring[]Optional
Responses
200
Deletes a WaitlistedUser
application/json
idstringRead-onlyRequired
typestring · enumRequiredPossible values:
enrollTimestring · date-timeRead-onlyRequired
_linksobjectRequired
delete/events/{eventId}/waitlist/{waitlistedUserId}
DELETE /apis/v2/events/{eventId}/waitlist/{waitlistedUserId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200
Deletes a WaitlistedUser
{
"id": "text",
"type": "PASSIVE_ENROLLMENT",
"enrollTime": "2026-01-01T00:00:00.000Z",
"errors": [
{
"code": "text",
"message": "text",
"details": {}
}
],
"userProfile": {
"id": "text"
},
"_links": {}
}get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
recurrenceIdstringRequiredExample:
5d57c02b-c7d3-94c3-9ae5-355026db62e0Responses
200
Returns an EventsRecurrenceDto
application/json
idstringRead-onlyRequired
createdDatestring · date-timeRead-onlyRequired
cadencestring · enumRead-onlyRequiredPossible values:
daysOfWeeknumber[]Read-onlyRequired
untilstring · date-timeRead-onlyRequired
_linksobjectRequired
get/events/recurrence/{recurrenceId}
GET /apis/v2/events/recurrence/{recurrenceId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200
Returns an EventsRecurrenceDto
{
"id": "text",
"user": {
"id": "text"
},
"createdDate": "2026-01-01T00:00:00.000Z",
"cadence": "day",
"daysOfWeek": [
1
],
"until": "2026-01-01T00:00:00.000Z",
"events": {
"items": [
"text"
],
"_total": 1,
"_links": {
"self": {
"href": "text"
}
}
},
"_links": {}
}patch
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
recurrenceIdstringRequiredExample:
5d57c02b-c7d3-94c3-9ae5-355026db62e0Body
namestringRequired
descriptionstringRequired
startTimestring · date-timeRequired
endTimestring · date-timeRequired
totalTeamsnumberRequired
teamSizenumberRequired
admissionstring · enumRequiredPossible values:
admissionKidsstring · enumRequiredPossible values:
allowedMembershipsobjectRequired
coachRatenumberRequired
freeSignupCancellationHorizonHoursnumberRequired
tagsstring[]Required
visibilitystring · enumRequiredPossible values:
statusstring · enumRequiredPossible values:
idstringWrite-onlyRequired
bulkUpdateTypestring · enumWrite-onlyRequiredPossible values:
Responses
200Success
No content
patch/events/recurrence/{recurrenceId}
PATCH /apis/v2/events/recurrence/{recurrenceId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1580
{
"name": "text",
"description": "text",
"startTime": "2026-01-01T00:00:00.000Z",
"endTime": "2026-01-01T00:00:00.000Z",
"guests": {
"displayName": "text",
"displayNameShort": "text",
"max": 1
},
"totalTeams": 1,
"teamSize": 1,
"admission": "OPEN",
"admissionRating": {
"minRating": 1,
"maxRating": 1,
"type": "SINGLES"
},
"admissionRate": {
"regular": 1,
"membersDefault": 1,
"memberships": {
"items": [
{
"membership": {
"id": "text"
},
"rate": 1
}
],
"_total": 1,
"_links": {
"self": {
"href": "text"
}
}
},
"chargingStrategy": "spot+",
"_links": {}
},
"admissionDate": {
"regular": "2026-01-01T00:00:00.000Z",
"membersDefault": "2026-01-01T00:00:00.000Z",
"memberships": {
"items": [
{
"membership": {
"id": "text"
},
"date": "2026-01-01T00:00:00.000Z"
}
],
"_total": 1,
"_links": {
"self": {
"href": "text"
}
}
},
"_links": {}
},
"admissionKids": "OPEN",
"allowedMemberships": {},
"coachRate": 1,
"freeSignupCancellationHorizonHours": 1,
"tags": [
"text"
],
"picture": {
"id": "text"
},
"visibility": "LISTED",
"features": [
"WAITLIST"
],
"status": "INVALID",
"tournamentDivision": {
"provider": "SWISH",
"swish": {
"eventFormat": "rotating_partners_round_robin",
"gameId": "game123",
"editPlayersPath": "rotating-partners-round-robin"
},
"podplay": {
"eventFormat": "round_robin",
"gameId": "game123",
"url": "https://tournaments.podplay.app/admin/tournaments/game123"
},
"lastSyncedAt": "2025-07-09T17:32:26.800Z",
"visibility": "VISIBLE"
},
"id": "text",
"bulkUpdateType": "FROM_CURRENT_ON",
"visibilitySchedules": {
"items": [
{
"id": "text",
"listDaysBefore": 1,
"membersOnly": true,
"_links": {}
}
],
"_total": 1,
"_links": {
"self": {
"href": "text"
}
}
},
"notes": {
"items": [
{
"id": "text",
"comment": "text"
}
],
"_total": 1,
"_links": {
"self": {
"href": "text"
}
}
}
}200Success
No content
get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
recurrenceIdstringRequiredExample:
5d57c02b-c7d3-94c3-9ae5-355026db62e0Responses
200
Returns events for the recurrence
application/json
_totalnumberRequiredDeprecated
get/events/recurrence/{recurrenceId}/events
GET /apis/v2/events/recurrence/{recurrenceId}/events HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200
Returns events for the recurrence
{
"items": [
{
"id": "text",
"type": "REGULAR",
"subtype": "OPERATIONS",
"customType": "text",
"name": "text",
"description": "text",
"startTime": "2026-01-01T00:00:00.000Z",
"endTime": "2026-01-01T00:00:00.000Z",
"pods": {
"items": [
{
"id": "text",
"slug": "text",
"displayName": "text",
"displayNameShort": "text",
"description": "text",
"address": {
"street": "text",
"floor": "text",
"city": "text",
"zip": "text",
"displayName": "text"
},
"timezone": "text",
"type": "PRIVATE",
"status": "NOT_AVAILABLE",
"sport": "PICKLEBALL",
"area": {},
"tables": {
"items": [
{
"id": "text",
"slug": "text",
"displayName": "text",
"displayNameShort": "text",
"description": "text",
"type": "STANDARD",
"status": "AVAILABLE",
"features": [
"REPLAYS"
],
"pod": {},
"settings": {
"items": [
{
"id": "text",
"value": {}
}
],
"_total": 1,
"_links": {
"self": {
"href": "text"
}
}
},
"errors": [
{
"code": "text",
"message": "text",
"details": {}
}
],
"_links": {}
}
],
"_total": 1,
"_links": {
"self": {
"href": "text"
}
}
},
"openTime": {
"hours": 1,
"minutes": 1
},
"closeTime": {
"hours": 1,
"minutes": 1
},
"closedTimeOverrides": {
"items": [
{
"id": "text",
"days": [
1
],
"from": {
"hours": 1,
"minutes": 1
},
"to": {
"hours": 1,
"minutes": 1
}
}
],
"_total": 1,
"_links": {
"self": {
"href": "text"
}
}
},
"guests": {
"private": {
"min": "text",
"max": "text"
}
},
"rates": {},
"settings": {
"items": [
{
"id": "text",
"value": {}
}
],
"_total": 1,
"_links": {
"self": {
"href": "text"
}
}
},
"errors": [
{
"code": "text",
"message": "text",
"details": {}
}
],
"_links": {}
}
],
"_total": 1,
"_links": {
"self": {
"href": "text"
}
}
},
"tables": {
"items": [
{
"id": "text",
"type": "FIXED_TABLE",
"table": {
"id": "text"
},
"startTime": "2026-01-01T00:00:00.000Z",
"endTime": "2026-01-01T00:00:00.000Z",
"features": [
"REPLAYS"
],
"status": "INVALID",
"errors": [
{
"code": "text",
"message": "text",
"details": {}
}
],
"_links": {
"self": {
"href": "text"
}
}
}
],
"_total": 1,
"_links": {
"self": {
"href": "text"
}
}
},
"access": {
"id": "text",
"type": "OPEN",
"startTime": "2026-01-01T00:00:00.000Z",
"endTime": "2026-01-01T00:00:00.000Z"
},
"guests": {
"displayName": "text",
"displayNameShort": "text",
"max": 1
},
"reservations": {
"items": [
{
"id": "text",
"startTime": "2026-01-01T00:00:00.000Z",
"endTime": "2026-01-01T00:00:00.000Z",
"tableAssignment": "PENDING",
"sessions": {
"items": [
{
"id": "text",
"session": {
"id": "text"
},
"coupon": {
"id": "text"
},
"charge": {
"id": "text"
},
"_links": {}
}
],
"_total": 1,
"_links": {
"self": {
"href": "text"
}
}
},
"pod": {
"id": "text"
},
"table": {
"id": "text"
},
"coach": {
"id": "text"
},
"guests": 1,
"charges": {
"_total": 1
},
"quickReplays": {
"_total": 1
},
"customReplays": {
"_total": 1
},
"_links": {}
}
],
"_total": 1,
"_links": {
"self": {
"href": "text"
}
}
},
"bookingMode": "USER_BOOKED",
"paymentMethod": "CASH",
"bookedBy": {
"id": "text"
},
"totalTeams": 1,
"teamSize": 1,
"admission": "OPEN",
"admissionRating": {
"minRating": 1,
"maxRating": 1,
"type": "SINGLES"
},
"admissionRate": {
"regular": 1,
"member": 1,
"membersDefault": 1,
"dayPass": {
"id": "text",
"displayName": "text",
"rate": 1
},
"memberships": {
"items": [
{
"membership": {
"id": "text"
},
"rate": 1
}
],
"_total": 1,
"_links": {
"self": {
"href": "text"
}
}
},
"chargingStrategy": "spot+",
"_links": {}
},
"admissionDate": {
"regular": "2026-01-01T00:00:00.000Z",
"member": "2026-01-01T00:00:00.000Z",
"membersDefault": "2026-01-01T00:00:00.000Z",
"memberships": {
"items": [
{
"membership": {
"id": "text"
},
"date": "2026-01-01T00:00:00.000Z"
}
],
"_total": 1,
"_links": {
"self": {
"href": "text"
}
}
},
"_links": {}
},
"admissionKids": "OPEN",
"allowedMemberships": {},
"coachRate": 1,
"freeSignupCancellationHorizonHours": 1,
"tags": [
"text"
],
"picture": {
"id": "text"
},
"visibility": "LISTED",
"invitations": {},
"payments": {},
"replays": {},
"cancellation": {},
"notes": {},
"openInvitations": {},
"signups": {},
"waitlist": {},
"features": [
"WAITLIST"
],
"stats": {},
"series": {
"id": "text"
},
"suspension": {
"id": "text"
},
"status": "INVALID",
"errors": [
{
"code": "text",
"message": "text",
"details": {}
}
],
"tournamentDivision": {
"id": "7229d7d5-5581-4d86-975f-5b7efc9b00e9",
"tournament": "7229d7d5-5581-4d86-975f-5b7efc9b00e9",
"provider": "SWISH",
"swish": {
"eventFormat": "rotating_partners_round_robin",
"gameId": "game123",
"editPlayersPath": "rotating-partners-round-robin"
},
"podplay": {
"eventFormat": "round_robin",
"gameId": "game123",
"url": "https://tournaments.podplay.app/admin/tournaments/game123"
},
"status": "DRAFT",
"createdAt": "2025-07-09T17:32:26.800Z",
"event": "7229d7d5-5581-4d86-975f-5b7efc9b00e9",
"lastSyncedAt": "2025-07-09T17:32:26.800Z",
"visibility": "VISIBLE",
"_links": {}
},
"visibilitySchedules": {
"items": [
{
"id": "text",
"event": {
"id": "text"
},
"listDaysBefore": 1,
"membersOnly": true,
"executed": true,
"status": "INVALID",
"errors": [
{
"code": "text",
"message": "text",
"details": {}
}
],
"_links": {}
}
],
"_total": 1,
"_links": {
"self": {
"href": "text"
}
}
},
"recurrence": {
"id": "text"
},
"teams": {
"items": [
{
"id": "text",
"_links": {
"self": {
"href": "text"
}
},
"teamLeader": {
"id": "text",
"user": {
"id": "text"
},
"type": "REGULAR",
"firstName": "text",
"lastName": "text",
"gender": "text",
"birthday": "2026-01-01T00:00:00.000Z",
"initials": "text",
"description": "text",
"picture": {},
"usattRating": 1,
"duprProfileUrl": "text",
"memberSince": "2026-01-01T00:00:00.000Z",
"membershipEnrollment": {},
"kids": {},
"_links": {}
},
"teamMembers": {
"items": [
{
"id": "text",
"user": {
"id": "text"
},
"type": "REGULAR",
"firstName": "text",
"lastName": "text",
"gender": "text",
"birthday": "2026-01-01T00:00:00.000Z",
"initials": "text",
"description": "text",
"picture": {},
"usattRating": 1,
"duprProfileUrl": "text",
"memberSince": "2026-01-01T00:00:00.000Z",
"membershipEnrollment": {},
"kids": {},
"_links": {}
}
],
"_total": 1,
"_links": {
"self": {
"href": "text"
}
}
},
"teamMemberCount": 1
}
],
"_total": 1,
"_links": {
"self": {
"href": "text"
}
}
},
"_links": {}
}
],
"_links": {
"self": {
"href": "text"
}
}
}Last updated
Was this helpful?