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.

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
{}

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

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
{}

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
{}

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
per_page
integer [ 1 .. 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
{}

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
{}

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
per_page
integer [ 1 .. 100 ]

Responses

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" "single_elimination" "double_elimination" "triple_elimination"

Filter schedules by schedule format.

page
integer >= 1
per_page
integer [ 1 .. 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
{}

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
{}

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
{}

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
{}

Unpublish a schedule

Authorizations:
bearerAuth
path Parameters
schedule_id
required
string

Responses

Response samples

Content type
application/json
{}

Archive a schedule

Authorizations:
bearerAuth
path Parameters
schedule_id
required
string

Responses

Response samples

Content type
application/json
{}

Unarchive a schedule

Authorizations:
bearerAuth
path Parameters
schedule_id
required
string

Responses

Response samples

Content type
application/json
{}

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
{}

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
per_page
integer [ 1 .. 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": {
    }
}

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
per_page
integer [ 1 .. 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
per_page
integer [ 1 .. 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
per_page
integer [ 1 .. 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": {
    }
}

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
per_page
integer [ 1 .. 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
per_page
integer [ 1 .. 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
{}

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
{}

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
{}

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
{}

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
{}

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
{}

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
{}

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
{}

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
{}

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
per_page
integer [ 1 .. 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
per_page
integer [ 1 .. 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
per_page
integer [ 1 .. 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
per_page
integer [ 1 .. 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
per_page
integer [ 1 .. 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
per_page
integer [ 1 .. 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
per_page
integer [ 1 .. 100 ]

Responses

Response samples

Content type
application/json
{}

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
{}

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
{}

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
{}

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
{}

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
{}

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
{}

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
{}

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
per_page
integer [ 1 .. 100 ]

Responses

Response samples

Content type
application/json
{}

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
{}

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
per_page
integer [ 1 .. 100 ]

Responses

Response samples

Content type
application/json
{}

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
{}

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
{}

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
{}

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
{}

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
{}

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
{}

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
{}

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
per_page
integer [ 1 .. 100 ]

Responses

Response samples

Content type
application/json
{}

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
{}

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
{}

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
{}

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
{}

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
{}

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
{}

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
{}

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": {
    }
}