API docs by Redocly

Playpass API (2026-02-08)

Download OpenAPI specification:

License: Proprietary

API contract for the Playpass API. New to Playpass API? Start with the Developer Guide or use the bundled OpenAPI document. 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 uses the authorization-code flow with PKCE S256 and enforced api:read / api:write scopes; discover the server at /.well-known/oauth-authorization-server and this protected resource at /.well-known/oauth-protected-resource/api. API requests have a generous shared abuse ceiling, and credential issuance or externally triggered workflows have tighter per-actor or per-IP limits. Responses include RateLimit-Policy and RateLimit fields plus transitional split fields. Rate-limited requests return 429 with Retry-After. Playpass uses date-based API versions; backward-compatible additions can ship within the current version, while a breaking change requires a new dated version. Deprecations receive at least 90 days' notice except for urgent security, privacy, legal, or reliability issues, and affected responses use Deprecation and Sunset headers. See the versioning and deprecation policy. Requests may omit X-Playpass-Api-Version to use the current version or send a version listed by this contract. Unsupported values return 400 with the unsupported_api_version error code. API request bodies are limited to 16 MiB; oversized requests return 413.

Playpass developer guide, API lifecycle policy, and CLI setup

discoveries

Public, privacy-safe discovery of organizer pages.

Discover public Playpass pages

Returns compact, public, organizer-owned pages suitable for search agents and other discovery clients. A resource type is required. Date filters apply to activities and schedules. Responses intentionally omit audit timestamps and private organizer or player data.

query Parameters
type
required
string
Enum: "activity" "league_schedule" "tournament_schedule" "membership" "booking" "storefront"

Public resource type to discover.

query
string
Example: query=basketball

Case-insensitive free-text search string.

sport
string

Sport slug, such as soccer or basketball.

city
string

City URL slug, full name, or name.

date_from
string <date>

Include activities or schedules ending on or after this date.

date_to
string <date>

Include activities or schedules starting on or before this 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.

header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

Responses

Response samples

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

oauth

OAuth authorization and token exchange for ChatGPT Actions.

Start OAuth authorization code flow

Validates the OAuth request and redirects to the registered callback with a one-time authorization code or error. Requires a signed-in Playpass browser session; an API bearer token is not accepted for this consent step. Uses documented parameters for response type, client id, redirect uri, code challenge, code challenge method, scope, and state. Supported scopes are api:read and api:write; the canonical granted scope is carried by the one-time code. During the controlled two-step verification rollout, accounts that require it are redirected to the registered callback with error=access_denied instead of receiving an authorization code. Successful responses are 200 (Authorization page rendered (if user interaction is required)) and 302 (Redirect to OAuth callback URL with code or error). The documented client-error status is 400.

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
scope
string
Examples: scope=api:read scope=api:read api:write

Space-delimited OAuth scopes. Supported values are api:read and api:write; api:write includes read access. Omission preserves the existing Action behavior by granting both scopes.

header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

Responses

Response samples

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

Exchange OAuth authorization code for API access token

Exchanges a valid authorization code and PKCE verifier for an OAuth access token after validating the client, redirect URI, and optional equivalent scope repetition. The response reports the canonical scope carried by the authorization code. Uses OAuth client credentials and the one-time code; an API bearer token is not used. Accepts application/json and application/x-www-form-urlencoded request bodies. A successful request returns 200 (OAuth token issued). The documented client-error status is 400.

header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

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
scope
string

Optional scope value equivalent to the authorization grant. It cannot expand the capabilities carried by the authorization code.

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",
  • "scope": "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.

header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

Responses

Response samples

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

Create a guest draft schedule

Creates a draft schedule owned by the supplied guest session token. Requires a guest session token in the JSON body; an API bearer token is not used. Accepts an application/json request body. A successful request returns 201 (Schedule created). Documented client-error statuses are 401 and 422.

header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

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

Returns the draft schedule owned by the supplied guest session token. Requires the guest_session_token query parameter that owns the draft; an API bearer token is not used. Uses documented parameters for id and guest session token. A successful request returns 200 (Schedule found). Documented client-error statuses are 401, 404, and 422.

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.

header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

Responses

Response samples

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

Get games for a guest-owned schedule

Returns filtered, paginated games for the draft schedule owned by the supplied guest session token. Requires the guest_session_token query parameter that owns the draft; an API bearer token is not used. Uses documented parameters for id, guest session token, status, team, group, court, style, page, and per page. A successful request returns 200 (Games found). Documented client-error statuses are 401, 403, 404, and 422.

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.

header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

Responses

Response samples

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

Get standings for a guest-owned robin schedule

Returns standings for a guest-owned round-robin draft schedule. Requires the guest_session_token query parameter that owns the draft; an API bearer token is not used. Uses documented parameters for id, guest session token, team, and group. A successful request returns 200 (Standings found). Documented client-error statuses are 401, 403, 404, and 422.

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
header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

Responses

Response samples

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

organizers

Organizer profile and metadata.

Create an organizer for the authenticated user

Creates an organizer owned by the authenticated Playpass user. Requires a user OAuth access token with api:write. Accepts an application/json request body. A successful request returns 201 (Organizer created). Documented client-error statuses are 401, 403, and 422.

Authorizations:
oauth2
header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

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

Returns organizer details by ID or slug without changing the resource. Allows public access to published fields; a bearer token authorized for the organizer can access manager-visible data. Uses the documented organizer lookup parameter. A successful request returns 200 (Organizer found). Documented client-error statuses are 401, 403, and 404.

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

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

header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

Responses

Response samples

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

Update an organizer

Updates an organizer from supplied fields; omitted fields remain unchanged. Requires a bearer manager API token or OAuth access token authorized for the target organizer resource. Uses the documented organizer lookup parameter. Accepts an application/json request body. A successful request returns 200 (Organizer updated). Documented client-error statuses are 401, 403, 404, and 422.

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

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

header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

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

Transfers schedules owned by a guest session into the authenticated organizer. Requires a user OAuth access token with api:write. Uses documented parameters for organizer id and profile. Accepts an application/json request body. A successful request returns 200 (Guest schedules claimed). Canonical schedules cannot change owner or organizer through this endpoint; an exact same-destination retry remains a no-op. A canonical ownership conflict or concurrent schedule change returns 409. Documented client-error statuses are 401, 403, 404, and 409.

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

Response detail profile. Defaults to slim.

header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

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

Starts the current trial for an eligible organizer and returns the resulting trial status. Requires a user OAuth access token with api:write. Uses documented parameters for organizer id and profile. A successful request returns 200 (Organizer trial status). Documented client-error statuses are 401, 403, and 404.

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

Response detail profile. Defaults to slim.

header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

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:
oauth2
path Parameters
organizer_id
required
string
query Parameters
profile
string
Enum: "slim" "detail"

Response detail profile. Defaults to slim.

header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

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:
oauth2
path Parameters
organizer_id
required
string
query Parameters
profile
string
Enum: "slim" "detail"

Response detail profile. Defaults to slim.

header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

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:
oauth2
path Parameters
organizer_id
required
string
token_id
required
integer
query Parameters
profile
string
Enum: "slim" "detail"

Response detail profile. Defaults to slim.

header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

Responses

Response samples

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

List organizer managers

Lists organizer staff roles that can help manage the organizer.

Authorizations:
bearerAuthoauth2
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.

header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

Responses

Response samples

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

Create organizer manager

Adds a staff role to an organizer.

Authorizations:
bearerAuthoauth2
path Parameters
organizer_id
required
string
header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

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:
bearerAuthoauth2
path Parameters
organizer_id
required
string
manager_id
required
string

Prefixed manager role id.

header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

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:
bearerAuthoauth2
path Parameters
organizer_id
required
string
header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

Responses

Response samples

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

Create organizer custom domain

Requests a custom domain hostname and generates DNS instructions.

Authorizations:
bearerAuthoauth2
path Parameters
organizer_id
required
string
header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

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:
bearerAuthoauth2
path Parameters
organizer_id
required
string
header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

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:
bearerAuthoauth2
path Parameters
organizer_id
required
string
header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

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:
bearerAuthoauth2
path Parameters
organizer_id
required
string
header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

