API docs by Redocly

Playpass API (2026-02-08)

Download OpenAPI specification:

License: Proprietary

API contract for the Playpass API. Expect possibility of breaking changes until this message is removed, by 2026-04-01. New to Playpass API? Start with the Developer Guide. Authenticated endpoints use Authorization: Bearer <token> with either a manager API token from Dashboard > Settings > API Access or a user OAuth access token returned by /api/oauth/token. Manager API tokens are issued and revoked by organizer owners; helper/staff roles do not self-issue manager API tokens today. API requests have a generous shared abuse ceiling, and credential issuance or externally triggered workflows have tighter per-actor or per-IP limits. Rate-limited requests return 429. API request bodies are limited to 16 MiB; oversized requests return 413.

oauth

OAuth authorization and token exchange for ChatGPT Actions.

Start OAuth authorization code flow

query Parameters
response_type
required
string
Value: "code"
client_id
required
string
redirect_uri
required
string <uri>
code_challenge
required
string
code_challenge_method
string
Value: "S256"
state
string

Responses

Response samples

Content type
application/json
{
  • "error": "string",
  • "error_description": "string"
}

Exchange OAuth authorization code for API access token

Request Body schema:
required
grant_type
required
string
Value: "authorization_code"
client_id
required
string
client_secret
string
code
required
string
redirect_uri
required
string <uri>
code_verifier
required
string

Responses

Request samples

Content type
{
  • "grant_type": "authorization_code",
  • "client_id": "string",
  • "client_secret": "string",
  • "code": "string",
  • "redirect_uri": "http://example.com",
  • "code_verifier": "string"
}

Response samples

Content type
application/json
{
  • "access_token": "string",
  • "token_type": "Bearer",
  • "expires_in": 1,
  • "scope": "string"
}

guest

Guest bootstrap and draft schedule workflows.

Create a guest session token

Creates an anonymous guest identity and returns the short-lived token used by guest scheduling endpoints.

query Parameters
profile
string
Enum: "slim" "detail"

Response detail profile. Defaults to slim.

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Create a guest draft schedule

Request Body schema: application/json
required
guest_session_token
required
string
required
object (ScheduleCreateInput)

Responses

Request samples

