•  Playbook Open API  ·  v10.02

Build on the Playbook Platform

The Playbook Open API gives developers programmatic access to registrations, scheduling, payments, user profiles, and more. Integrate sports and recreation management data directly into your own applications and workflows.

Bearer token auth
OpenAPI 3.0.3
QA environment available
REST / JSON
48
Endpoints
9
Tag groups
111
Schemas
2
Token scopes

How it works

Authentication

All endpoints require a Bearer token. Admin tokens are provisioned by your Playbook Success Coach. User-scoped tokens can be minted per session via the auth endpoint.

Two token scopes

Admin tokens have full read access across all data. User-scoped tokens are short-lived and automatically filter responses to a single end-user's records — ideal for member-facing integrations.

Async operations

Write operations (registrations, bookings) return a task ID immediately. Poll GET /open-api/tasks/{id}/ to track completion — no long-running HTTP connections needed.

Sandbox mode

Set is_test: true when minting a token, or pass X-Open-API-Dry-Run: true on any write request. Full validation runs but no data is written, charged, or notified.

Ready to get started?

Contact your Playbook Success Coach to schedule a setup call with our Technical Implementation team.

Contact your Success Coach

API Reference

All endpoints are scoped to your organization's tenant and require a valid Bearer token.
Base URL: https://callplaybook.com/open-api

Health
GET/open-api/health/API health check
Authentication
POST/open-api/auth/user-tokens/Issue user-scoped token
POST/open-api/auth/user-tokens/revoke/Revoke a token
GET/open-api/auth/whoami/Identify caller
Catalog
GET/open-api/programs/List available programs
GET/open-api/seasons/List seasons
GET/open-api/divisions/List divisions
GET/open-api/teams/List teams
GET/open-api/locations/List locations
GET/open-api/pass-types/List pass types
GET/open-api/subscription-plans/List subscription plans
GET/open-api/coupons/List coupon codes (admin only)
GET/open-api/waivers/List waivers
Schedule
GET/open-api/events/List events
GET/open-api/bookable-calendar/List bookable timeslots
Users & Participants
GET/open-api/user-profiles/List user profiles
GET/open-api/participants/List participants
Financials
GET/open-api/invoices/List invoices
GET/open-api/payments/List payment transactions
GET/open-api/refunds/List refund transactions
GET/open-api/credits/List credit transactions
Registration History
GET/open-api/registrations/All registrations (unified)
GET/open-api/season-registrations/Season registrations
GET/open-api/class-registrations/Class registrations
GET/open-api/memberships/Membership registrations
GET/open-api/pass-purchases/Pass purchases
GET/open-api/waiver-submissions/Waiver submissions
Registration (write)
GET/open-api/register/{type}/{id}/fields/Get registration fields
POST/open-api/register/programs/Register for programs
POST/open-api/register/clubs/Register for clubs — Beta
POST/open-api/register/subscriptions/Register for subscriptions — Beta
POST/open-api/register/pass-packages/Purchase pass packages — Beta
POST/open-api/register/bookable-calendar/Book rental timeslot — Beta
POST/open-api/register/waivers/Submit waivers
GET/open-api/tasks/{task_id}/Poll async task status
My Account (user-scoped)
GET/open-api/me/Read user profile
PATCH/open-api/me/Update user profile
GET/open-api/me/participants/List participants
POST/open-api/me/participants/Create participant
GET/open-api/me/memberships/List memberships
POST/open-api/me/memberships/{id}/cancel/Cancel membership
POST/open-api/me/memberships/{id}/pause/Pause membership
POST/open-api/me/memberships/{id}/resume/Resume membership
POST/open-api/me/waiver-submissions/Submit waiver
GET/open-api/me/emergency-contacts/List emergency contacts
POST/open-api/me/emergency-contacts/Create emergency contact
GET/open-api/me/invoices/{id}/pending-waivers/Pending waivers for invoice

Tutorials

Step-by-step walkthroughs for the most common integration scenarios. Contact your Playbook Success Coach to schedule a hands-on session with our Technical Implementation team.

Authenticate and make your first API call