Responses

Response samples

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

Get organizer homepage items

Returns organizer homepage items without changing the resource. Allows public access to published fields; a bearer token authorized for the organizer can access manager-visible data. Uses documented parameters for organizer lookup, query, sport, page, and per page. A successful request returns 200 (Organizer items found). Documented client-error statuses are 401, 403, and 404.

Authorizations:
NonebearerAuthoauth2
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.

header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

Responses

Response samples

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

questions

Organizer checkout questions.

List organizer or product questions

Lists organizer-level checkout questions, or one product's questions when product_id is supplied.

Authorizations:
bearerAuthoauth2
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.

product_id
string

Product id used to list that product's checkout questions.

header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

Responses

Response samples

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

Create organizer or product question

Creates an organizer-level question, or a product question when product_id is supplied.

Authorizations:
bearerAuthoauth2
path Parameters
organizer_id
required
string
header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

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 checkout question

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

Authorizations:
bearerAuthoauth2
path Parameters
organizer_id
required
string
question_id
required
integer >= 1
header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

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 checkout question

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

Authorizations:
bearerAuthoauth2
path Parameters
organizer_id
required
string
question_id
required
integer >= 1
header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

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. Query searches coupon codes and manager-only internal notes.

Authorizations:
bearerAuthoauth2
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.

header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

Responses

Response samples

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

Create organizer coupon

Creates a new organizer coupon for checkout discounts, with optional manager-only context.

Authorizations:
bearerAuthoauth2
path Parameters
organizer_id
required
string
header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

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 manager-only internal note, enabled checkout types, and redemption count.

Authorizations:
bearerAuthoauth2
path Parameters
organizer_id
required
string
coupon_id
required
string
header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

Responses

Response samples

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

Update organizer coupon

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

Authorizations:
bearerAuthoauth2
path Parameters
organizer_id
required
string
coupon_id
required
string
header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

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:
bearerAuthoauth2
path Parameters
organizer_id
required
string
coupon_id
required
string
header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

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:
bearerAuthoauth2
path Parameters
organizer_id
required
string
header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

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:
bearerAuthoauth2
path Parameters
organizer_id
required
string
header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

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:
bearerAuthoauth2
path Parameters
organizer_id
required
string
header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

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:
oauth2
path Parameters
team_id
required
string
Example: Vabc123

Prefixed standalone team identifier.

header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

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:
oauth2
path Parameters
team_id
required
string
Example: Vabc123

Prefixed standalone team identifier.

header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

Responses

Response samples

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

List team payment requests

Lists private payment requests for an owned standalone team.

Authorizations:
oauth2
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.

header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

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:
oauth2
path Parameters
team_id
required
string
Example: Vabc123

Prefixed standalone team identifier.

header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

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:
oauth2
path Parameters
team_id
required
string
Example: Vabc123

Prefixed standalone team identifier.

payment_request_id
required
string
Example: TRABC1234

Prefixed team payment request identifier.

header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

Responses

Response samples

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

Update team payment request

Updates editable fields on a draft team payment request.

Authorizations:
oauth2
path Parameters
team_id
required
string
Example: Vabc123

Prefixed standalone team identifier.

payment_request_id
required
string
Example: TRABC1234

Prefixed team payment request identifier.

header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

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:
oauth2
path Parameters
team_id
required
string
Example: Vabc123

Prefixed standalone team identifier.

payment_request_id
required
string
Example: TRABC1234

Prefixed team payment request identifier.

header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

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:
oauth2
path Parameters
team_id
required
string
Example: Vabc123

Prefixed standalone team identifier.

payment_request_id
required
string
Example: TRABC1234

Prefixed team payment request identifier.

header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

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:
oauth2
path Parameters
team_id
required
string
Example: Vabc123

Prefixed standalone team identifier.

payment_request_id
required
string
Example: TRABC1234

Prefixed team payment request identifier.

header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

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:
oauth2
path Parameters
team_id
required
string
Example: Vabc123

Prefixed standalone team identifier.

payment_request_id
required
string
Example: TRABC1234

Prefixed team payment request identifier.

header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

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:
oauth2
path Parameters
team_id
required
string
Example: Vabc123

Prefixed standalone team identifier.

payment_assignment_id
required
string
Example: TAABC1234

Prefixed team payment assignment identifier.

header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

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:
oauth2
path Parameters
team_id
required
string
Example: Vabc123

Prefixed standalone team identifier.

payment_assignment_id
required
string
Example: TAABC1234

Prefixed team payment assignment identifier.

header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

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:
oauth2
path Parameters
team_id
required
string
Example: Vabc123

Prefixed standalone team identifier.

payment_assignment_id
required
string
Example: TAABC1234

Prefixed team payment assignment identifier.

header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

Responses

Response samples

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

Waive team payment assignment

Waives one member assignment.

Authorizations:
oauth2
path Parameters
team_id
required
string
Example: Vabc123

Prefixed standalone team identifier.

payment_assignment_id
required
string
Example: TAABC1234

Prefixed team payment assignment identifier.

header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

Responses

Response samples

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

Clear team payment waiver

Reopens a waived assignment while preserving its audit history.

Authorizations:
oauth2
path Parameters
team_id
required
string
Example: Vabc123

Prefixed standalone team identifier.

payment_assignment_id
required
string
Example: TAABC1234

Prefixed team payment assignment identifier.

header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

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:
oauth2
path Parameters
team_id
required
string
Example: Vabc123

Prefixed standalone team identifier.

payment_assignment_id
required
string
Example: TAABC1234

Prefixed team payment assignment identifier.

header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

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:
bearerAuthoauth2
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.

header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

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:
bearerAuthoauth2
path Parameters
organizer_id
required
string
header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

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:
bearerAuthoauth2
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.

header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

Responses

Response samples

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

Reply to organizer conversation

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

Authorizations:
bearerAuthoauth2
path Parameters
organizer_id
required
string
conversation_id
required
string
header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

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:
bearerAuthoauth2
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.

header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

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:
bearerAuthoauth2
path Parameters
organizer_id
required
string
header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

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

Returns a collection of schedules for an organizer context available in the requested organizer context. Requires a bearer manager API token or OAuth access token authorized for the target organizer resource. Uses documented parameters for organizer id query, query, schedule status, schedule view, sport, schedule format, page, and per page. A successful request returns 200 (Schedules found). Documented client-error statuses are 401, 403, and 422.

Authorizations:
bearerAuthoauth2
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.

header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

Responses

Response samples

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

Create a schedule

Creates a schedule from the supplied attributes. Requires a bearer manager API token or OAuth access token authorized for the target organizer resource. Accepts an application/json request body. A completed creation returns 201 (Schedule created). If creation is still being confirmed, the response is 202 and includes the saved schedule id and manager.creation_status. Retrieve GET /api/schedules/{id} to check the result; submitting another POST creates another schedule. Documented client-error statuses are 401, 403, and 422.

Authorizations:
bearerAuthoauth2
header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

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

Returns schedule details by ID without changing the resource. Allows public access to published fields; a bearer token authorized for the organizer can access manager-visible data. Uses the documented id parameter. A successful request returns 200 (Schedule found). Documented client-error statuses are 401, 403, 404, and 422.

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

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

header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

Responses

Response samples

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

Update a schedule

Updates a schedule from supplied fields; omitted fields remain unchanged. Player-stat settings can be changed on supported competitive robins and standalone playoffs. Attached playoffs inherit those settings and reject direct changes, so callers must update the parent robin. Requires a bearer manager API token or OAuth access token authorized for the target organizer resource. Uses the documented id parameter. Accepts an application/json request body. A completed save returns 200 (Schedule updated). If confirmation is pending, the response is 202 and includes manager.update_status; retrieve GET /api/schedules/{id} to check the retained save before submitting another change. Documented client-error statuses are 401, 403, 404, and 422.

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

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

header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

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

Deletes a schedule after ownership and lifecycle checks pass. Requires a bearer manager API token or OAuth access token authorized for the target organizer resource. Uses the documented id parameter. A successful request returns 200 (Schedule deleted). Documented client-error statuses are 401, 403, 404, and 422.

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

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