Content type
application/json
{
  • "guest_session_token": "string",
  • "schedule": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Get a guest draft schedule by ID

path Parameters
id
required
string^[A-Za-z][A-Za-z0-9]+$

ID value (for example Ak3GtLx, Rk3GtLx, PHpmFGq, Of6Hk2a)

query Parameters
guest_session_token
required
string

Guest session token from POST /api/guest_sessions.

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Get games for a guest-owned schedule

path Parameters
id
required
string^[A-Za-z][A-Za-z0-9]+$

ID value (for example Ak3GtLx, Rk3GtLx, PHpmFGq, Of6Hk2a)

query Parameters
guest_session_token
required
string

Guest session token from POST /api/guest_sessions.

status
string
Enum: "all" "unplayed"
team
integer >= 1
group
integer >= 1
court
integer >= 1
style
string
Enum: "list" "bracket"
page
integer >= 1

1-based page number. Blank, invalid, and values below 1 use page 1.

per_page
integer [ 1 .. 100 ]

Number of records per page. Blank, invalid, and values below 1 use the endpoint default; values above 100 are capped at 100.

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Get standings for a guest-owned robin schedule

path Parameters
id
required
string^[A-Za-z][A-Za-z0-9]+$

ID value (for example Ak3GtLx, Rk3GtLx, PHpmFGq, Of6Hk2a)

query Parameters
guest_session_token
required
string

Guest session token from POST /api/guest_sessions.

team
integer >= 1
group
integer >= 1

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

organizers

Organizer profile and metadata.

Create an organizer for the authenticated user

Authorizations:
bearerAuth
Request Body schema: application/json
required
required
object (OrganizerCreateInput)

Responses

Request samples

Content type
application/json
{
  • "organizer": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Get organizer details by ID or slug

Authorizations:
NonebearerAuth
path Parameters
id
required
string^[A-Za-z0-9-]+$

Organizer lookup value (prefixed ID like Of6Hk2a or slug/short URL like YSC)

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Update an organizer

Authorizations:
bearerAuth
path Parameters
id
required
string^[A-Za-z0-9-]+$

Organizer lookup value (prefixed ID like Of6Hk2a or slug/short URL like YSC)

Request Body schema: application/json
required
required
object (OrganizerUpdateInput) non-empty

Responses

Request samples

Content type
application/json
{
  • "organizer": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Claim guest schedules into organizer ownership

Authorizations:
bearerAuth
path Parameters
organizer_id
required
string
query Parameters
profile
string
Enum: "slim" "detail"

Response detail profile. Defaults to slim.

Request Body schema: application/json
required
guest_session_token
required
string

Responses

Request samples

Content type
application/json
{
  • "guest_session_token": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Start organizer trial for eligible organizer

Authorizations:
bearerAuth
path Parameters
organizer_id
required
string
query Parameters
profile
string
Enum: "slim" "detail"

Response detail profile. Defaults to slim.

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

List organizer API tokens

Returns API token metadata only. Plaintext token values are never returned by this endpoint. Token creation and revocation are owner-only.

Authorizations:
bearerAuth
path Parameters
organizer_id
required
string
query Parameters
profile
string
Enum: "slim" "detail"

Response detail profile. Defaults to slim.

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Create organizer API token

Creates a new organizer-owner API token and returns its plaintext token value once. Save it securely.

Authorizations:
bearerAuth
path Parameters
organizer_id
required
string
query Parameters
profile
string
Enum: "slim" "detail"

Response detail profile. Defaults to slim.

Request Body schema: application/json
optional
object (OrganizerApiTokenCreateInput)

Responses

Request samples

Content type
application/json
{
  • "api_token": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Revoke organizer API token

Revokes an organizer API token. Only organizer owners can revoke manager API tokens.

Authorizations:
bearerAuth
path Parameters
organizer_id
required
string
token_id
required
integer
query Parameters
profile
string
Enum: "slim" "detail"

Response detail profile. Defaults to slim.

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

List organizer managers

Lists organizer staff roles that can help manage the organizer.

Authorizations:
bearerAuth
path Parameters
organizer_id
required
string
query Parameters
query
string
Example: query=basketball

Case-insensitive free-text search string.

page
integer >= 1

1-based page number. Blank, invalid, and values below 1 use page 1.

per_page
integer [ 1 .. 100 ]

Number of records per page. Blank, invalid, and values below 1 use the endpoint default; values above 100 are capped at 100.

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Create organizer manager

Adds a staff role to an organizer.

Authorizations:
bearerAuth
path Parameters
organizer_id
required
string
Request Body schema: application/json
optional
object (ManagerCreateInput)

Responses

Request samples

Content type
application/json
{
  • "manager": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Update organizer manager

Updates organizer staff state, such as activating or suspending access.

Authorizations:
bearerAuth
path Parameters
organizer_id
required
string
manager_id
required
string

Prefixed manager role id.

Request Body schema: application/json
optional
object (ManagerUpdateInput)

Responses

Request samples

Content type
application/json
{
  • "manager": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Show organizer custom domain

Returns organizer custom-domain setup state, including DNS instructions when configured.

Authorizations:
bearerAuth
path Parameters
organizer_id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Create organizer custom domain

Requests a custom domain hostname and generates DNS instructions.

Authorizations:
bearerAuth
path Parameters
organizer_id
required
string
Request Body schema: application/json
optional
object (CustomDomainCreateInput)

Responses

Request samples

Content type
application/json
{
  • "custom_domain": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Update organizer custom domain

Changes the requested custom-domain hostname and regenerates DNS instructions.

Authorizations:
bearerAuth
path Parameters
organizer_id
required
string
Request Body schema: application/json
optional
object (CustomDomainUpdateInput)

Responses

Request samples

Content type
application/json
{
  • "custom_domain": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Disable organizer custom domain

Disables the organizer custom domain and returns the updated state.

Authorizations:
bearerAuth
path Parameters
organizer_id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Start organizer custom domain status check

Enqueues a background status check after the organizer updates DNS.

Authorizations:
bearerAuth
path Parameters
organizer_id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Get organizer homepage items

Authorizations:
NonebearerAuth
path Parameters
id
required
string^[A-Za-z0-9-]+$

Organizer lookup value (prefixed ID like Of6Hk2a or slug/short URL like YSC)

query Parameters
query
string
Example: query=basketball

Case-insensitive free-text search string.

sport
string
Example: sport=soccer

Sport slug filter. Applies to sport-bearing resources only.

page
integer >= 1

1-based page number. Blank, invalid, and values below 1 use page 1.

per_page
integer [ 1 .. 100 ]

Number of records per page. Blank, invalid, and values below 1 use the endpoint default; values above 100 are capped at 100.

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

questions

Organizer checkout questions.

List organizer global questions

Lists organizer-level checkout questions. Activity-specific, membership-specific, and booking-specific questions remain out of scope for this endpoint.

Authorizations:
bearerAuth
path Parameters
organizer_id
required
string
query Parameters
query
string
Example: query=basketball

Case-insensitive free-text search string.

page
integer >= 1

1-based page number. Blank, invalid, and values below 1 use page 1.

per_page
integer [ 1 .. 100 ]

Number of records per page. Blank, invalid, and values below 1 use the endpoint default; values above 100 are capped at 100.

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Create organizer global question

Creates a new organizer-level checkout question.

Authorizations:
bearerAuth
path Parameters
organizer_id
required
string
Request Body schema: application/json
optional
object (QuestionCreateInput)

Responses

Request samples

Content type
application/json
{
  • "question": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Update organizer global question

Updates a global organizer checkout question. Locked questions can only change visibility, requirement, or position.

Authorizations:
bearerAuth
path Parameters
organizer_id
required
string
question_id
required
integer >= 1
Request Body schema: application/json
optional
object (QuestionUpdateInput) non-empty

Responses

Request samples

Content type
application/json
{
  • "question": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Delete organizer global question

Deletes a global organizer checkout question when it is eligible for deletion.

Authorizations:
bearerAuth
path Parameters
organizer_id
required
string
question_id
required
integer >= 1

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

coupons

Organizer coupon management.

List organizer coupons

Lists organizer coupon codes used during checkout setup and operations.

Authorizations:
bearerAuth
path Parameters
organizer_id
required
string
query Parameters
status
string
Enum: "available" "unavailable" "all"

Coupon availability filter. Defaults to available.

query
string
Example: query=basketball

Case-insensitive free-text search string.

page
integer >= 1

1-based page number. Blank, invalid, and values below 1 use page 1.

per_page
integer [ 1 .. 100 ]

Number of records per page. Blank, invalid, and values below 1 use the endpoint default; values above 100 are capped at 100.

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Create organizer coupon

Creates a new organizer coupon for checkout discounts.

Authorizations:
bearerAuth
path Parameters
organizer_id
required
string
Request Body schema: application/json
optional
object (CouponCreateInput)

Responses

Request samples

Content type
application/json
{
  • "coupon": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Show organizer coupon

Returns one organizer coupon, including its enabled checkout types and redemption count.

Authorizations:
bearerAuth
path Parameters
organizer_id
required
string
coupon_id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Update organizer coupon

Updates organizer coupon manager fields such as active state and enabled checkout types.

Authorizations:
bearerAuth
path Parameters
organizer_id
required
string
coupon_id
required
string
Request Body schema: application/json
optional
object (CouponUpdateInput) non-empty

Responses

Request samples

Content type
application/json
{
  • "coupon": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Delete organizer coupon

Deletes an organizer coupon when it is eligible for deletion.

Authorizations:
bearerAuth
path Parameters
organizer_id
required
string
coupon_id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

payments

Organizer payment readiness and onboarding.

Show organizer payment settings

Returns organizer payment readiness and checkout payment settings.

Authorizations:
bearerAuth
path Parameters
organizer_id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Update organizer payment settings

Updates organizer checkout payment settings such as country, currency, and pass-through fee behavior.

Authorizations:
bearerAuth
path Parameters
organizer_id
required
string
Request Body schema: application/json
optional
object (OrganizerPaymentUpdateInput) non-empty

Responses

Request samples

Content type
application/json
{
  • "payment": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Start organizer payment onboarding

Creates or refreshes the organizer Stripe onboarding link.

Authorizations:
bearerAuth
path Parameters
organizer_id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

team_payments

Standalone team payment request management and payout readiness. These endpoints require a user OAuth access token; organizer-scoped manager API tokens cannot access unrelated standalone teams.

Show team payment payout readiness

Returns standalone team payout setup and collection readiness. Team owners and Playpass support can read this state.

Authorizations:
bearerAuth
path Parameters
team_id
required
string
Example: Vabc123

Prefixed standalone team identifier.

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Start team payment payout onboarding

Creates or refreshes a Stripe-hosted payout onboarding link. Only an active standalone team owner can start identity and bank verification.

Authorizations:
bearerAuth
path Parameters
team_id
required
string
Example: Vabc123

Prefixed standalone team identifier.

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

List team payment requests

Lists private payment requests for an owned standalone team.

Authorizations:
bearerAuth
path Parameters
team_id
required
string
Example: Vabc123

Prefixed standalone team identifier.

query Parameters
query
string
Example: query=basketball

Case-insensitive free-text search string.

status
string
Enum: "draft" "sent" "closed" "canceled" "needs_review"
page
integer >= 1

1-based page number. Blank, invalid, and values below 1 use page 1.

per_page
integer [ 1 .. 100 ]

Number of records per page. Blank, invalid, and values below 1 use the endpoint default; values above 100 are capped at 100.

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Create team payment request

Creates a draft fixed-amount payment request for an owned standalone team. Drafting does not require completed payout onboarding.

Authorizations:
bearerAuth
path Parameters
team_id
required
string
Example: Vabc123

Prefixed standalone team identifier.

Request Body schema: application/json
required
required
object

Responses

Request samples

Content type
application/json
{
  • "payment_request": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Show team payment request

Returns one team payment request with assignments and, for drafts, assignable accepted team members.

Authorizations:
bearerAuth
path Parameters
team_id
required
string
Example: Vabc123

Prefixed standalone team identifier.

payment_request_id
required
string
Example: TRABC1234

Prefixed team payment request identifier.

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Update team payment request

Updates editable fields on a draft team payment request.

Authorizations:
bearerAuth
path Parameters
team_id
required
string
Example: Vabc123

Prefixed standalone team identifier.

payment_request_id
required
string
Example: TRABC1234

Prefixed team payment request identifier.

Request Body schema: application/json
required
required
object non-empty

Responses

Request samples

Content type
application/json
{
  • "payment_request": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Send team payment request

Sends a draft request to selected active accepted members after payout and safety checks pass.

Authorizations:
bearerAuth
path Parameters
team_id
required
string
Example: Vabc123

Prefixed standalone team identifier.

payment_request_id
required
string
Example: TRABC1234

Prefixed team payment request identifier.

Request Body schema: application/json
required
required
object

Responses

Request samples

Content type
application/json
{
  • "sending": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Close team payment request

Stops collection on a sent request while preserving payment history and receipts.

Authorizations:
bearerAuth
path Parameters
team_id
required
string
Example: Vabc123

Prefixed standalone team identifier.

payment_request_id
required
string
Example: TRABC1234

Prefixed team payment request identifier.

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Cancel team payment request

Cancels a draft or unpaid sent request. Requests with recorded money must be closed instead.

Authorizations:
bearerAuth
path Parameters
team_id
required
string
Example: Vabc123

Prefixed standalone team identifier.

payment_request_id
required
string
Example: TRABC1234

Prefixed team payment request identifier.

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Remind unpaid team members

Sends a reminder to unpaid accepted members on a sent request, subject to the same cooldown and rate limits as the team workspace.

Authorizations:
bearerAuth
path Parameters
team_id
required
string
Example: Vabc123

Prefixed standalone team identifier.

payment_request_id
required
string
Example: TRABC1234

Prefixed team payment request identifier.

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Show team payment assignment

Returns one private member payment assignment to the team owner or Playpass support.

Authorizations:
bearerAuth
path Parameters
team_id
required
string
Example: Vabc123

Prefixed standalone team identifier.

payment_assignment_id
required
string
Example: TAABC1234

Prefixed team payment assignment identifier.

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Record offline team payment

Records a cash, check, or other offline payment with optional audit note.

Authorizations:
bearerAuth
path Parameters
team_id
required
string
Example: Vabc123

Prefixed standalone team identifier.

payment_assignment_id
required
string
Example: TAABC1234

Prefixed team payment assignment identifier.

Request Body schema: application/json
optional
object

Responses

Request samples

Content type
application/json
{
  • "offline_payment": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Clear offline team payment

Reopens an assignment previously recorded as paid offline while preserving its audit history.

Authorizations:
bearerAuth
path Parameters
team_id
required
string
Example: Vabc123

Prefixed standalone team identifier.

payment_assignment_id
required
string
Example: TAABC1234

Prefixed team payment assignment identifier.

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Waive team payment assignment

Waives one member assignment.

Authorizations:
bearerAuth
path Parameters
team_id
required
string
Example: Vabc123

Prefixed standalone team identifier.

payment_assignment_id
required
string
Example: TAABC1234

Prefixed team payment assignment identifier.

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Clear team payment waiver

Reopens a waived assignment while preserving its audit history.

Authorizations:
bearerAuth
path Parameters
team_id
required
string
Example: Vabc123

Prefixed standalone team identifier.

payment_assignment_id
required
string
Example: TAABC1234

Prefixed team payment assignment identifier.

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Refund team payment assignment

Submits the full-only connected-account refund used by Team Payments.

Authorizations:
bearerAuth
path Parameters
team_id
required
string
Example: Vabc123

Prefixed standalone team identifier.

payment_assignment_id
required
string
Example: TAABC1234

Prefixed team payment assignment identifier.

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

conversations

Organizer-to-player conversations and messages.

List organizer player conversations

Lists organizer-to-player conversations that are visible in the manager inbox.

Authorizations:
bearerAuth
path Parameters
organizer_id
required
string
query Parameters
query
string
Example: query=basketball

Case-insensitive free-text search string.

page
integer >= 1

1-based page number. Blank, invalid, and values below 1 use page 1.

per_page
integer [ 1 .. 100 ]

Number of records per page. Blank, invalid, and values below 1 use the endpoint default; values above 100 are capped at 100.

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Start organizer player conversation

Starts an organizer-to-player conversation by sending the first manager message.

Authorizations:
bearerAuth
path Parameters
organizer_id
required
string
Request Body schema: application/json
optional
object (ConversationCreateInput)

Responses

Request samples

Content type
application/json
{
  • "conversation": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

List organizer conversation messages

Lists messages for a single organizer-to-player conversation and marks manager unread state as read.

Authorizations:
bearerAuth
path Parameters
organizer_id
required
string
conversation_id
required
string
query Parameters
page
integer >= 1

1-based page number. Blank, invalid, and values below 1 use page 1.

per_page
integer [ 1 .. 100 ]

Number of records per page. Blank, invalid, and values below 1 use the endpoint default; values above 100 are capped at 100.

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Reply to organizer conversation

Sends a manager reply inside an organizer-to-player conversation.

Authorizations:
bearerAuth
path Parameters
organizer_id
required
string
conversation_id
required
string
Request Body schema: application/json
optional
object (MessageCreateInput)

Responses

Request samples

Content type
application/json
{
  • "message": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

announcements

Organizer player announcements.

List organizer announcements

Lists organizer announcement drafts and sends.

Authorizations:
bearerAuth
path Parameters
organizer_id
required
string
query Parameters
query
string
Example: query=basketball

Case-insensitive free-text search string.

page
integer >= 1

1-based page number. Blank, invalid, and values below 1 use page 1.

per_page
integer [ 1 .. 100 ]

Number of records per page. Blank, invalid, and values below 1 use the endpoint default; values above 100 are capped at 100.

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Create organizer announcement

Creates an organizer announcement and sends it immediately unless deliver is set to false.

Authorizations:
bearerAuth
path Parameters
organizer_id
required
string
Request Body schema: application/json
optional
object (AnnouncementCreateInput)

Responses

Request samples

Content type
application/json
{
  • "announcement": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

schedules

Schedule details, games, and standings.

List schedules for an organizer context

Authorizations:
bearerAuth
query Parameters
organizer_id
string
query
string
Example: query=basketball

Case-insensitive free-text search string.

status
string
Enum: "draft" "published" "archived"

Exact schedule lifecycle status filter.

view
string
Enum: "current" "homepage" "all"

Schedule list view. Defaults to current when omitted.

sport
string
Example: sport=soccer

Sport slug filter. Applies to sport-bearing resources only.

format
string
Enum: "round_robin" "swiss_system" "rotating_partners" "practice_schedule" "single_elimination" "double_elimination" "triple_elimination"

Filter schedules by schedule format.

page
integer >= 1

1-based page number. Blank, invalid, and values below 1 use page 1.

per_page
integer [ 1 .. 100 ]

Number of records per page. Blank, invalid, and values below 1 use the endpoint default; values above 100 are capped at 100.

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Create a schedule

Authorizations:
bearerAuth
Request Body schema: application/json
required
organizer_id
string
required
object (ScheduleCreateInput)

Responses

Request samples

Content type
application/json
{
  • "organizer_id": "string",
  • "schedule": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Get schedule details by ID

Authorizations:
NonebearerAuth
path Parameters
id
required
string^[A-Za-z][A-Za-z0-9]+$

ID value (for example Ak3GtLx, Rk3GtLx, PHpmFGq, Of6Hk2a)

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Update a schedule

Authorizations:
bearerAuth
path Parameters
id
required
string^[A-Za-z][A-Za-z0-9]+$

ID value (for example Ak3GtLx, Rk3GtLx, PHpmFGq, Of6Hk2a)

Request Body schema: application/json
required
required
object (ScheduleUpdateInput) non-empty

Responses

Request samples

Content type
application/json
{
  • "schedule": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Delete a schedule

Authorizations:
bearerAuth
path Parameters
id
required
string^[A-Za-z][A-Za-z0-9]+$

ID value (for example Ak3GtLx, Rk3GtLx, PHpmFGq, Of6Hk2a)

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Publish a schedule

Authorizations:
bearerAuth
path Parameters
schedule_id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Unpublish a schedule

Authorizations:
bearerAuth
path Parameters
schedule_id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Archive a schedule

Authorizations:
bearerAuth
path Parameters
schedule_id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Unarchive a schedule

Authorizations:
bearerAuth
path Parameters
schedule_id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Add teams to a schedule

Authorizations:
bearerAuth
path Parameters
schedule_id
required
string
Request Body schema: application/json
required
teams
required
Array of strings non-empty

Responses

Request samples

Content type
application/json
{
  • "teams": [
    ]
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Get schedule games

Authorizations:
NonebearerAuth
path Parameters
id
required
string^[A-Za-z][A-Za-z0-9]+$

ID value (for example Ak3GtLx, Rk3GtLx, PHpmFGq, Of6Hk2a)

query Parameters
status
string
Enum: "all" "unplayed"
team
integer >= 1
group
integer >= 1
court
integer >= 1
style
string
Enum: "list" "bracket"
page
integer >= 1

1-based page number. Blank, invalid, and values below 1 use page 1.

per_page
integer [ 1 .. 100 ]

Number of records per page. Blank, invalid, and values below 1 use the endpoint default; values above 100 are capped at 100.

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Get standings (robin schedules only)

Authorizations:
NonebearerAuth
path Parameters
id
required
string^[A-Za-z][A-Za-z0-9]+$

ID value (for example Ak3GtLx, Rk3GtLx, PHpmFGq, Of6Hk2a)

query Parameters
team
integer >= 1
group
integer >= 1

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

attendance

Organizer check-in sessions, roster updates, completion, and attendance reporting.

List organizer check-in sessions

Authorizations:
bearerAuth
query Parameters
organizer_id
string
status
string
Enum: "open" "completed"

Exact check-in lifecycle status.

source_type
string
Enum: "activity" "membership" "booking"

Exact attendance source type.

source_id
string

Prefixed activity (A), membership (S), or reservation booking (K) id.

from
string <date>

Inclusive organizer-local occurrence start date.

to
string <date>

Inclusive organizer-local occurrence end date.

page
integer >= 1

1-based page number. Blank, invalid, and values below 1 use page 1.

per_page
integer [ 1 .. 100 ]

Number of records per page. Blank, invalid, and values below 1 use the endpoint default; values above 100 are capped at 100.

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Start check-in for an activity, membership, or booking

Authorizations:
bearerAuth
Request Body schema: application/json
required
required
object

Responses

Request samples

Content type
application/json
{
  • "attendance_session": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Get a check-in roster

Authorizations:
bearerAuth
path Parameters
id
required
string^AS[A-Za-z0-9]+$
Example: ASabc123

Prefixed attendance session id.

query Parameters
query
string
Example: query=basketball

Case-insensitive free-text search string.

status
string
Enum: "unmarked" "checked_in" "late" "did_not_attend" "excused"

Exact public attendance status.

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Add a newly eligible attendee to an open check-in

Authorizations:
bearerAuth
path Parameters
attendance_session_id
required
string^AS[A-Za-z0-9]+$
Example: ASabc123

Prefixed attendance session id.

Request Body schema: application/json
required
required
object

Responses

Request samples

Content type
application/json
{
  • "attendance_entry": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Mark or correct a roster entry

Authorizations:
bearerAuth
path Parameters
attendance_session_id
required
string^AS[A-Za-z0-9]+$
Example: ASabc123

Prefixed attendance session id.

entry_id
required
string^[GMK][A-Za-z0-9]+$
Example: Gabc123

Prefixed attendee id identifying the roster entry within this session. Uses a registration (G), membership subscription (M), or reservation booking (K) id.

Request Body schema: application/json
required
required
object

Responses

Request samples

Content type
application/json
{
  • "attendance_entry": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Finish check-in and mark untouched entries as did not attend

Authorizations:
bearerAuth
path Parameters
attendance_session_id
required
string^AS[A-Za-z0-9]+$
Example: ASabc123

Prefixed attendance session id.

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Get a filtered attendance report or complete CSV export

Authorizations:
bearerAuth
query Parameters
organizer_id
string
from
string <date>

Inclusive organizer-local occurrence start date.

to
string <date>

Inclusive organizer-local occurrence end date.

source_type
string
Enum: "activity" "membership" "booking"

Exact attendance source type.

source_id
string

Prefixed activity (A), membership (S), or reservation booking (K) id.

status
string
Enum: "unmarked" "checked_in" "late" "did_not_attend" "excused"

Exact public attendance status.

participant
string

Case-insensitive participant or entrant name filter.

account_holder
string

Case-insensitive account holder, captain, or email filter.

format
string
Enum: "json" "csv"

Return JSON when omitted or a complete CSV export when set to csv.

page
integer >= 1

1-based page number. Blank, invalid, and values below 1 use page 1.

per_page
integer [ 1 .. 100 ]

Number of records per page. Blank, invalid, and values below 1 use the endpoint default; values above 100 are capped at 100.

Responses

Response samples

Content type
{
  • "data": {
    },
  • "meta": {
    }
}

activities

Publishable activity details.

List organizer activities

Authorizations:
bearerAuth
query Parameters
organizer_id
string
query
string
Example: query=basketball

Case-insensitive free-text search string.

status
string
Enum: "draft" "published" "archived"

Exact activity lifecycle status filter.

view
string
Enum: "current" "all"

Activity list view. Use all to include draft, published, and archived activities. When omitted, the API defaults to current activities.

page
integer >= 1

1-based page number. Blank, invalid, and values below 1 use page 1.

per_page
integer [ 1 .. 100 ]

Number of records per page. Blank, invalid, and values below 1 use the endpoint default; values above 100 are capped at 100.

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Create an activity

Authorizations:
bearerAuth
Request Body schema: application/json
required
required
object (ActivityCreateInput)

Responses

Request samples

Content type
application/json
{
  • "activity": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Get activity details by ID

Authorizations:
NonebearerAuth
path Parameters
id
required
string^[A-Za-z][A-Za-z0-9]+$

ID value (for example Ak3GtLx, Rk3GtLx, PHpmFGq, Of6Hk2a)

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Update an activity

Authorizations:
bearerAuth
path Parameters
id
required
string^[A-Za-z][A-Za-z0-9]+$

ID value (for example Ak3GtLx, Rk3GtLx, PHpmFGq, Of6Hk2a)

Request Body schema: application/json
required
required
object (ActivityUpdateInput) non-empty

Responses

Request samples

Content type
application/json
{
  • "activity": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Delete an activity

Authorizations:
bearerAuth
path Parameters
id
required
string^[A-Za-z][A-Za-z0-9]+$

ID value (for example Ak3GtLx, Rk3GtLx, PHpmFGq, Of6Hk2a)

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Attach a product to an activity

Authorizations:
bearerAuth
path Parameters
id
required
string^[A-Za-z][A-Za-z0-9]+$

ID value (for example Ak3GtLx, Rk3GtLx, PHpmFGq, Of6Hk2a)

Request Body schema: application/json
required
product_id
required
string^[A-Za-z][A-Za-z0-9]+$

Responses

Request samples

Content type
application/json
{
  • "product_id": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Remove a product from an activity

Authorizations:
bearerAuth
path Parameters
id
required
string^[A-Za-z][A-Za-z0-9]+$

ID value (for example Ak3GtLx, Rk3GtLx, PHpmFGq, Of6Hk2a)

product_id
required
string^[A-Za-z][A-Za-z0-9]+$

Product ID value (for example Jabc123)

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

List pricing options for an activity

Authorizations:
NonebearerAuth
path Parameters
id
required
string^[A-Za-z][A-Za-z0-9]+$

ID value (for example Ak3GtLx, Rk3GtLx, PHpmFGq, Of6Hk2a)

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Create a pricing option for an activity

Authorizations:
bearerAuth
path Parameters
id
required
string^[A-Za-z][A-Za-z0-9]+$

ID value (for example Ak3GtLx, Rk3GtLx, PHpmFGq, Of6Hk2a)

Request Body schema: application/json
required
required
object (ActivityPricingOptionInput)

Responses

Request samples

Content type
application/json
{
  • "pricing_option": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Get a pricing option for an activity

Authorizations:
NonebearerAuth
path Parameters
id
required
string^[A-Za-z][A-Za-z0-9]+$

ID value (for example Ak3GtLx, Rk3GtLx, PHpmFGq, Of6Hk2a)

pricing_option_id
required
string^[A-Za-z][A-Za-z0-9]+$

Pricing option ID value (for example Cabc123)

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Update a pricing option for an activity

Authorizations:
bearerAuth
path Parameters
id
required
string^[A-Za-z][A-Za-z0-9]+$

ID value (for example Ak3GtLx, Rk3GtLx, PHpmFGq, Of6Hk2a)

pricing_option_id
required
string^[A-Za-z][A-Za-z0-9]+$

Pricing option ID value (for example Cabc123)

Request Body schema: application/json
required
required
object (ActivityPricingOptionInput)

Responses

Request samples

Content type
application/json
{
  • "pricing_option": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Delete a pricing option for an activity

Authorizations:
bearerAuth
path Parameters
id
required
string^[A-Za-z][A-Za-z0-9]+$

ID value (for example Ak3GtLx, Rk3GtLx, PHpmFGq, Of6Hk2a)

pricing_option_id
required
string^[A-Za-z][A-Za-z0-9]+$

Pricing option ID value (for example Cabc123)

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Publish an activity

Authorizations:
bearerAuth
path Parameters
id
required
string^[A-Za-z][A-Za-z0-9]+$

ID value (for example Ak3GtLx, Rk3GtLx, PHpmFGq, Of6Hk2a)

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Unpublish an activity

Authorizations:
bearerAuth
path Parameters
id
required
string^[A-Za-z][A-Za-z0-9]+$

ID value (for example Ak3GtLx, Rk3GtLx, PHpmFGq, Of6Hk2a)

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Archive an activity

Authorizations:
bearerAuth
path Parameters
id
required
string^[A-Za-z][A-Za-z0-9]+$

ID value (for example Ak3GtLx, Rk3GtLx, PHpmFGq, Of6Hk2a)

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Unarchive an activity

Authorizations:
bearerAuth
path Parameters
id
required
string^[A-Za-z][A-Za-z0-9]+$

ID value (for example Ak3GtLx, Rk3GtLx, PHpmFGq, Of6Hk2a)

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

products

Organizer product catalog details.

List organizer products

Authorizations:
bearerAuth
query Parameters
organizer_id
string
query
string
Example: query=basketball

Case-insensitive free-text search string.

status
string
Enum: "available" "archived"

Exact product catalog status filter.

view
string
Value: "all"

Product list view. Use all to include both available and archived products. When omitted, the API defaults to available products.

page
integer >= 1

1-based page number. Blank, invalid, and values below 1 use page 1.

per_page
integer [ 1 .. 100 ]

Number of records per page. Blank, invalid, and values below 1 use the endpoint default; values above 100 are capped at 100.

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Create a product

Authorizations:
bearerAuth
Request Body schema: application/json
required
required
object (ProductCreateInput)

Responses

Request samples

Content type
application/json
{
  • "product": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Get product details by ID

Authorizations:
bearerAuth
path Parameters
id
required
string^[A-Za-z][A-Za-z0-9]+$

ID value (for example Ak3GtLx, Rk3GtLx, PHpmFGq, Of6Hk2a)

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Update a product

Authorizations:
bearerAuth
path Parameters
id
required
string^[A-Za-z][A-Za-z0-9]+$

ID value (for example Ak3GtLx, Rk3GtLx, PHpmFGq, Of6Hk2a)

Request Body schema: application/json
required
required
object (ProductUpdateInput) non-empty

Responses

Request samples

Content type
application/json
{
  • "product": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Delete a product

Authorizations:
bearerAuth
path Parameters
id
required
string^[A-Za-z][A-Za-z0-9]+$

ID value (for example Ak3GtLx, Rk3GtLx, PHpmFGq, Of6Hk2a)

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

reservation_offerings

Publishable reservation booking pages.

List organizer reservation offerings

Authorizations:
bearerAuth
query Parameters
organizer_id
string
query
string
Example: query=basketball

Case-insensitive free-text search string.

status
string
Enum: "draft" "published" "archived"

Exact booking page lifecycle status filter.

view
string
Enum: "current" "all"

Booking page list view. Defaults to current when omitted.

page
integer >= 1

1-based page number. Blank, invalid, and values below 1 use page 1.

per_page
integer [ 1 .. 100 ]

Number of records per page. Blank, invalid, and values below 1 use the endpoint default; values above 100 are capped at 100.

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Create a reservation offering

Authorizations:
bearerAuth
Request Body schema: application/json
required
required
object (ReservationOfferingCreateInput)

Responses

Request samples

Content type
application/json
{
  • "reservation_offering": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Get reservation offering details by ID

Authorizations:
NonebearerAuth
path Parameters
id
required
string^[A-Za-z][A-Za-z0-9]+$

ID value (for example Ak3GtLx, Rk3GtLx, PHpmFGq, Of6Hk2a)

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Update a reservation offering

Authorizations:
bearerAuth
path Parameters
id
required
string^[A-Za-z][A-Za-z0-9]+$

ID value (for example Ak3GtLx, Rk3GtLx, PHpmFGq, Of6Hk2a)

Request Body schema: application/json
required
required
object (ReservationOfferingUpdateInput) non-empty

Responses

Request samples

Content type
application/json
{
  • "reservation_offering": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Delete a reservation offering

Authorizations:
bearerAuth
path Parameters
id
required
string^[A-Za-z][A-Za-z0-9]+$

ID value (for example Ak3GtLx, Rk3GtLx, PHpmFGq, Of6Hk2a)

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Attach a product to a reservation offering

Authorizations:
bearerAuth
path Parameters
id
required
string^[A-Za-z][A-Za-z0-9]+$

ID value (for example Ak3GtLx, Rk3GtLx, PHpmFGq, Of6Hk2a)

Request Body schema: application/json
required
product_id
required
string^[A-Za-z][A-Za-z0-9]+$

Responses

Request samples

Content type
application/json
{
  • "product_id": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Remove a product from a reservation offering

Authorizations:
bearerAuth
path Parameters
id
required
string^[A-Za-z][A-Za-z0-9]+$

ID value (for example Ak3GtLx, Rk3GtLx, PHpmFGq, Of6Hk2a)

product_id
required
string^[A-Za-z][A-Za-z0-9]+$

Product ID value (for example Jabc123)

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

List upcoming booking times for a reservation offering

Authorizations:
bearerAuth
path Parameters
reservation_offering_id
required
string
Example: Babc123
query Parameters
page
integer >= 1

1-based page number. Blank, invalid, and values below 1 use page 1.

per_page
integer [ 1 .. 100 ]

Number of records per page. Blank, invalid, and values below 1 use the endpoint default; values above 100 are capped at 100.

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Add an exact booking time to a specific-date reservation offering

Authorizations:
bearerAuth
path Parameters
reservation_offering_id
required
string
Example: Babc123
Request Body schema: application/json
required
required
object (ReservationSlotCreateInput)

Responses

Request samples

Content type
application/json
{
  • "reservation_slot": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Get a booking time for a reservation offering

Authorizations:
bearerAuth
path Parameters
reservation_offering_id
required
string
Example: Babc123
reservation_slot_id
required
string
Example: BTabc123

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Update an exact booking time, capacity, or visibility

Authorizations:
bearerAuth
path Parameters
reservation_offering_id
required
string
Example: Babc123
reservation_slot_id
required
string
Example: BTabc123
Request Body schema: application/json
required
required
object (ReservationSlotUpdateInput) non-empty

Responses

Request samples

Content type
application/json
{
  • "reservation_slot": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Delete an unused exact booking time

Authorizations:
bearerAuth
path Parameters
reservation_offering_id
required
string
Example: Babc123
reservation_slot_id
required
string
Example: BTabc123

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Publish a reservation offering

Authorizations:
bearerAuth
path Parameters
id
required
string^[A-Za-z][A-Za-z0-9]+$

ID value (for example Ak3GtLx, Rk3GtLx, PHpmFGq, Of6Hk2a)

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Unpublish a reservation offering

Authorizations:
bearerAuth
path Parameters
id
required
string^[A-Za-z][A-Za-z0-9]+$

ID value (for example Ak3GtLx, Rk3GtLx, PHpmFGq, Of6Hk2a)

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Archive a reservation offering

Authorizations:
bearerAuth
path Parameters
id
required
string^[A-Za-z][A-Za-z0-9]+$

ID value (for example Ak3GtLx, Rk3GtLx, PHpmFGq, Of6Hk2a)

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Unarchive a reservation offering

Authorizations:
bearerAuth
path Parameters
id
required
string^[A-Za-z][A-Za-z0-9]+$

ID value (for example Ak3GtLx, Rk3GtLx, PHpmFGq, Of6Hk2a)

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

reservation_bookings

Organizer reservation booking records.

List organizer reservation bookings

Authorizations:
bearerAuth
query Parameters
organizer_id
string
reservation_offering_id
string

Filter reservation bookings to a single reservation offering id.

query
string
Example: query=basketball

Case-insensitive free-text search string.

status
string
Enum: "active" "pending" "canceled" "incomplete"

Exact reservation booking status filter.

payment_status
string
Enum: "pending" "succeeded" "failed" "refunded" "free"

Exact reservation booking payment status filter.

view
string
Enum: "upcoming" "all"

Reservation booking list view. Defaults to upcoming when omitted.

page
integer >= 1

1-based page number. Blank, invalid, and values below 1 use page 1.

per_page
integer [ 1 .. 100 ]

Number of records per page. Blank, invalid, and values below 1 use the endpoint default; values above 100 are capped at 100.

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Get reservation booking details by ID

Authorizations:
bearerAuth
path Parameters
id
required
string^[A-Za-z][A-Za-z0-9]+$

ID value (for example Ak3GtLx, Rk3GtLx, PHpmFGq, Of6Hk2a)

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

storefronts

Publishable storefront details.

List organizer storefronts

Authorizations:
bearerAuth
query Parameters
organizer_id
string
query
string
Example: query=basketball

Case-insensitive free-text search string.

status
string
Enum: "draft" "published" "archived"

Exact storefront lifecycle status filter.

view
string
Enum: "current" "all"

Storefront list view. Defaults to current when omitted.

page
integer >= 1

1-based page number. Blank, invalid, and values below 1 use page 1.

per_page
integer [ 1 .. 100 ]

Number of records per page. Blank, invalid, and values below 1 use the endpoint default; values above 100 are capped at 100.

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Create a storefront

Authorizations:
bearerAuth
Request Body schema: application/json
required
required
object (StorefrontCreateInput)

Responses

Request samples

Content type
application/json
{
  • "storefront": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Get storefront details by ID

Authorizations:
NonebearerAuth
path Parameters
id
required
string^[A-Za-z][A-Za-z0-9]+$

ID value (for example Ak3GtLx, Rk3GtLx, PHpmFGq, Of6Hk2a)

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Update a storefront

Authorizations:
bearerAuth
path Parameters
id
required
string^[A-Za-z][A-Za-z0-9]+$

ID value (for example Ak3GtLx, Rk3GtLx, PHpmFGq, Of6Hk2a)

Request Body schema: application/json
required
required
object (StorefrontUpdateInput) non-empty

Responses

Request samples

Content type
application/json
{
  • "storefront": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Delete a storefront

Authorizations:
bearerAuth
path Parameters
id
required
string^[A-Za-z][A-Za-z0-9]+$

ID value (for example Ak3GtLx, Rk3GtLx, PHpmFGq, Of6Hk2a)

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Publish a storefront

Authorizations:
bearerAuth
path Parameters
id
required
string^[A-Za-z][A-Za-z0-9]+$

ID value (for example Ak3GtLx, Rk3GtLx, PHpmFGq, Of6Hk2a)

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Unpublish a storefront

Authorizations:
bearerAuth
path Parameters
id
required
string^[A-Za-z][A-Za-z0-9]+$

ID value (for example Ak3GtLx, Rk3GtLx, PHpmFGq, Of6Hk2a)

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Archive a storefront

Authorizations:
bearerAuth
path Parameters
id
required
string^[A-Za-z][A-Za-z0-9]+$

ID value (for example Ak3GtLx, Rk3GtLx, PHpmFGq, Of6Hk2a)

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Unarchive a storefront

Authorizations:
bearerAuth
path Parameters
id
required
string^[A-Za-z][A-Za-z0-9]+$

ID value (for example Ak3GtLx, Rk3GtLx, PHpmFGq, Of6Hk2a)

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Attach a product to a storefront

Authorizations:
bearerAuth
path Parameters
id
required
string^[A-Za-z][A-Za-z0-9]+$

ID value (for example Ak3GtLx, Rk3GtLx, PHpmFGq, Of6Hk2a)

Request Body schema: application/json
required
product_id
required
string^[A-Za-z][A-Za-z0-9]+$

Responses

Request samples

Content type
application/json
{
  • "product_id": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Remove a product from a storefront

Authorizations:
bearerAuth
path Parameters
id
required
string^[A-Za-z][A-Za-z0-9]+$

ID value (for example Ak3GtLx, Rk3GtLx, PHpmFGq, Of6Hk2a)

product_id
required
string^[A-Za-z][A-Za-z0-9]+$

Product ID value (for example Jabc123)

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

storefront_orders

Organizer storefront order records.

List organizer storefront orders

Authorizations:
bearerAuth
query Parameters
organizer_id
string
storefront_id
string

Filter storefront orders to a single storefront id.

query
string
Example: query=basketball

Case-insensitive free-text search string.

status
string
Enum: "active" "pending" "canceled" "incomplete"

Exact storefront order status filter.

payment_status
string
Enum: "pending" "succeeded" "failed" "refunded" "free"

Exact storefront order payment status filter.

view
string
Enum: "current" "all"

Storefront order list view. Defaults to current when omitted.

page
integer >= 1

1-based page number. Blank, invalid, and values below 1 use page 1.

per_page
integer [ 1 .. 100 ]

Number of records per page. Blank, invalid, and values below 1 use the endpoint default; values above 100 are capped at 100.

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Get storefront order details by ID

Authorizations:
bearerAuth
path Parameters
id
required
string^[A-Za-z][A-Za-z0-9]+$

ID value (for example Ak3GtLx, Rk3GtLx, PHpmFGq, Of6Hk2a)

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

members

Organizer member details.

List organizer members

Authorizations:
bearerAuth
query Parameters
organizer_id
string
query
string
Example: query=basketball

Case-insensitive free-text search string.

status
string
Enum: "active" "canceled"

Exact member status filter.

view
string
Enum: "current" "all"

Member list view. Defaults to current when omitted.

page
integer >= 1

1-based page number. Blank, invalid, and values below 1 use page 1.

per_page
integer [ 1 .. 100 ]

Number of records per page. Blank, invalid, and values below 1 use the endpoint default; values above 100 are capped at 100.

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Get member details by ID

Authorizations:
bearerAuth
path Parameters
id
required
string^[A-Za-z][A-Za-z0-9]+$

ID value (for example Ak3GtLx, Rk3GtLx, PHpmFGq, Of6Hk2a)

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

registrations

Organizer registration details.

List organizer registrations

Authorizations:
bearerAuth
query Parameters
organizer_id
string
activity_id
string

Filter registrations to a single activity id.

query
string
Example: query=basketball

Case-insensitive free-text search string.

status
string
Enum: "active" "pending" "canceled" "incomplete"

Exact registration status filter.

payment_status
string
Enum: "pending" "succeeded" "failed" "refunded" "free"

Exact registration payment status filter.

view
string
Enum: "current" "all"

Registration list view. Defaults to current when omitted.

page
integer >= 1

1-based page number. Blank, invalid, and values below 1 use page 1.

per_page
integer [ 1 .. 100 ]

Number of records per page. Blank, invalid, and values below 1 use the endpoint default; values above 100 are capped at 100.

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Get registration details by ID

Authorizations:
bearerAuth
path Parameters
id
required
string^[A-Za-z][A-Za-z0-9]+$

ID value (for example Ak3GtLx, Rk3GtLx, PHpmFGq, Of6Hk2a)

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

referrals

Organizer referral records.

List organizer referrals

Authorizations:
bearerAuth
query Parameters
organizer_id
string
query
string
Example: query=basketball

Case-insensitive free-text search string.

page
integer >= 1

1-based page number. Blank, invalid, and values below 1 use page 1.

per_page
integer [ 1 .. 100 ]

Number of records per page. Blank, invalid, and values below 1 use the endpoint default; values above 100 are capped at 100.

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Get referral details by ID

Authorizations:
bearerAuth
path Parameters
id
required
string^[A-Za-z][A-Za-z0-9]+$

ID value (for example Ak3GtLx, Rk3GtLx, PHpmFGq, Of6Hk2a)

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

membership_subscriptions

Organizer membership subscription records.

List organizer membership subscriptions

Authorizations:
bearerAuth
query Parameters
organizer_id
string
membership_id
string

Filter membership subscriptions to a single membership id.

query
string
Example: query=basketball

Case-insensitive free-text search string.

status
string
Enum: "active" "past_due" "pending" "canceled" "paused" "incomplete"

Exact membership subscription status filter.

view
string
Enum: "current" "all"

Membership subscription list view. Defaults to current when omitted.

page
integer >= 1

1-based page number. Blank, invalid, and values below 1 use page 1.

per_page
integer [ 1 .. 100 ]

Number of records per page. Blank, invalid, and values below 1 use the endpoint default; values above 100 are capped at 100.

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Get membership subscription details by ID

Authorizations:
bearerAuth
path Parameters
id
required
string^[A-Za-z][A-Za-z0-9]+$

ID value (for example Ak3GtLx, Rk3GtLx, PHpmFGq, Of6Hk2a)

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

memberships

Publishable membership details.

List organizer memberships

Authorizations:
bearerAuth
query Parameters
organizer_id
string
query
string
Example: query=basketball

Case-insensitive free-text search string.

status
string
Enum: "draft" "published" "archived"

Exact membership lifecycle status filter.

view
string
Enum: "current" "all"

Membership list view. Use all to include draft, published, and archived memberships. When omitted, the API defaults to current memberships.

page
integer >= 1

1-based page number. Blank, invalid, and values below 1 use page 1.

per_page
integer [ 1 .. 100 ]

Number of records per page. Blank, invalid, and values below 1 use the endpoint default; values above 100 are capped at 100.

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Create a membership

Authorizations:
bearerAuth
Request Body schema: application/json
required
required
object (MembershipCreateInput)

Responses

Request samples

Content type
application/json
{
  • "membership": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Get membership details by ID

Authorizations:
NonebearerAuth
path Parameters
id
required
string^[A-Za-z][A-Za-z0-9]+$

ID value (for example Ak3GtLx, Rk3GtLx, PHpmFGq, Of6Hk2a)

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Update a membership

Authorizations:
bearerAuth
path Parameters
id
required
string^[A-Za-z][A-Za-z0-9]+$

ID value (for example Ak3GtLx, Rk3GtLx, PHpmFGq, Of6Hk2a)

Request Body schema: application/json
required
required
object (MembershipUpdateInput) non-empty

Responses

Request samples

Content type
application/json
{
  • "membership": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Delete a membership

Authorizations:
bearerAuth
path Parameters
id
required
string^[A-Za-z][A-Za-z0-9]+$

ID value (for example Ak3GtLx, Rk3GtLx, PHpmFGq, Of6Hk2a)

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Attach a product to a membership

Authorizations:
bearerAuth
path Parameters
id
required
string^[A-Za-z][A-Za-z0-9]+$

ID value (for example Ak3GtLx, Rk3GtLx, PHpmFGq, Of6Hk2a)

Request Body schema: application/json
required
product_id
required
string^[A-Za-z][A-Za-z0-9]+$

Responses

Request samples

Content type
application/json
{
  • "product_id": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Remove a product from a membership

Authorizations:
bearerAuth
path Parameters
id
required
string^[A-Za-z][A-Za-z0-9]+$

ID value (for example Ak3GtLx, Rk3GtLx, PHpmFGq, Of6Hk2a)

product_id
required
string^[A-Za-z][A-Za-z0-9]+$

Product ID value (for example Jabc123)

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Publish a membership

Authorizations:
bearerAuth
path Parameters
id
required
string^[A-Za-z][A-Za-z0-9]+$

ID value (for example Ak3GtLx, Rk3GtLx, PHpmFGq, Of6Hk2a)

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Unpublish a membership

Authorizations:
bearerAuth
path Parameters
id
required
string^[A-Za-z][A-Za-z0-9]+$

ID value (for example Ak3GtLx, Rk3GtLx, PHpmFGq, Of6Hk2a)

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Archive a membership

Authorizations:
bearerAuth
path Parameters
id
required
string^[A-Za-z][A-Za-z0-9]+$

ID value (for example Ak3GtLx, Rk3GtLx, PHpmFGq, Of6Hk2a)

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Unarchive a membership

Authorizations:
bearerAuth
path Parameters
id
required
string^[A-Za-z][A-Za-z0-9]+$

ID value (for example Ak3GtLx, Rk3GtLx, PHpmFGq, Of6Hk2a)

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

waivers

Publishable waiver details.

List organizer waivers

Authorizations:
bearerAuth
query Parameters
organizer_id
string
query
string
Example: query=basketball

Case-insensitive free-text search string.

status
string
Enum: "draft" "published" "archived"

Exact waiver lifecycle status filter.

view
string
Enum: "current" "all"

Waiver list view. Use all to include draft, published, and archived waivers. When omitted, the API defaults to current waivers.

page
integer >= 1

1-based page number. Blank, invalid, and values below 1 use page 1.

per_page
integer [ 1 .. 100 ]

Number of records per page. Blank, invalid, and values below 1 use the endpoint default; values above 100 are capped at 100.

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Create a waiver

Authorizations:
bearerAuth
Request Body schema: application/json
required
required
object (WaiverCreateInput)

Responses

Request samples

Content type
application/json
{
  • "waiver": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Get waiver details by ID

Authorizations:
NonebearerAuth
path Parameters
id
required
string^[A-Za-z][A-Za-z0-9]+$

ID value (for example Ak3GtLx, Rk3GtLx, PHpmFGq, Of6Hk2a)

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Update a waiver

Authorizations:
bearerAuth
path Parameters
id
required
string^[A-Za-z][A-Za-z0-9]+$

ID value (for example Ak3GtLx, Rk3GtLx, PHpmFGq, Of6Hk2a)

Request Body schema: application/json
required
required
object (WaiverUpdateInput) non-empty

Responses

Request samples

Content type
application/json
{
  • "waiver": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Delete a waiver

Authorizations:
bearerAuth
path Parameters
id
required
string^[A-Za-z][A-Za-z0-9]+$

ID value (for example Ak3GtLx, Rk3GtLx, PHpmFGq, Of6Hk2a)

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Publish a waiver

Authorizations:
bearerAuth
path Parameters
id
required
string^[A-Za-z][A-Za-z0-9]+$

ID value (for example Ak3GtLx, Rk3GtLx, PHpmFGq, Of6Hk2a)

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Unpublish a waiver

Authorizations:
bearerAuth
path Parameters
id
required
string^[A-Za-z][A-Za-z0-9]+$

ID value (for example Ak3GtLx, Rk3GtLx, PHpmFGq, Of6Hk2a)

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Archive a waiver

Authorizations:
bearerAuth
path Parameters
id
required
string^[A-Za-z][A-Za-z0-9]+$

ID value (for example Ak3GtLx, Rk3GtLx, PHpmFGq, Of6Hk2a)

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Unarchive a waiver

Authorizations:
bearerAuth
path Parameters
id
required
string^[A-Za-z][A-Za-z0-9]+$

ID value (for example Ak3GtLx, Rk3GtLx, PHpmFGq, Of6Hk2a)

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

signed_waivers

Organizer signed waiver records.

List organizer signed waivers

Authorizations:
bearerAuth
query Parameters
organizer_id
string
waiver_id
string

Filter signed waivers to a single waiver id.

query
string
Example: query=basketball

Case-insensitive free-text search string.

page
integer >= 1

1-based page number. Blank, invalid, and values below 1 use page 1.

per_page
integer [ 1 .. 100 ]

Number of records per page. Blank, invalid, and values below 1 use the endpoint default; values above 100 are capped at 100.

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Get signed waiver details by ID

Authorizations:
bearerAuth
path Parameters
id
required
string^[A-Za-z][A-Za-z0-9]+$

ID value (for example Ak3GtLx, Rk3GtLx, PHpmFGq, Of6Hk2a)

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

pages

Publishable page content.

List organizer pages

Authorizations:
bearerAuth
query Parameters
organizer_id
string
query
string
Example: query=basketball

Case-insensitive free-text search string.

status
string
Enum: "draft" "published" "archived"

Exact page lifecycle status filter.

view
string
Enum: "current" "all"

Page list view. Use all to include draft, published, and archived pages. When omitted, the API defaults to current pages.

page
integer >= 1

1-based page number. Blank, invalid, and values below 1 use page 1.

per_page
integer [ 1 .. 100 ]

Number of records per page. Blank, invalid, and values below 1 use the endpoint default; values above 100 are capped at 100.

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Create a page

Authorizations:
bearerAuth
Request Body schema: application/json
required
required
object (PageCreateInput)

Responses

Request samples

Content type
application/json
{
  • "page": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Get page details by ID

Authorizations:
NonebearerAuth
path Parameters
id
required
string^[A-Za-z][A-Za-z0-9]+$

ID value (for example Ak3GtLx, Rk3GtLx, PHpmFGq, Of6Hk2a)

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Update a page

Authorizations:
bearerAuth
path Parameters
id
required
string^[A-Za-z][A-Za-z0-9]+$

ID value (for example Ak3GtLx, Rk3GtLx, PHpmFGq, Of6Hk2a)

Request Body schema: application/json
required
required
object (PageUpdateInput) non-empty

Responses

Request samples

Content type
application/json
{
  • "page": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Delete a page

Authorizations:
bearerAuth
path Parameters
id
required
string^[A-Za-z][A-Za-z0-9]+$

ID value (for example Ak3GtLx, Rk3GtLx, PHpmFGq, Of6Hk2a)

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Publish a page

Authorizations:
bearerAuth
path Parameters
id
required
string^[A-Za-z][A-Za-z0-9]+$

ID value (for example Ak3GtLx, Rk3GtLx, PHpmFGq, Of6Hk2a)

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Unpublish a page

Authorizations:
bearerAuth
path Parameters
id
required
string^[A-Za-z][A-Za-z0-9]+$

ID value (for example Ak3GtLx, Rk3GtLx, PHpmFGq, Of6Hk2a)

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Archive a page

Authorizations:
bearerAuth
path Parameters
id
required
string^[A-Za-z][A-Za-z0-9]+$

ID value (for example Ak3GtLx, Rk3GtLx, PHpmFGq, Of6Hk2a)

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Unarchive a page

Authorizations:
bearerAuth
path Parameters
id
required
string^[A-Za-z][A-Za-z0-9]+$

ID value (for example Ak3GtLx, Rk3GtLx, PHpmFGq, Of6Hk2a)

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

uploads

Publishable upload metadata.

List organizer uploads

Authorizations:
bearerAuth
query Parameters
organizer_id
string
query
string
Example: query=basketball

Case-insensitive free-text search string.

status
string
Enum: "draft" "published" "archived"

Exact upload lifecycle status filter.

view
string
Enum: "current" "all"

Upload list view. Use all to include draft, published, and archived uploads. When omitted, the API defaults to current uploads.

page
integer >= 1

1-based page number. Blank, invalid, and values below 1 use page 1.

per_page
integer [ 1 .. 100 ]

Number of records per page. Blank, invalid, and values below 1 use the endpoint default; values above 100 are capped at 100.

Responses

Response samples

Content type
application/json
{
  • "data": {},
  • "meta": {
    }
}

Create an upload

Authorizations:
bearerAuth
Request Body schema: application/json
required
required
object (UploadCreateInput)

Responses

Request samples

Content type
application/json
{
  • "upload": {
    }
}

Response samples

Content type
application/json
{
  • "data": {},
  • "meta": {
    }
}

Get upload details by ID

Authorizations:
NonebearerAuth
path Parameters
id
required
string^[A-Za-z][A-Za-z0-9]+$

ID value (for example Ak3GtLx, Rk3GtLx, PHpmFGq, Of6Hk2a)

Responses

Response samples

Content type
application/json
{
  • "data": {},
  • "meta": {
    }
}

Update an upload

Authorizations:
bearerAuth
path Parameters
id
required
string^[A-Za-z][A-Za-z0-9]+$

ID value (for example Ak3GtLx, Rk3GtLx, PHpmFGq, Of6Hk2a)

Request Body schema: application/json
required
required
object (UploadUpdateInput) non-empty

Responses

Request samples

Content type
application/json
{
  • "upload": {
    }
}

Response samples

Content type
application/json
{
  • "data": {},
  • "meta": {
    }
}

Delete an upload

Authorizations:
bearerAuth
path Parameters
id
required
string^[A-Za-z][A-Za-z0-9]+$

ID value (for example Ak3GtLx, Rk3GtLx, PHpmFGq, Of6Hk2a)

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Publish an upload

Authorizations:
bearerAuth
path Parameters
id
required
string^[A-Za-z][A-Za-z0-9]+$

ID value (for example Ak3GtLx, Rk3GtLx, PHpmFGq, Of6Hk2a)

Responses

Response samples

Content type
application/json
{
  • "data": {},
  • "meta": {
    }
}

Unpublish an upload

Authorizations:
bearerAuth
path Parameters
id
required
string^[A-Za-z][A-Za-z0-9]+$

ID value (for example Ak3GtLx, Rk3GtLx, PHpmFGq, Of6Hk2a)

Responses

Response samples

Content type
application/json
{
  • "data": {},
  • "meta": {
    }
}

Archive an upload

Authorizations:
bearerAuth
path Parameters
id
required
string^[A-Za-z][A-Za-z0-9]+$

ID value (for example Ak3GtLx, Rk3GtLx, PHpmFGq, Of6Hk2a)

Responses

Response samples

Content type
application/json
{
  • "data": {},
  • "meta": {
    }
}

Unarchive an upload

Authorizations:
bearerAuth
path Parameters
id
required
string^[A-Za-z][A-Za-z0-9]+$

ID value (for example Ak3GtLx, Rk3GtLx, PHpmFGq, Of6Hk2a)

Responses

Response samples

Content type
application/json
{
  • "data": {},
  • "meta": {
    }
}

referral_programs

Organizer referral program details.

Create an organizer referral program

Authorizations:
bearerAuth
Request Body schema: application/json
required
required
object (OrganizerReferralProgramCreateInput)

Responses

Request samples

Content type
application/json
{
  • "referral_program": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Get referral program by organizer ID

Authorizations:
NonebearerAuth
path Parameters
id
required
string^[A-Za-z][A-Za-z0-9]+$

ID value (for example Ak3GtLx, Rk3GtLx, PHpmFGq, Of6Hk2a)

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Update referral program by organizer ID

Authorizations:
bearerAuth
path Parameters
id
required
string^[A-Za-z][A-Za-z0-9]+$

ID value (for example Ak3GtLx, Rk3GtLx, PHpmFGq, Of6Hk2a)

Request Body schema: application/json
required
required
object (OrganizerReferralProgramUpdateInput) non-empty

Responses

Request samples

Content type
application/json
{
  • "referral_program": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Delete referral program by organizer ID

Authorizations:
bearerAuth
path Parameters
id
required
string^[A-Za-z][A-Za-z0-9]+$

ID value (for example Ak3GtLx, Rk3GtLx, PHpmFGq, Of6Hk2a)

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Publish an organizer referral program

Authorizations:
bearerAuth
path Parameters
id
required
string^[A-Za-z][A-Za-z0-9]+$

ID value (for example Ak3GtLx, Rk3GtLx, PHpmFGq, Of6Hk2a)

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Unpublish an organizer referral program

Authorizations:
bearerAuth
path Parameters
id
required
string^[A-Za-z][A-Za-z0-9]+$

ID value (for example Ak3GtLx, Rk3GtLx, PHpmFGq, Of6Hk2a)

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

sponsorship_programs

Organizer sponsorship program and sponsor package details.

Create an organizer sponsorship program

Authorizations:
bearerAuth
Request Body schema: application/json
required
required
object

Responses

Request samples

Content type
application/json
{
  • "sponsorship_program": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Get sponsorship program details

Authorizations:
NonebearerAuth
path Parameters
id
required
string^[A-Za-z][A-Za-z0-9]+$

ID value (for example Ak3GtLx, Rk3GtLx, PHpmFGq, Of6Hk2a)

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Update a sponsorship program

Authorizations:
bearerAuth
path Parameters
id
required
string^[A-Za-z][A-Za-z0-9]+$

ID value (for example Ak3GtLx, Rk3GtLx, PHpmFGq, Of6Hk2a)

Request Body schema: application/json
required
required
object (SponsorshipProgramInput)

Responses

Request samples

Content type
application/json
{
  • "sponsorship_program": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Delete a sponsorship program

Authorizations:
bearerAuth
path Parameters
id
required
string^[A-Za-z][A-Za-z0-9]+$

ID value (for example Ak3GtLx, Rk3GtLx, PHpmFGq, Of6Hk2a)

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Publish a sponsorship program

Authorizations:
bearerAuth
path Parameters
sponsorship_program_id
required
string^N[A-Za-z0-9]+$

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Unpublish a sponsorship program

Authorizations:
bearerAuth
path Parameters
sponsorship_program_id
required
string^N[A-Za-z0-9]+$

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

List sponsor packages for a sponsorship program

Authorizations:
NonebearerAuth
path Parameters
sponsorship_program_id
required
string^N[A-Za-z0-9]+$

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Create a sponsor package

Authorizations:
bearerAuth
path Parameters
sponsorship_program_id
required
string^N[A-Za-z0-9]+$
Request Body schema: application/json
required
required
object

Responses

Request samples

Content type
application/json
{
  • "sponsor_package": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Get a sponsor package

Authorizations:
NonebearerAuth
path Parameters
sponsorship_program_id
required
string^N[A-Za-z0-9]+$
sponsor_package_id
required
string^U[A-Za-z0-9]+$

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Update a sponsor package

Authorizations:
bearerAuth
path Parameters
sponsorship_program_id
required
string^N[A-Za-z0-9]+$
sponsor_package_id
required
string^U[A-Za-z0-9]+$
Request Body schema: application/json
required
required
object (SponsorPackageInput)

Responses

Request samples

Content type
application/json
{
  • "sponsor_package": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Delete a sponsor package

Authorizations:
bearerAuth
path Parameters
sponsorship_program_id
required
string^N[A-Za-z0-9]+$
sponsor_package_id
required
string^U[A-Za-z0-9]+$

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

sponsorships

Organizer sponsorship purchase records.

List organizer sponsorships

Authorizations:
bearerAuth
query Parameters
organizer_id
string
sponsor_package_id
string^U[A-Za-z0-9]+$

Filter sponsorships to a single sponsor package id.

query
string
Example: query=basketball

Case-insensitive free-text search string.

status
string
Enum: "pending" "active" "incomplete" "canceled"

Exact sponsorship lifecycle status filter.

payment_status
string
Enum: "pending" "succeeded" "failed" "refunded" "free"

Exact sponsorship payment/refund status filter.

view
string
Enum: "current" "displayable" "all"

Sponsorship list view. Use displayable for approved paid/free current sponsorships with logos.

page
integer >= 1

1-based page number. Blank, invalid, and values below 1 use page 1.

per_page
integer [ 1 .. 100 ]

Number of records per page. Blank, invalid, and values below 1 use the endpoint default; values above 100 are capped at 100.

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Record an offline or free sponsorship

Authorizations:
bearerAuth
Request Body schema: application/json
required
required
object (SponsorshipCreateInput)

Responses

Request samples

Content type
application/json
{
  • "sponsorship": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Get sponsorship details

Authorizations:
bearerAuth
path Parameters
id
required
string^[A-Za-z][A-Za-z0-9]+$

ID value (for example Ak3GtLx, Rk3GtLx, PHpmFGq, Of6Hk2a)

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Update sponsorship display details

Authorizations:
bearerAuth
path Parameters
id
required
string^[A-Za-z][A-Za-z0-9]+$

ID value (for example Ak3GtLx, Rk3GtLx, PHpmFGq, Of6Hk2a)

Request Body schema: application/json
required
required
object (SponsorshipUpdateInput)

Responses

Request samples

Content type
application/json
{
  • "sponsorship": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Approve sponsorship display

Authorizations:
bearerAuth
path Parameters
sponsorship_id
required
string
Example: Xabc123

Sponsorship ID.

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Remove sponsorship display approval

Authorizations:
bearerAuth
path Parameters
sponsorship_id
required
string
Example: Xabc123

Sponsorship ID.

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Cancel a sponsorship

Authorizations:
bearerAuth
path Parameters
sponsorship_id
required
string
Example: Xabc123

Sponsorship ID.

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Reinstate a canceled sponsorship

Authorizations:
bearerAuth
path Parameters
sponsorship_id
required
string
Example: Xabc123

Sponsorship ID.

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Refund a sponsorship

Authorizations:
bearerAuth
path Parameters
sponsorship_id
required
string
Example: Xabc123

Sponsorship ID.

Request Body schema: application/json
required
required
object (SponsorshipRefundInput)

Responses

Request samples

Content type
application/json
{
  • "refund": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}