Your Playbook Technical Implementation team provisions your admin token out-of-band. You'll receive it directly — it does not expire unless manually revoked. Store it securely; treat it like a password.

Make a GET request to confirm your token is valid and the API is reachable. Replace YOUR_TOKEN with your admin Bearer token.

curl -X GET https://callplaybook.com/open-api/health/ \
  -H "Authorization: Bearer YOUR_TOKEN"

Expected response:

{
  "status": "ok",
  "league_id": 42
}

Call GET /open-api/auth/whoami/ to confirm the token type and confirm it's scoped to the right tenant.

curl -X GET https://callplaybook.com/open-api/auth/whoami/ \
  -H "Authorization: Bearer YOUR_TOKEN"

Expected response for an admin token:

{
  "user_id": null,
  "user_email": null,
  "league_id": 42,
  "expires_at": null,
  "is_test": false
}

Your token is valid, your league_id is confirmed, and you can make authenticated requests to any admin-scoped endpoint. For user-facing integrations, proceed to Tutorial 2 to mint user-scoped tokens.

Fetch the program catalog to find the program ID you want to register into. Use the type filter to narrow results.

curl -X GET "https://callplaybook.com/open-api/programs/?type=season" \
  -H "Authorization: Bearer ADMIN_TOKEN"

Note the id of the target program from the results array.

Before registering, call the fields endpoint to know what custom data is required. Replace {type} and {id} with the program type and ID from step 1.

curl -X GET https://callplaybook.com/open-api/register/season/101/fields/ \
  -H "Authorization: Bearer ADMIN_TOKEN"

Response is an array of field definitions. Store any required: true fields — you must include them in your registration payload.

Registration requires a user-scoped token. Use your admin token to mint one for the member by their user_id or email.

curl -X POST https://callplaybook.com/open-api/auth/user-tokens/ \
  -H "Authorization: Bearer ADMIN_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"user_id": 5821, "ttl_seconds": 3600}'

Store the token from the response. It expires in 1 hour.

POST to the programs registration endpoint using the user-scoped token. Include program_id, optionally participant_id, and any required custom_fields.

curl -X POST https://callplaybook.com/open-api/register/programs/ \
  -H "Authorization: Bearer USER_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "program_id": 101,
    "participant_id": 2204,
    "custom_fields": {"jersey_size": "M", "emergency_contact": "555-0100"}
  }'

The response returns immediately with a task_id and status: "pending".

Poll every 1–2 seconds using the task_id from step 4 until status is complete or failed.

curl -X GET https://callplaybook.com/open-api/tasks/abc123/ \
  -H "Authorization: Bearer USER_TOKEN"

A completed task returns:

{
  "task_id": "abc123",
  "status": "complete",
  "result": {
    "registration_id": 9901,
    "invoice_id": 4412,
    "pending_waiver_ids": [7, 8]
  }
}

Follow step 3 from Tutorial 2 to mint a token for the specific member whose schedule you want to retrieve. The user-scoped token automatically filters event results to that member's registered programs and teams.

Call GET /open-api/events/ with a date range. The user-scoped token means you get back only events the member's participants are clocked into — no filtering logic needed on your side.

curl -X GET \
  "https://callplaybook.com/open-api/events/?start_date=2026-06-01&end_date=2026-06-30" \
  -H "Authorization: Bearer USER_TOKEN"

Response is an array of event objects. Each includes type (game, practice, class_session), start_datetime, end_datetime, location, and a type_details object with event-specific fields.

To return only games, repeat the event_type parameter for each type you want.

curl -X GET \
  "https://callplaybook.com/open-api/events/?start_date=2026-06-01&end_date=2026-06-30&event_type=game&event_type=practice" \
  -H "Authorization: Bearer USER_TOKEN"

Some events have a confirmed date but no set time yet. Check the time_is_tba boolean on each event before displaying a time in your UI — display "TBA" instead of a time when it's true.

Use your admin token to pull all invoices created within a period. Use created_after and created_before as ISO 8601 datetimes.

curl -X GET \
  "https://callplaybook.com/open-api/invoices/?created_after=2026-05-01T00:00:00Z&created_before=2026-06-01T00:00:00Z&limit=100" \
  -H "Authorization: Bearer ADMIN_TOKEN"