header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

Responses

Response samples

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

Publish a schedule

Publishes a schedule on its player-facing organizer surface. Requires a bearer manager API token or OAuth access token authorized for the target organizer resource. Uses the documented schedule id parameter. A successful request returns 200 (Schedule published). Documented client-error statuses are 401, 403, 404, and 422.

Authorizations:
bearerAuthoauth2
path Parameters
schedule_id
required
string
header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

Responses

Response samples

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

Unpublish a schedule

Removes a schedule from public view without deleting it. Requires a bearer manager API token or OAuth access token authorized for the target organizer resource. Uses the documented schedule id parameter. A successful request returns 200 (Schedule unpublished). Documented client-error statuses are 401, 403, 404, and 422.

Authorizations:
bearerAuthoauth2
path Parameters
schedule_id
required
string
header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

Responses

Response samples

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

Archive a schedule

Archives a schedule without deleting its stored record. Requires a bearer manager API token or OAuth access token authorized for the target organizer resource. Uses the documented schedule id parameter. A successful request returns 200 (Schedule archived). Documented client-error statuses are 401, 403, 404, and 422.

Authorizations:
bearerAuthoauth2
path Parameters
schedule_id
required
string
header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

Responses

Response samples

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

Unarchive a schedule

Restores a schedule to the organizer's active records. Requires a bearer manager API token or OAuth access token authorized for the target organizer resource. Uses the documented schedule id parameter. A successful request returns 200 (Schedule unarchived). Documented client-error statuses are 401, 403, 404, and 422.

Authorizations:
bearerAuthoauth2
path Parameters
schedule_id
required
string
header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

Responses

Response samples

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

Add teams to a schedule

Adds the supplied teams to a schedule in one request and returns the updated schedule. Requires a bearer manager API token or OAuth access token authorized for the target organizer resource. Uses the documented schedule id parameter. Accepts an application/json request body. A completed request returns 200. A durable update awaiting confirmation returns 202 with the last saved schedule and manager.update_status set to pending; retrieve the schedule before submitting another change. Documented client-error statuses are 401, 403, 404, and 422.

Authorizations:
bearerAuthoauth2
path Parameters
schedule_id
required
string
header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

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

Returns schedule games without changing the resource. Allows public access to published fields; a bearer token authorized for the organizer can access manager-visible data. Uses documented parameters for id, status, team, group, court, style, page, and per page. A successful request returns 200 (Games found). Documented client-error statuses are 401, 403, 404, and 422.

Authorizations:
NonebearerAuthoauth2
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.

header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

Responses

Response samples

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

Get standings (robin schedules only)

Returns standings (robin schedules only) without changing the resource. Allows public access to published fields; a bearer token authorized for the organizer can access manager-visible data. Uses documented parameters for id, team, and group. A successful request returns 200 (Standings found). Documented client-error statuses are 401, 403, 404, and 422.

Authorizations:
NonebearerAuthoauth2
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
header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

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

Returns a collection of organizer check-in sessions available in the requested organizer context. Requires a bearer manager API token or OAuth access token authorized for the target organizer resource. Uses documented parameters for organizer id query, attendance session status, attendance source type, attendance source id, attendance from date, attendance to date, page, and per page. A successful request returns 200 (Check-in sessions found). Documented client-error statuses are 401, 403, and 422.

Authorizations:
bearerAuthoauth2
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.

header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

Responses

Response samples

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

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

Starts a check-in session for the selected activity, membership, or booking and returns the existing open session for an idempotent retry. Requires a bearer manager API token or OAuth access token authorized for the target organizer resource. Accepts an application/json request body. A successful request returns 201 (Check-in session started or recovered idempotently). Documented client-error statuses are 401, 403, 404, and 422.

Authorizations:
bearerAuthoauth2
header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

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

Returns a check-in roster without changing the resource. Requires a bearer manager API token or OAuth access token authorized for the target organizer resource. Uses documented parameters for attendance session id, query, and attendance entry status. A successful request returns 200 (Check-in roster found). Documented client-error statuses are 401, 403, 404, and 422.

Authorizations:
bearerAuthoauth2
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.

header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

Responses

Response samples

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

Add a newly eligible attendee to an open check-in

Adds an eligible attendee to an open check-in session without duplicating an existing roster entry. Requires a bearer manager API token or OAuth access token authorized for the target organizer resource. Uses the documented attendance session parent id parameter. Accepts an application/json request body. A successful request returns 200 (Attendee added or already present). Documented client-error statuses are 401, 403, 404, and 422.

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

Prefixed attendance session id.

header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

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

Sets or corrects the attendance state for one roster entry. Requires a bearer manager API token or OAuth access token authorized for the target organizer resource. Uses documented parameters for attendance session parent id and attendance entry id. Accepts an application/json request body. A successful request returns 200 (Attendance entry updated). Documented client-error statuses are 401, 403, 404, and 422.

Authorizations:
bearerAuthoauth2
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.

header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

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

Completes an open check-in session and marks untouched roster entries as did not attend. Requires a bearer manager API token or OAuth access token authorized for the target organizer resource. Uses the documented attendance session parent id parameter. A successful request returns 200 (Check-in completed or already complete). Documented client-error statuses are 401, 403, 404, and 422.

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

Prefixed attendance session id.

header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

Responses

Response samples

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

Get a filtered attendance report or complete CSV export

Returns a filtered attendance report as JSON or a complete CSV export in the requested format. Requires a bearer manager API token or OAuth access token authorized for the target organizer resource. Uses documented parameters for organizer id query, attendance from date, attendance to date, attendance source type, attendance source id, attendance entry status, attendance participant query, attendance account holder query, attendance report format, page, and per page. A successful request returns 200 (Filtered report returned in the requested format). Documented client-error statuses are 401, 403, 404, and 422.

Authorizations:
bearerAuthoauth2
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.

header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

Responses

Response samples

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

activities

Publishable activity details.

List organizer activities

Returns a collection of organizer activities available in the requested organizer context. Requires a bearer manager API token or OAuth access token authorized for the target organizer resource. Uses documented parameters for organizer id query, query, activity status, activity view, page, and per page. A successful request returns 200 (Activities found). Documented client-error statuses are 401, 403, and 422.

Authorizations:
bearerAuthoauth2
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.

header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

Responses

Response samples

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

Create an activity

Creates an activity from the supplied attributes. Requires a manager API token with api:write. Accepts an application/json request body. A successful request returns 201 (Activity created). Documented client-error statuses are 401, 403, and 422.

Authorizations:
bearerAuth
header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

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

Returns activity details by ID without changing the resource. Allows public access to published fields; a bearer token authorized for the organizer can access manager-visible data. Uses the documented id parameter. A successful request returns 200 (Activity found). Documented client-error statuses are 401, 403, 404, and 422.

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

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

header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

Responses

Response samples

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

Update an activity

Updates an activity from supplied fields; omitted fields remain unchanged. Requires a manager API token with api:write. Uses the documented id parameter. Accepts an application/json request body. A successful request returns 200 (Activity updated). Documented client-error statuses are 401, 403, 404, and 422.

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

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

header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

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

Deletes an activity after ownership and lifecycle checks pass. Requires a manager API token with api:write. Uses the documented id parameter. A successful request returns 200 (Activity deleted). Documented client-error statuses are 401, 403, 404, and 422.

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

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

header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

Responses

Response samples

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

Attach a product to an activity

Associates a product with an activity. Requires a manager API token with api:write. Uses the documented id parameter. Accepts an application/json request body. A successful request returns 200 (Product attached to activity). Documented client-error statuses are 401, 403, 404, and 422.

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

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

header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

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

Detaches a product from an activity without deleting either resource. Requires a manager API token with api:write. Uses documented parameters for id and product id. A successful request returns 200 (Product removed from activity). Documented client-error statuses are 401, 403, 404, and 422.

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)

header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

Responses

Response samples

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

List pricing options for an activity

Returns a collection of pricing options for an activity available in the requested organizer context. Allows public access to published fields; a bearer token authorized for the organizer can access manager-visible data. Uses the documented id parameter. A successful request returns 200 (Pricing options found). Documented client-error statuses are 401, 403, 404, and 422.

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

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