Get your Bearer token from your Playbook Success Coach, verify your identity with whoami, and call the health endpoint to confirm everything is working end-to-end.

Beginner

Register a participant in a program

Discover available programs, fetch required registration fields, create a user-scoped token, and submit a registration — then poll the async task until completion.

Intermediate

Pull a member's schedule and event feed

Use a user-scoped token to retrieve the authenticated member's upcoming games, practices, and class sessions filtered by date range.

Beginner

Sync payment and invoice data to an external system

Use the invoices, payments, and credits endpoints to export financial records to your accounting software or data warehouse with pagination and date filters.

Intermediate

Book a rental timeslot for a member

Query the bookable calendar for available slots, check membership eligibility, and submit a booking request. Covers dry-run validation and async task polling.

Intermediate  ·  Beta

Manage membership lifecycle

Read permission flags on a membership object and call the pause, resume, and cancel endpoints based on the member's request and league-configured rules.

Intermediate

Need a custom integration walkthrough?

Our Technical Implementation team can guide you through your specific use case on a setup call.

Talk to our team

Frequently asked questions

Common questions about the Playbook Open API. For anything not covered here, contact your Playbook Success Coach.

How do I get an API token to start?
Admin tokens are provisioned out-of-band. Reach out to your Playbook Success Coach to schedule a setup call with our Technical Implementation team — they will provision your credentials and walk you through your first request.
What is the difference between admin and user-scoped tokens?
Admin tokens have full read access across your organization's data. User-scoped tokens are short-lived (default 1 hour, max 8 hours) and automatically filter all responses to the data belonging to a single end-user. They are ideal for member-facing applications. Mint them via POST /open-api/auth/user-tokens/ using your admin token.
How do I test my integration without affecting real data?
Set is_test: true when minting a token to make it a sandbox token — all write requests run full validation but produce no database changes, payments, or notifications. Alternatively, pass the X-Open-API-Dry-Run: true header on any individual write request. Both can be combined with our QA environment.
Why do write operations return a task ID instead of a result?
Registration and booking operations are processed asynchronously to handle business logic like payment processing, waiver creation, and notifications. Your request returns immediately with a task_id. Poll GET /open-api/tasks/{task_id}/ — once status is complete, the result object contains full details including any pending waiver IDs.
Which endpoints are marked Beta?
Club registration, subscription registration, pass package purchase, and rental booking are marked Beta. They support sandbox mode but have not been fully tested end-to-end in all edge cases. Contact our Technical Implementation team before using them in production.
What does "league_id" mean in API responses?
league_id is an internal identifier that corresponds to your organization's tenant in the Playbook platform. It scopes all data returned by the API to your organization. You do not need to pass it explicitly — your Bearer token determines which tenant you're accessing.
Is there pagination on list endpoints?
Yes. All list endpoints return a paginated response with count, next, and previous fields. Use the limit and offset query parameters to control page size and position. The next field contains a full URL for the next page when more results are available.

Question not answered here?

Our Technical Implementation team is available to help with any integration questions.

Contact your Success Coach

Support

Get help with your integration or escalate a technical issue. All API access is set up through your Playbook Success Coach.

Success Coach

Your Playbook Success Coach is your primary point of contact for API access setup, integration planning, and coordinating with our Technical Implementation team.

Contact your coach →

Technical Implementation

For complex integrations, our Technical Implementation team can join a setup call to review your architecture and help you reach production faster.

Schedule a setup call →

API Reference

Browse all 48 endpoints, request and response schemas, and parameter definitions in the full API Reference section of this portal.

View API reference →

Tutorials

Step-by-step guides for authentication, registration, scheduling, payment sync, and membership lifecycle management.

Browse tutorials →

When to contact us

Getting started

To request API credentials, set up your first integration, or provision a QA environment — start with your Playbook Success Coach.

Production issues

For unexpected errors, authentication failures, or data discrepancies in production, contact your Success Coach and include the endpoint path, relevant request details, and any task IDs or error messages.

Feature requests

Have a use case the current API doesn't support? Let your Success Coach know — our Technical Implementation team reviews integration feedback regularly.