Check count in the response. If it exceeds your limit, paginate using the next URL.

Keep following the next URL in the response until it returns null. This pattern is the same across all list endpoints.

# First page
GET /open-api/invoices/?created_after=...&limit=100
# Response includes:
"next": "https://callplaybook.com/open-api/invoices/?...&offset=100"

# Follow next until null
GET /open-api/invoices/?...&offset=100
GET /open-api/invoices/?...&offset=200

For each invoice, fetch the payment transactions to get method, amount, and fee breakdown.

curl -X GET \
  "https://callplaybook.com/open-api/payments/?created_after=2026-05-01T00:00:00Z&status=all&limit=100" \
  -H "Authorization: Bearer ADMIN_TOKEN"

Refunds and applied credits are on their own endpoints. Fetch them with the same date range and join to invoices via invoice_id.

GET /open-api/refunds/?created_after=2026-05-01T00:00:00Z&limit=100
GET /open-api/credits/?created_after=2026-05-01T00:00:00Z&limit=100

Each invoice has a user_id you can join to GET /open-api/user-profiles/ for member details. The status_display field on invoices gives a human-readable status (Paid, Not Paid, Partial, Refunded) suitable for display in your accounting tool.

Call the bookable calendar with a date range and optionally filter by location. Results respect league-configured lead time and max-days-ahead restrictions automatically.

curl -X GET \
  "https://callplaybook.com/open-api/bookable-calendar/?start_date=2026-06-10&end_date=2026-06-10&location_id=3" \
  -H "Authorization: Bearer USER_TOKEN"

Each result includes window_start, window_end, minimum_rental_minutes, price_per_hour, and an available_start_times array of valid booking start times.

Pass participant_id to filter results to only slots the participant is eligible to book based on their membership. If no participant_id is passed, all timeslots are returned regardless of eligibility.

curl -X GET \
  "https://callplaybook.com/open-api/bookable-calendar/?start_date=2026-06-10&end_date=2026-06-10&participant_id=2204" \
  -H "Authorization: Bearer USER_TOKEN"

Before submitting a real booking, validate your payload with the dry-run header. The server runs all validation but writes nothing.

curl -X POST https://callplaybook.com/open-api/register/bookable-calendar/ \
  -H "Authorization: Bearer USER_TOKEN" \
  -H "Content-Type: application/json" \
  -H "X-Open-API-Dry-Run: true" \
  -d '{
    "timeslot_id": 88,
    "participant_id": 2204,
    "start_time": "2026-06-10T10:00:00Z",
    "duration_minutes": 60
  }'

A 202 response with no errors means your payload is valid. Remove the dry-run header to submit for real.

The booking endpoint returns a task_id immediately. Poll GET /open-api/tasks/{task_id}/ until status is complete. The result will include the registration_id and invoice_id for the booking.

Using a user-scoped token, call GET /open-api/me/memberships/ to retrieve the member's current memberships. Each object includes status (active, paused, cancelled) and permission flags.

curl -X GET https://callplaybook.com/open-api/me/memberships/ \
  -H "Authorization: Bearer USER_TOKEN"

Each membership object includes can_pause and can_cancel booleans. Always check these before displaying options to the member or submitting a request — they reflect the league's configured rules for that membership plan.

{
  "id": 331,
  "status": "active",
  "credit_offer_title": "Monthly Unlimited",
  "can_pause": true,
  "can_cancel": true
}

POST to the pause endpoint with an optional resume_date. Billing is suspended from the pause date until resumption.

curl -X POST https://callplaybook.com/open-api/me/memberships/331/pause/ \
  -H "Authorization: Bearer USER_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"resume_date": "2026-08-01"}'

Response confirms the new status and resume date.

POST to the cancel endpoint. By default cancellation takes effect at the end of the current billing period. Pass "immediate": true to cancel instantly.

curl -X POST https://callplaybook.com/open-api/me/memberships/331/cancel/ \
  -H "Authorization: Bearer USER_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"reason": "Moving out of area", "immediate": false}'

Response includes status: "cancelled" and effective_date confirming when the cancellation takes effect.

If a membership was paused without a resume_date, or you want to resume early, POST to the resume endpoint.

curl -X POST https://callplaybook.com/open-api/me/memberships/331/resume/ \
  -H "Authorization: Bearer USER_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{}'