header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

Responses

Response samples

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

Create a pricing option for an activity

Creates a pricing option for an activity from the supplied attributes. Requires a manager API token with api:write. Uses the documented id parameter. Accepts an application/json request body. A successful request returns 201 (Pricing option created). Documented client-error statuses are 401, 403, 404, and 422.

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

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

header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

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

Returns a pricing option for an activity without changing the resource. Allows public access to published fields; a bearer token authorized for the organizer can access manager-visible data. Uses documented parameters for id and pricing option id. A successful request returns 200 (Pricing option found). Documented client-error statuses are 401, 403, 404, and 422.

Authorizations:
NonebearerAuthoauth2
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)

header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

Responses

Response samples

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

Update a pricing option for an activity

Updates a pricing option for an activity from supplied fields; omitted fields remain unchanged. Requires a manager API token with api:write. Uses documented parameters for id and pricing option id. Accepts an application/json request body. A successful request returns 200 (Pricing option updated). Documented client-error statuses are 401, 403, 404, and 422.

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)

header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

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

Deletes a pricing option for an activity after ownership and lifecycle checks pass. Requires a manager API token with api:write. Uses documented parameters for id and pricing option id. A successful request returns 200 (Pricing option deleted). Documented client-error statuses are 401, 403, 404, and 422.

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)

header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

Responses

Response samples

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

Publish an activity

Publishes an activity on its player-facing organizer surface. Requires a manager API token with api:write. Uses the documented id parameter. A successful request returns 200 (Activity published). Documented client-error statuses are 401, 403, 404, and 422.

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

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

header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

Responses

Response samples

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

Unpublish an activity

Removes an activity from public view without deleting it. Requires a manager API token with api:write. Uses the documented id parameter. A successful request returns 200 (Activity unpublished). Documented client-error statuses are 401, 403, 404, and 422.

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

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

header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

Responses

Response samples

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

Archive an activity

Archives an activity without deleting its stored record. Requires a manager API token with api:write. Uses the documented id parameter. A successful request returns 200 (Activity archived). Documented client-error statuses are 401, 403, 404, and 422.

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

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

header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

Responses

Response samples

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

Unarchive an activity

Restores an activity to the organizer's active records. Requires a manager API token with api:write. Uses the documented id parameter. A successful request returns 200 (Activity unarchived). Documented client-error statuses are 401, 403, 404, and 422.

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

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

header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

Responses

Response samples

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

products

Organizer product catalog details.

List organizer products

Returns a collection of organizer products available in the requested organizer context. Requires a bearer manager API token or OAuth access token authorized for the target organizer resource. Uses documented parameters for organizer id query, query, product status, product view, page, and per page. A successful request returns 200 (Products found). Documented client-error statuses are 401, 403, and 422.

Authorizations:
bearerAuthoauth2
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.

header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

Responses

Response samples

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

Create a product

Creates a product from the supplied attributes. Requires a manager API token with api:write. Accepts an application/json request body. A successful request returns 201 (Product created). Documented client-error statuses are 401, 403, and 422.

Authorizations:
bearerAuth
header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

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

Returns product details by ID without changing the resource. Requires a bearer manager API token or OAuth access token authorized for the target organizer resource. Uses the documented id parameter. A successful request returns 200 (Product found). Documented client-error statuses are 401, 403, 404, and 422.

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

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

header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

Responses

Response samples

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

Update a product

Updates a product from supplied fields; omitted fields remain unchanged. Requires a manager API token with api:write. Uses the documented id parameter. Accepts an application/json request body. A successful request returns 200 (Product updated). Documented client-error statuses are 401, 403, 404, and 422.

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

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

header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

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

Deletes a product after ownership and lifecycle checks pass. Requires a manager API token with api:write. Uses the documented id parameter. A successful request returns 200 (Product deleted). Documented client-error statuses are 401, 403, 404, and 422.

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

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

header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

Responses

Response samples

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

reservation_offerings

Publishable reservation booking pages.

List organizer reservation offerings

Returns a collection of organizer reservation offerings available in the requested organizer context. Requires a bearer manager API token or OAuth access token authorized for the target organizer resource. Uses documented parameters for organizer id query, query, reservation offering status, reservation offering view, page, and per page. A successful request returns 200 (Reservation offerings found). Documented client-error statuses are 401, 403, and 422.

Authorizations:
bearerAuthoauth2
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.

header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

Responses

Response samples

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

Create a reservation offering

Creates a reservation offering from the supplied attributes. Requires a manager API token with api:write. Accepts an application/json request body. A successful request returns 201 (Reservation offering created). Documented client-error statuses are 401, 403, and 422.

Authorizations:
bearerAuth
header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

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

Returns reservation offering details by ID without changing the resource. Allows public access to published fields; a bearer token authorized for the organizer can access manager-visible data. Uses the documented id parameter. A successful request returns 200 (Reservation offering found). Documented client-error statuses are 401, 403, 404, and 422.

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

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

header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

Responses

Response samples

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

Update a reservation offering

Updates a reservation offering from supplied fields; omitted fields remain unchanged. Requires a manager API token with api:write. Uses the documented id parameter. Accepts an application/json request body. A successful request returns 200 (Reservation offering updated). Documented client-error statuses are 401, 403, 404, and 422.

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

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

header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

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

Deletes a reservation offering after ownership and lifecycle checks pass. Requires a manager API token with api:write. Uses the documented id parameter. A successful request returns 200 (Reservation offering deleted). Documented client-error statuses are 401, 403, 404, and 422.

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

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

header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

Responses

Response samples

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

Attach a product to a reservation offering

Associates a product with a reservation offering. Requires a manager API token with api:write. Uses the documented id parameter. Accepts an application/json request body. A successful request returns 200 (Product attached to reservation offering). Documented client-error statuses are 401, 403, 404, and 422.

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

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

header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

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

Detaches a product from a reservation offering without deleting either resource. Requires a manager API token with api:write. Uses documented parameters for id and product id. A successful request returns 200 (Product removed from reservation offering). Documented client-error statuses are 401, 403, 404, and 422.

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)

header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

Responses

Response samples

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

List upcoming booking times for a reservation offering

Returns a collection of upcoming booking times for a reservation offering available in the requested organizer context. Requires a manager API token with api:read. Uses documented parameters for reservation offering id, page, and per page. A successful request returns 200 (Booking times found). Documented client-error statuses are 401, 403, 404, and 422.

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.

header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

Responses

Response samples

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

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

Adds an exact booking time to a specific-date reservation offering. Requires a manager API token with api:write. Uses the documented reservation offering id parameter. Accepts an application/json request body. A successful request returns 201 (Booking time created). Documented client-error statuses are 401, 403, 404, and 422.

Authorizations:
bearerAuth
path Parameters
reservation_offering_id
required
string
Example: Babc123
header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

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

Returns a booking time for a reservation offering without changing the resource. Requires a manager API token with api:read. Uses documented parameters for reservation offering id and reservation slot id. A successful request returns 200 (Booking time found). Documented client-error statuses are 401, 403, 404, and 422.

Authorizations:
bearerAuth
path Parameters
reservation_offering_id
required
string
Example: Babc123
reservation_slot_id
required
string
Example: BTabc123
header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

Responses

Response samples

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

Update an exact booking time, capacity, or visibility

Updates an exact booking time, capacity, or visibility from supplied fields; omitted fields remain unchanged. Requires a manager API token with api:write. Uses documented parameters for reservation offering id and reservation slot id. Accepts an application/json request body. A successful request returns 200 (Booking time updated). Documented client-error statuses are 401, 403, 404, and 422.

Authorizations:
bearerAuth
path Parameters
reservation_offering_id
required
string
Example: Babc123
reservation_slot_id
required
string
Example: BTabc123
header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

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

Deletes an unused exact booking time after ownership and lifecycle checks pass. Requires a manager API token with api:write. Uses documented parameters for reservation offering id and reservation slot id. A successful request returns 200 (Booking time deleted). Documented client-error statuses are 401, 403, 404, and 422.

