# info.title
Playpass API (ChatGPT Action Manager Subset)

# info.description
Action-focused OAuth manager scheduling subset of the Playpass API contract.
Generated from docs/api/openapi.yml.

# paths./api/organizers.parameters[].description
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.

# paths./api/organizers.post.summary
Create an organizer for the authenticated user

# paths./api/organizers.post.description
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.

# paths./api/organizers.post.responses.403.description
OAuth token lacks write scope or the user cannot create an organizer

# paths./api/organizers.post.responses.429.description
An applicable request quota was exceeded

# paths./api/organizers/{organizer_id}/guest_schedule_claim.parameters[].description
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.

# paths./api/organizers/{organizer_id}/guest_schedule_claim.post.summary
Claim guest schedules into organizer ownership

# paths./api/organizers/{organizer_id}/guest_schedule_claim.post.description
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). Documented client-error statuses are 401, 403, and 404.

# paths./api/organizers/{organizer_id}/guest_schedule_claim.post.parameters[].description
Response detail profile. Defaults to `slim`.

# paths./api/organizers/{organizer_id}/guest_schedule_claim.post.responses.401.description
Missing or invalid API token or guest session token

# paths./api/organizers/{organizer_id}/guest_schedule_claim.post.responses.429.description
An applicable request quota was exceeded

# paths./api/organizers/{organizer_id}/trial.parameters[].description
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.

# paths./api/organizers/{organizer_id}/trial.post.summary
Start organizer trial for eligible organizer

# paths./api/organizers/{organizer_id}/trial.post.description
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.

# paths./api/organizers/{organizer_id}/trial.post.parameters[].description
Response detail profile. Defaults to `slim`.

# paths./api/organizers/{organizer_id}/trial.post.responses.429.description
An applicable request quota was exceeded

# paths./api/schedules.parameters[].description
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.

# paths./api/schedules.get.description
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.

# paths./api/schedules.get.parameters[].description
Schedule list view. Defaults to `current` when omitted.

# paths./api/schedules.get.parameters[].description
Sport slug filter. Applies to sport-bearing resources only.

# paths./api/schedules.get.parameters[].description
1-based page number. Blank, invalid, and values below 1 use page 1.

# paths./api/schedules.get.parameters[].description
Number of records per page. Blank, invalid, and values below 1 use the endpoint default; values above 100 are capped at 100.

# paths./api/schedules.get.responses.429.description
An applicable request quota was exceeded

# paths./api/schedules.post.description
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 successful request returns 201 (Schedule created). Documented client-error statuses are 401, 403, and 422.

# paths./api/schedules.post.responses.429.description
An applicable request quota was exceeded

# paths./api/schedules/{id}.parameters[].description
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.

# paths./api/schedules/{id}.get.description
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.

# paths./api/schedules/{id}.get.parameters[].description
ID value (for example `Ak3GtLx`, `Rk3GtLx`, `PHpmFGq`, `Of6Hk2a`)

# paths./api/schedules/{id}.get.responses.429.description
An applicable request quota was exceeded

# paths./api/schedules/{id}.patch.description
Updates a schedule 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 id parameter. Accepts an application/json request body. A successful request returns 200 (Schedule updated). Documented client-error statuses are 401, 403, 404, and 422.

# paths./api/schedules/{id}.patch.parameters[].description
ID value (for example `Ak3GtLx`, `Rk3GtLx`, `PHpmFGq`, `Of6Hk2a`)

# paths./api/schedules/{id}.patch.responses.429.description
An applicable request quota was exceeded

# paths./api/schedules/{schedule_id}/publication.parameters[].description
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.

# paths./api/schedules/{schedule_id}/publication.post.description
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.

# paths./api/schedules/{schedule_id}/publication.post.responses.429.description
An applicable request quota was exceeded

# paths./api/schedules/{schedule_id}/team_bulk_add.parameters[].description
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.

# paths./api/schedules/{schedule_id}/team_bulk_add.post.description
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 successful request returns 200 (Schedule updated with new teams). Documented client-error statuses are 401, 403, 404, and 422.

# paths./api/schedules/{schedule_id}/team_bulk_add.post.responses.429.description
An applicable request quota was exceeded

# paths./api/schedules/{id}/games.parameters[].description
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.

# paths./api/schedules/{id}/games.get.description
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.

# paths./api/schedules/{id}/games.get.parameters[].description
ID value (for example `Ak3GtLx`, `Rk3GtLx`, `PHpmFGq`, `Of6Hk2a`)

# paths./api/schedules/{id}/games.get.parameters[].description
1-based page number. Blank, invalid, and values below 1 use page 1.

# paths./api/schedules/{id}/games.get.parameters[].description
Number of records per page. Blank, invalid, and values below 1 use the endpoint default; values above 100 are capped at 100.

# paths./api/schedules/{id}/games.get.responses.429.description
An applicable request quota was exceeded