Authorizations:
bearerAuth
path Parameters
reservation_offering_id
required
string
Example: Babc123
reservation_slot_id
required
string
Example: BTabc123
header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

Responses

Response samples

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

Cancel one booking time and process its bookings

Permanently closes one future booking time, stores the organizer's player message, and asynchronously cancels every active or pending booking. Refundable paid bookings are fully refunded with idempotency protection. Repeating the request retries only failed bookings and never reopens the time. Requires a manager API token with api:write. A successful request returns 202 with current processing counts.

Authorizations:
bearerAuth
path Parameters
reservation_offering_id
required
string
Example: Babc123
reservation_slot_id
required
string
Example: BTabc123
header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

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

Responses

Request samples

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

Response samples

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

Publish a reservation offering

Publishes a reservation offering on its player-facing organizer surface. Requires a manager API token with api:write. Uses the documented id parameter. A successful request returns 200 (Reservation offering published). Documented client-error statuses are 401, 403, 404, and 422.

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

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

header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

Responses

Response samples

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

Unpublish a reservation offering

Removes a reservation offering from public view without deleting it. Requires a manager API token with api:write. Uses the documented id parameter. A successful request returns 200 (Reservation offering unpublished). Documented client-error statuses are 401, 403, 404, and 422.

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

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

header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

Responses

Response samples

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

Archive a reservation offering

Archives a reservation offering without deleting its stored record. Requires a manager API token with api:write. Uses the documented id parameter. A successful request returns 200 (Reservation offering archived). Documented client-error statuses are 401, 403, 404, and 422.

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

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

header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

Responses

Response samples

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

Unarchive a reservation offering

Restores a reservation offering to the organizer's active records. Requires a manager API token with api:write. Uses the documented id parameter. A successful request returns 200 (Reservation offering unarchived). Documented client-error statuses are 401, 403, 404, and 422.

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

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

header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

Responses

Response samples

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

reservation_bookings

Organizer reservation booking records.

List organizer reservation bookings

Returns a collection of organizer reservation bookings available in the requested organizer context. Requires a bearer manager API token or OAuth access token authorized for the target organizer resource. Uses documented parameters for organizer id query, reservation offering id query, query, reservation booking status, reservation booking payment status, reservation booking view, page, and per page. A successful request returns 200 (Reservation bookings found). Documented client-error statuses are 401, 403, 404, and 422.

Authorizations:
bearerAuthoauth2
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.

header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

Responses

Response samples

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

Get reservation booking details by ID

Returns reservation booking details by ID without changing the resource. Requires a bearer manager API token or OAuth access token authorized for the target organizer resource. Uses the documented id parameter. A successful request returns 200 (Reservation booking found). Documented client-error statuses are 401, 403, 404, and 422.

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

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

header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

Responses

Response samples

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

storefronts

Publishable storefront details.

List organizer storefronts

Returns a collection of organizer storefronts available in the requested organizer context. Requires a bearer manager API token or OAuth access token authorized for the target organizer resource. Uses documented parameters for organizer id query, query, storefront status, storefront view, page, and per page. A successful request returns 200 (Storefronts found). Documented client-error statuses are 401, 403, and 422.

Authorizations:
bearerAuthoauth2
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.

header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

Responses

Response samples

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

Create a storefront

Creates a storefront from the supplied attributes. Requires a manager API token with api:write. Accepts an application/json request body. A successful request returns 201 (Storefront created). Documented client-error statuses are 401, 403, and 422.

Authorizations:
bearerAuth
header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

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

Returns storefront details by ID without changing the resource. Allows public access to published fields; a bearer token authorized for the organizer can access manager-visible data. Uses the documented id parameter. A successful request returns 200 (Storefront found). Documented client-error statuses are 401, 403, 404, and 422.

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

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

header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

Responses

Response samples

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

Update a storefront

Updates a storefront from supplied fields; omitted fields remain unchanged. Requires a manager API token with api:write. Uses the documented id parameter. Accepts an application/json request body. A successful request returns 200 (Storefront updated). Documented client-error statuses are 401, 403, 404, and 422.

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

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

header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

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

Deletes a storefront after ownership and lifecycle checks pass. Requires a manager API token with api:write. Uses the documented id parameter. A successful request returns 200 (Storefront deleted). Documented client-error statuses are 401, 403, 404, and 422.

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

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

header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

Responses

Response samples

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

Publish a storefront

Publishes a storefront on its player-facing organizer surface. Requires a manager API token with api:write. Uses the documented id parameter. A successful request returns 200 (Storefront published). Documented client-error statuses are 401, 403, 404, and 422.

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

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

header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

Responses

Response samples

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

Unpublish a storefront

Removes a storefront from public view without deleting it. Requires a manager API token with api:write. Uses the documented id parameter. A successful request returns 200 (Storefront unpublished). Documented client-error statuses are 401, 403, 404, and 422.

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

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

header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

Responses

Response samples

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

Archive a storefront

Archives a storefront without deleting its stored record. Requires a manager API token with api:write. Uses the documented id parameter. A successful request returns 200 (Storefront archived). Documented client-error statuses are 401, 403, 404, and 422.

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

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

header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

Responses

Response samples

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

Unarchive a storefront

Restores a storefront to the organizer's active records. Requires a manager API token with api:write. Uses the documented id parameter. A successful request returns 200 (Storefront unarchived). Documented client-error statuses are 401, 403, 404, and 422.

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

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

header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

Responses

Response samples

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

Attach a product to a storefront

Associates a product with a storefront. Requires a manager API token with api:write. Uses the documented id parameter. Accepts an application/json request body. A successful request returns 200 (Product attached to storefront). Documented client-error statuses are 401, 403, 404, and 422.

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

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

header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

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

Detaches a product from a storefront without deleting either resource. Requires a manager API token with api:write. Uses documented parameters for id and product id. A successful request returns 200 (Product removed from storefront). Documented client-error statuses are 401, 403, 404, and 422.

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)

header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

Responses

Response samples

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

storefront_orders

Organizer storefront order records.

List organizer storefront orders

Returns a collection of organizer storefront orders available in the requested organizer context. Requires a bearer manager API token or OAuth access token authorized for the target organizer resource. Uses documented parameters for organizer id query, storefront id query, query, storefront order status, storefront order payment status, storefront order view, page, and per page. A successful request returns 200 (Storefront orders found). Documented client-error statuses are 401, 403, 404, and 422.

Authorizations:
bearerAuthoauth2
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.

header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

Responses

Response samples

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

Get storefront order details by ID

Returns storefront order details by ID without changing the resource. Requires a bearer manager API token or OAuth access token authorized for the target organizer resource. Uses the documented id parameter. A successful request returns 200 (Storefront order found). Documented client-error statuses are 401, 403, 404, and 422.

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

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

header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

Responses

Response samples

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

members

Organizer member details.

List organizer members

Returns a collection of organizer members available in the requested organizer context. Requires a bearer manager API token or OAuth access token authorized for the target organizer resource. Uses documented parameters for organizer id query, query, member status, member view, page, and per page. A successful request returns 200 (Members found). Documented client-error statuses are 401, 403, and 422.

Authorizations:
bearerAuthoauth2
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.

header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

Responses

Response samples

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

Get member details by ID

Returns member details by ID without changing the resource. Requires a bearer manager API token or OAuth access token authorized for the target organizer resource. Uses the documented id parameter. A successful request returns 200 (Member found). Documented client-error statuses are 401, 403, 404, and 422.

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

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

header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

Responses

Response samples

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

registrations

Organizer registration details.

List organizer registrations

Returns a collection of organizer registrations available in the requested organizer context. Requires a bearer manager API token or OAuth access token authorized for the target organizer resource. Uses documented parameters for organizer id query, activity id query, query, registration status, registration payment status, registration view, page, and per page. A successful request returns 200 (Registrations found). Documented client-error statuses are 401, 403, 404, and 422.

Authorizations:
bearerAuthoauth2
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.

header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

Responses

Response samples

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

Get registration details by ID

Returns registration details by ID without changing the resource. Requires a bearer manager API token or OAuth access token authorized for the target organizer resource. Uses the documented id parameter. A successful request returns 200 (Registration found). Documented client-error statuses are 401, 403, 404, and 422.

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

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

header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

Responses

Response samples

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

referrals

Organizer referral records.

List organizer referrals

Returns a collection of organizer referrals available in the requested organizer context. Requires a bearer manager API token or OAuth access token authorized for the target organizer resource. Uses documented parameters for organizer id query, query, page, and per page. A successful request returns 200 (Referrals found). Documented client-error statuses are 401, 403, and 422.

Authorizations:
bearerAuthoauth2
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.

header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

Responses

Response samples

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

Get referral details by ID

Returns referral details by ID without changing the resource. Requires a bearer manager API token or OAuth access token authorized for the target organizer resource. Uses the documented id parameter. A successful request returns 200 (Referral found). Documented client-error statuses are 401, 403, 404, and 422.

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

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

header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

Responses

Response samples

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

membership_subscriptions

Organizer membership subscription records.

List organizer membership subscriptions

Returns a collection of organizer membership subscriptions available in the requested organizer context. Requires a bearer manager API token or OAuth access token authorized for the target organizer resource. Uses documented parameters for organizer id query, membership id query, query, membership subscription status, membership subscription view, page, and per page. A successful request returns 200 (Membership subscriptions found). Documented client-error statuses are 401, 403, 404, and 422.

Authorizations:
bearerAuthoauth2
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.

header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

Responses

Response samples

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

Get membership subscription details by ID

Returns membership subscription details by ID without changing the resource. Requires a bearer manager API token or OAuth access token authorized for the target organizer resource. Uses the documented id parameter. A successful request returns 200 (Membership subscription found). Documented client-error statuses are 401, 403, 404, and 422.

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

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

header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

Responses

Response samples

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

memberships

Publishable membership details.

List organizer memberships

Returns a collection of organizer memberships available in the requested organizer context. Requires a bearer manager API token or OAuth access token authorized for the target organizer resource. Uses documented parameters for organizer id query, query, membership status, membership view, page, and per page. A successful request returns 200 (Memberships found). Documented client-error statuses are 401, 403, and 422.

Authorizations:
bearerAuthoauth2
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.

header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

Responses

Response samples

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

Create a membership

Creates a membership from the supplied attributes. Requires a manager API token with api:write. Accepts an application/json request body. A successful request returns 201 (Membership created). Documented client-error statuses are 401, 403, and 422.

Authorizations:
bearerAuth
header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

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

Returns membership details by ID without changing the resource. Allows public access to published fields; a bearer token authorized for the organizer can access manager-visible data. Uses the documented id parameter. A successful request returns 200 (Membership found). Documented client-error statuses are 401, 403, 404, and 422.

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

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

header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

Responses

Response samples

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

Update a membership

Updates a membership from supplied fields; omitted fields remain unchanged. Requires a manager API token with api:write. Uses the documented id parameter. Accepts an application/json request body. A successful request returns 200 (Membership updated). Documented client-error statuses are 401, 403, 404, and 422.

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

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

header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

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

Deletes a membership after ownership and lifecycle checks pass. Requires a manager API token with api:write. Uses the documented id parameter. A successful request returns 200 (Membership deleted). Documented client-error statuses are 401, 403, 404, and 422.

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

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

header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

Responses

Response samples

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

Attach a product to a membership

Associates a product with a membership. Requires a manager API token with api:write. Uses the documented id parameter. Accepts an application/json request body. A successful request returns 200 (Product attached to membership). Documented client-error statuses are 401, 403, 404, and 422.

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

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

header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

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

Detaches a product from a membership without deleting either resource. Requires a manager API token with api:write. Uses documented parameters for id and product id. A successful request returns 200 (Product removed from membership). Documented client-error statuses are 401, 403, 404, and 422.

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)

header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

Responses

Response samples

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

Publish a membership

Publishes a membership on its player-facing organizer surface. Requires a manager API token with api:write. Uses the documented id parameter. A successful request returns 200 (Membership published). Documented client-error statuses are 401, 403, 404, and 422.

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

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

header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

Responses

Response samples

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

Unpublish a membership

Removes a membership from public view without deleting it. Requires a manager API token with api:write. Uses the documented id parameter. A successful request returns 200 (Membership unpublished). Documented client-error statuses are 401, 403, 404, and 422.

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

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

header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

Responses

Response samples

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

Archive a membership

Archives a membership without deleting its stored record. Requires a manager API token with api:write. Uses the documented id parameter. A successful request returns 200 (Membership archived). Documented client-error statuses are 401, 403, 404, and 422.

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

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

header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

Responses

Response samples

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

Unarchive a membership

Restores a membership to the organizer's active records. Requires a manager API token with api:write. Uses the documented id parameter. A successful request returns 200 (Membership unarchived). Documented client-error statuses are 401, 403, 404, and 422.

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

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

header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

Responses

Response samples

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

waivers

Publishable waiver details.

List organizer waivers

Returns a collection of organizer waivers available in the requested organizer context. Requires a bearer manager API token or OAuth access token authorized for the target organizer resource. Uses documented parameters for organizer id query, query, waiver status, waiver view, page, and per page. A successful request returns 200 (Waivers found). Documented client-error statuses are 401, 403, and 422.

Authorizations:
bearerAuthoauth2
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.

header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

Responses

Response samples

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

Create a waiver

Creates a waiver from the supplied attributes. Requires a manager API token with api:write. Accepts an application/json request body. A successful request returns 201 (Waiver created). Documented client-error statuses are 401, 403, and 422.

Authorizations:
bearerAuth
header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

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

Returns waiver details by ID without changing the resource. Allows public access to published fields; a bearer token authorized for the organizer can access manager-visible data. Uses the documented id parameter. A successful request returns 200 (Waiver found). Documented client-error statuses are 401, 403, 404, and 422.

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

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

header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

Responses

Response samples

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

Update a waiver

Updates a waiver from supplied fields; omitted fields remain unchanged. Requires a manager API token with api:write. Uses the documented id parameter. Accepts an application/json request body. A successful request returns 200 (Waiver updated). Documented client-error statuses are 401, 403, 404, and 422.

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

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

header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

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

Deletes a waiver after ownership and lifecycle checks pass. Requires a manager API token with api:write. Uses the documented id parameter. A successful request returns 200 (Waiver deleted). Documented client-error statuses are 401, 403, 404, and 422.

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

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

header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

Responses

Response samples

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

Publish a waiver

Publishes a waiver on its player-facing organizer surface. Requires a manager API token with api:write. Uses the documented id parameter. A successful request returns 200 (Waiver published). Documented client-error statuses are 401, 403, 404, and 422.

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

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

header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

Responses

Response samples

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

Unpublish a waiver

Removes a waiver from public view without deleting it. Requires a manager API token with api:write. Uses the documented id parameter. A successful request returns 200 (Waiver unpublished). Documented client-error statuses are 401, 403, 404, and 422.

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

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

header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

Responses

Response samples

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

Archive a waiver

Archives a waiver without deleting its stored record. Requires a manager API token with api:write. Uses the documented id parameter. A successful request returns 200 (Waiver archived). Documented client-error statuses are 401, 403, 404, and 422.

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

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

header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

Responses

Response samples

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

Unarchive a waiver

Restores a waiver to the organizer's active records. Requires a manager API token with api:write. Uses the documented id parameter. A successful request returns 200 (Waiver unarchived). Documented client-error statuses are 401, 403, 404, and 422.

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

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

header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

Responses

Response samples

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

signed_waivers

Organizer signed waiver records.

List organizer signed waivers

Returns a collection of organizer signed waivers available in the requested organizer context. Requires a bearer manager API token or OAuth access token authorized for the target organizer resource. Uses documented parameters for organizer id query, waiver id query, query, page, and per page. A successful request returns 200 (Signed waivers found). Documented client-error statuses are 401, 403, 404, and 422.

Authorizations:
bearerAuthoauth2
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.

header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

Responses

Response samples

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

Get signed waiver details by ID

Returns signed waiver details by ID without changing the resource. Requires a bearer manager API token or OAuth access token authorized for the target organizer resource. Uses the documented id parameter. A successful request returns 200 (Signed waiver found). Documented client-error statuses are 401, 403, 404, and 422.

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

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