# paths./api/schedules/{id}/standings.parameters[].description
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.

# paths./api/schedules/{id}/standings.get.description
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.

# paths./api/schedules/{id}/standings.get.parameters[].description
ID value (for example `Ak3GtLx`, `Rk3GtLx`, `PHpmFGq`, `Of6Hk2a`)

# paths./api/schedules/{id}/standings.get.responses.422.description
Invalid identifier/filters or standings not supported

# paths./api/schedules/{id}/standings.get.responses.429.description
An applicable request quota was exceeded

# components.headers.RateLimitPolicy.description
Applicable request quotas and window lengths using the IETF RateLimit structured field format.

# components.headers.RateLimit.description
Remaining request quota and estimated seconds until reset using the IETF RateLimit structured field format.

# components.headers.RateLimitLimit.description
Request quota for the primary applicable policy. Transitional compatibility field.

# components.headers.RateLimitRemaining.description
Remaining requests for the primary applicable policy. Transitional compatibility field.

# components.headers.RateLimitReset.description
Estimated seconds until the primary applicable policy resets. Transitional compatibility field.

# components.headers.RetryAfter.description
Seconds to wait before retrying a rate-limited request.

# components.schemas.PaginationMeta.properties.page.description
Current 1-based page number after input normalization.

# components.schemas.PaginationMeta.properties.per_page.description
Applied page size after endpoint defaults and the maximum cap.

# components.schemas.ErrorObject.properties.help_url.description
Public documentation that can help resolve the error.

# components.schemas.ScheduleCreateInput.properties.teams.description
Number of teams or participants. Practice schedules can use 1; other formats require at least 2.

# components.schemas.LifecycleStatus.description
Canonical lifecycle status for the resource.

# components.schemas.SchedulePlayerStats.properties.tracking_enabled.description
Manager-only schedule setting indicating whether stat tracking is enabled for this supported robin sport.

# components.schemas.SchedulePlayerStats.properties.visible_to_public.description
Manager-only schedule setting indicating whether public league leaders are enabled for players.

# components.schemas.SchedulePlayerStats.properties.leaderboards_visible.description
Whether the current API caller can view player leaderboards for this schedule.

# components.schemas.ManagerState.properties.status.description
Canonical manager-only lifecycle state for the resource.

# components.schemas.Schedule.properties.end_date.description
Configured end date when present, otherwise the generated last game date.

# components.schemas.ScheduleShowData.properties.continue_url.description
Optional browser handoff URL that restores guest ownership in a web session.
Returned for guest schedule endpoints when `guest_session_token` is present.

# components.schemas.ScheduleStandingsPlayerStats.properties.visible.description
Whether the current API caller can view player leaderboards in this standings response.

# components.schemas.ScheduleSummary.properties.end_date.description
Configured end date when present, otherwise the generated last game date.

# components.schemas.ScheduleUpdateInput.properties.court_add_name.description
Adds a manual-only court or field option for individual game edits without changing the generated schedule court count.

# components.schemas.ScheduleUpdateInput.properties.teams.description
Number of teams or participants. Practice schedules can use 1; other formats require at least 2.

# components.schemas.ScheduleUpdateInput.properties.manual_end_date.description
Manager-set schedule end date used as the game generation boundary. Set null to generate from rounds and cadence without an end-date boundary.

# components.schemas.ScheduleUpdateInput.properties.daily_start_time.description
Default schedule calendar start time in HH:MM format.

# components.schemas.ScheduleUpdateInput.properties.week_days_array.description
Days of the week used by the first-class schedule calendar. 0 is Sunday and 6 is Saturday.

# components.schemas.ScheduleUpdateInput.properties.schedule_window_end_time.description
Default schedule calendar end time in HH:MM format.

# components.schemas.ScheduleUpdateInput.properties.schedule_calendar_overrides.properties.court_windows.items.properties.enabled.description
Set false to close this court on the selected weekday.

# components.schemas.ScheduleUpdateInput.properties.schedule_pauses.properties.pauses.items.properties.end_date.description
Optional last date when play should pause. Omit for a single-day pause.

# components.schemas.ScheduleUpdateInput.properties.team_home_court_assignments.description
Optional mapping from team number to preferred home court or field number.

# components.securitySchemes.bearerAuth.description
Use a manager API token created in Dashboard > Settings > API Access. Manager tokens enforce their own `api:read` and `api:write` grants.

# components.securitySchemes.oauth2.description
OAuth authorization code flow for user access tokens. PKCE with S256 is required. `api:write` includes read access; request `api:read` alone for a least-privilege read-only token. For compatibility with existing clients, omitting scope grants both supported scopes.

# components.securitySchemes.oauth2.flows.authorizationCode.scopes.api:read
Read API resources the Playpass user can access.

# components.securitySchemes.oauth2.flows.authorizationCode.scopes.api:write
Read and mutate API resources the Playpass user can manage.