header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

Responses

Response samples

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

pages

Publishable page content.

List organizer pages

Returns a collection of organizer pages available in the requested organizer context. Requires a bearer manager API token or OAuth access token authorized for the target organizer resource. Uses documented parameters for organizer id query, query, page status, page view, page, and per page. A successful request returns 200 (Pages found). Documented client-error statuses are 401, 403, and 422.

Authorizations:
bearerAuthoauth2
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.

header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

Responses

Response samples

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

Create a page

Creates a page from the supplied attributes. Requires a manager API token with api:write. Accepts an application/json request body. A successful request returns 201 (Page created). Documented client-error statuses are 401, 403, and 422.

Authorizations:
bearerAuth
header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

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

Returns page details by ID without changing the resource. Allows public access to published fields; a bearer token authorized for the organizer can access manager-visible data. Uses the documented id parameter. A successful request returns 200 (Page found). Documented client-error statuses are 401, 403, 404, and 422.

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

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

header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

Responses

Response samples

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

Update a page

Updates a page from supplied fields; omitted fields remain unchanged. Requires a manager API token with api:write. Uses the documented id parameter. Accepts an application/json request body. A successful request returns 200 (Page updated). Documented client-error statuses are 401, 403, 404, and 422.

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

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

header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

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

Deletes a page after ownership and lifecycle checks pass. Requires a manager API token with api:write. Uses the documented id parameter. A successful request returns 200 (Page deleted). Documented client-error statuses are 401, 403, 404, and 422.

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

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

header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

Responses

Response samples

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

Publish a page

Publishes a page on its player-facing organizer surface. Requires a manager API token with api:write. Uses the documented id parameter. A successful request returns 200 (Page published). Documented client-error statuses are 401, 403, 404, and 422.

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

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

header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

Responses

Response samples

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

Unpublish a page

Removes a page from public view without deleting it. Requires a manager API token with api:write. Uses the documented id parameter. A successful request returns 200 (Page unpublished). Documented client-error statuses are 401, 403, 404, and 422.

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

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

header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

Responses

Response samples

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

Archive a page

Archives a page without deleting its stored record. Requires a manager API token with api:write. Uses the documented id parameter. A successful request returns 200 (Page archived). Documented client-error statuses are 401, 403, 404, and 422.

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

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

header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

Responses

Response samples

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

Unarchive a page

Restores a page to the organizer's active records. Requires a manager API token with api:write. Uses the documented id parameter. A successful request returns 200 (Page unarchived). Documented client-error statuses are 401, 403, 404, and 422.

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

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

header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

Responses

Response samples

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

uploads

Publishable upload metadata.

List organizer uploads

Returns a collection of organizer uploads available in the requested organizer context. Requires a bearer manager API token or OAuth access token authorized for the target organizer resource. Uses documented parameters for organizer id query, query, upload status, upload view, page, and per page. A successful request returns 200 (Uploads found). Documented client-error statuses are 401, 403, and 422.

Authorizations:
bearerAuthoauth2
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.

header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

Responses

Response samples

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

Create an upload

Creates an upload from the supplied attributes. Requires a manager API token with api:write. Accepts an application/json request body. A successful request returns 201 (Upload created). Documented client-error statuses are 401, 403, and 422.

Authorizations:
bearerAuth
header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

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

Returns upload details by ID without changing the resource. Allows public access to published fields; a bearer token authorized for the organizer can access manager-visible data. Uses the documented id parameter. A successful request returns 200 (Upload found). Documented client-error statuses are 401, 403, 404, and 422.

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

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

header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

Responses

Response samples

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

Update an upload

Updates an upload from supplied fields; omitted fields remain unchanged. Requires a manager API token with api:write. Uses the documented id parameter. Accepts an application/json request body. A successful request returns 200 (Upload updated). Documented client-error statuses are 401, 403, 404, and 422.

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

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

header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

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

Deletes an upload after ownership and lifecycle checks pass. Requires a manager API token with api:write. Uses the documented id parameter. A successful request returns 200 (Upload deleted). Documented client-error statuses are 401, 403, 404, and 422.

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

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

header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

Responses

Response samples

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

Publish an upload

Publishes an upload on its player-facing organizer surface. Requires a manager API token with api:write. Uses the documented id parameter. A successful request returns 200 (Upload published). Documented client-error statuses are 401, 403, 404, and 422.

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

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

header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

Responses

Response samples

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

Unpublish an upload

Removes an upload from public view without deleting it. Requires a manager API token with api:write. Uses the documented id parameter. A successful request returns 200 (Upload unpublished). Documented client-error statuses are 401, 403, 404, and 422.

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

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

header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

Responses

Response samples

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

Archive an upload

Archives an upload without deleting its stored record. Requires a manager API token with api:write. Uses the documented id parameter. A successful request returns 200 (Upload archived). Documented client-error statuses are 401, 403, 404, and 422.

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

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

header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

Responses

Response samples

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

Unarchive an upload

Restores an upload to the organizer's active records. Requires a manager API token with api:write. Uses the documented id parameter. A successful request returns 200 (Upload unarchived). Documented client-error statuses are 401, 403, 404, and 422.

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

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

header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

Responses

Response samples

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

referral_programs

Organizer referral program details.

Create an organizer referral program

Creates an organizer referral program from the supplied attributes. Requires a manager API token with api:write. Accepts an application/json request body. A successful request returns 201 (Referral program created). Documented client-error statuses are 401, 403, and 422.

Authorizations:
bearerAuth
header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

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

Returns referral program by organizer ID without changing the resource. Allows public access to published fields; a bearer token authorized for the organizer can access manager-visible data. Uses the documented id parameter. A successful request returns 200 (Referral program found). Documented client-error statuses are 401, 403, and 404.

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

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

header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

Responses

Response samples

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

Update referral program by organizer ID

Updates referral program by organizer ID from supplied fields; omitted fields remain unchanged. Requires a manager API token with api:write. Uses the documented id parameter. Accepts an application/json request body. A successful request returns 200 (Referral program updated). Documented client-error statuses are 401, 403, 404, and 422.

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

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

header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

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

Deletes referral program by organizer ID after ownership and lifecycle checks pass. Requires a manager API token with api:write. Uses the documented id parameter. A successful request returns 200 (Referral program deleted). Documented client-error statuses are 401, 403, 404, and 422.

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

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

header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

Responses

Response samples

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

Publish an organizer referral program

Publishes an organizer referral program on its player-facing organizer surface. Requires a manager API token with api:write. Uses the documented id parameter. A successful request returns 200 (Referral program published). Documented client-error statuses are 401, 403, 404, and 422.

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

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

header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

Responses

Response samples

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

Unpublish an organizer referral program

Removes an organizer referral program from public view without deleting it. Requires a manager API token with api:write. Uses the documented id parameter. A successful request returns 200 (Referral program unpublished). Documented client-error statuses are 401, 403, 404, and 422.

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

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

header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

Responses

Response samples

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

sponsorship_programs

Organizer sponsorship program and sponsor package details.

Create an organizer sponsorship program

Creates an organizer sponsorship program from the supplied attributes. Requires a manager API token with api:write. Accepts an application/json request body. A successful request returns 201 (Sponsorship program created). Documented client-error statuses are 401, 403, and 422.

Authorizations:
bearerAuth
header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

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

Returns sponsorship program details without changing the resource. Allows public access to published fields; a bearer token authorized for the organizer can access manager-visible data. Uses the documented id parameter. A successful request returns 200 (Sponsorship program found). Documented client-error statuses are 401, 403, and 404.

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

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

header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

Responses

Response samples

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

Update a sponsorship program

Updates a sponsorship program from supplied fields; omitted fields remain unchanged. Requires a manager API token with api:write. Uses the documented id parameter. Accepts an application/json request body. A successful request returns 200 (Sponsorship program updated). Documented client-error statuses are 401, 403, 404, and 422.

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

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

header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

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

Deletes a sponsorship program after ownership and lifecycle checks pass. Requires a manager API token with api:write. Uses the documented id parameter. A successful request returns 200 (Sponsorship program deleted). Documented client-error statuses are 401, 403, 404, and 422.

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

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

header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

Responses

Response samples

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

Publish a sponsorship program

Publishes a sponsorship program on its player-facing organizer surface. Requires a manager API token with api:write. Uses the documented sponsorship program id parameter. A successful request returns 200 (Sponsorship program published). Documented client-error statuses are 401, 403, 404, and 422.

Authorizations:
bearerAuth
path Parameters
sponsorship_program_id
required
string^N[A-Za-z0-9]+$
header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

Responses

Response samples

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

Unpublish a sponsorship program

Removes a sponsorship program from public view without deleting it. Requires a manager API token with api:write. Uses the documented sponsorship program id parameter. A successful request returns 200 (Sponsorship program unpublished). Documented client-error statuses are 401, 403, 404, and 422.

Authorizations:
bearerAuth
path Parameters
sponsorship_program_id
required
string^N[A-Za-z0-9]+$
header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

Responses

Response samples

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

List sponsor packages for a sponsorship program

Returns a collection of sponsor packages for a sponsorship program available in the requested organizer context. Allows public access to published fields; a bearer token authorized for the organizer can access manager-visible data. Uses the documented sponsorship program id parameter. A successful request returns 200 (Sponsor packages found). Documented client-error statuses are 401, 403, and 404.

Authorizations:
NonebearerAuthoauth2
path Parameters
sponsorship_program_id
required
string^N[A-Za-z0-9]+$
header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

Responses

Response samples

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

Create a sponsor package

Creates a sponsor package from the supplied attributes. Requires a manager API token with api:write. Uses the documented sponsorship program id parameter. Accepts an application/json request body. A successful request returns 201 (Sponsor package created). Documented client-error statuses are 401, 403, 404, and 422.

Authorizations:
bearerAuth
path Parameters
sponsorship_program_id
required
string^N[A-Za-z0-9]+$
header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

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

Returns a sponsor package without changing the resource. Allows public access to published fields; a bearer token authorized for the organizer can access manager-visible data. Uses documented parameters for sponsorship program id and sponsor package id. A successful request returns 200 (Sponsor package found). Documented client-error statuses are 401, 403, and 404.

Authorizations:
NonebearerAuthoauth2
path Parameters
sponsorship_program_id
required
string^N[A-Za-z0-9]+$
sponsor_package_id
required
string^U[A-Za-z0-9]+$
header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

Responses

Response samples

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

Update a sponsor package

Updates a sponsor package from supplied fields; omitted fields remain unchanged. Requires a manager API token with api:write. Uses documented parameters for sponsorship program id and sponsor package id. Accepts an application/json request body. A successful request returns 200 (Sponsor package updated). Documented client-error statuses are 401, 403, 404, and 422.

Authorizations:
bearerAuth
path Parameters
sponsorship_program_id
required
string^N[A-Za-z0-9]+$
sponsor_package_id
required
string^U[A-Za-z0-9]+$
header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

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

Deletes a sponsor package after ownership and lifecycle checks pass. Requires a manager API token with api:write. Uses documented parameters for sponsorship program id and sponsor package id. A successful request returns 200 (Sponsor package deleted). Documented client-error statuses are 401, 403, 404, and 422.

Authorizations:
bearerAuth
path Parameters
sponsorship_program_id
required
string^N[A-Za-z0-9]+$
sponsor_package_id
required
string^U[A-Za-z0-9]+$
header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

Responses

Response samples

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

Preview sponsor package display settings

Returns advisory counts for current sponsorships that would change if the package's promotional placements, directory presentation, and package position were applied. Requires a manager API token with api:read.

Authorizations:
bearerAuth
path Parameters
sponsorship_program_id
required
string^N[A-Za-z0-9]+$
sponsor_package_id
required
string^U[A-Za-z0-9]+$
header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

Responses

Response samples

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

Apply sponsor package display settings

Atomically applies the package's promotional placements, directory presentation, and package position to eligible current sponsorships. Financial, term, payment, approval, sponsor content, and individual directory-order fields are unchanged. Requires explicit confirmation and a manager API token with api:write.

Authorizations:
bearerAuth
path Parameters
sponsorship_program_id
required
string^N[A-Za-z0-9]+$
sponsor_package_id
required
string^U[A-Za-z0-9]+$
header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

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

Responses

Request samples

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

Response samples

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

sponsorships

Organizer sponsorship purchase records.

List organizer sponsorships

Returns a collection of organizer sponsorships available in the requested organizer context. Requires a bearer manager API token or OAuth access token authorized for the target organizer resource. Uses documented parameters for organizer id query, sponsor package id query, query, sponsorship status, sponsorship payment status, sponsorship view, page, and per page. A successful request returns 200 (Sponsorships found). Documented client-error statuses are 401, 403, 404, and 422.

Authorizations:
bearerAuthoauth2
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.

header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

Responses

Response samples

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

Record an offline or free sponsorship

Records an offline or no-charge sponsorship for an organizer program. Requires a manager API token with api:write. Accepts an application/json request body. A successful request returns 201 (Sponsorship created). Documented client-error statuses are 401, 403, 404, and 422.

Authorizations:
bearerAuth
header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

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

Returns sponsorship details without changing the resource. Requires a bearer manager API token or OAuth access token authorized for the target organizer resource. Uses the documented id parameter. A successful request returns 200 (Sponsorship found). Documented client-error statuses are 401, 403, and 404.

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

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

header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

Responses

Response samples

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

Update sponsorship display details

Updates sponsorship display details from supplied fields; omitted fields remain unchanged. Requires a manager API token with api:write. Uses the documented id parameter. Accepts an application/json request body. A successful request returns 200 (Sponsorship updated). Documented client-error statuses are 401, 403, 404, and 422.

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

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

header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

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

Approves a sponsorship so its accepted logo and display details can appear publicly. Requires a manager API token with api:write. Uses the documented sponsorship id parameter. A successful request returns 200 (Sponsorship display approved). Documented client-error statuses are 401, 403, 404, and 422.

Authorizations:
bearerAuth
path Parameters
sponsorship_id
required
string
Example: Xabc123

Sponsorship ID.

header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

Responses

Response samples

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

Remove sponsorship display approval

Revokes public display approval without deleting the sponsorship. Requires a manager API token with api:write. Uses the documented sponsorship id parameter. A successful request returns 200 (Sponsorship display approval removed). Documented client-error statuses are 401, 403, 404, and 422.

Authorizations:
bearerAuth
path Parameters
sponsorship_id
required
string
Example: Xabc123

Sponsorship ID.

header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

Responses

Response samples

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

Cancel a sponsorship

Cancels an active sponsorship while preserving its record. Requires a manager API token with api:write. Uses the documented sponsorship id parameter. A successful request returns 200 (Sponsorship canceled). Documented client-error statuses are 401, 403, 404, and 422.

Authorizations:
bearerAuth
path Parameters
sponsorship_id
required
string
Example: Xabc123

Sponsorship ID.

header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

Responses

Response samples

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

Reinstate a canceled sponsorship

Restores a canceled sponsorship to its active lifecycle state. Requires a manager API token with api:write. Uses the documented sponsorship id parameter. A successful request returns 200 (Sponsorship reinstated). Documented client-error statuses are 401, 403, 404, and 422.

Authorizations:
bearerAuth
path Parameters
sponsorship_id
required
string
Example: Xabc123

Sponsorship ID.

header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

Responses

Response samples

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

Refund a sponsorship

Refunds the eligible sponsorship amount using the supplied refund attributes. Requires a manager API token with api:write. Uses the documented sponsorship id parameter. Accepts an application/json request body. A successful request returns 200 (Sponsorship refunded). Documented client-error statuses are 401, 403, 404, and 422.

Authorizations:
bearerAuth
path Parameters
sponsorship_id
required
string
Example: Xabc123

Sponsorship ID.

header Parameters
X-Playpass-Api-Version
string
Default: 2026-02-08
Value: "2026-02-08"
Example: 2026-02-08

Published Playpass API contract version. Omit this header to use the current version. Unsupported values return 400 unsupported_api_version rather than silently selecting current behavior.

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