Referencia de la API

Generada a partir del documento OpenAPI 3.1 en /api/v1/openapi.json. Las rutas de abajo son relativas a https://sportsmgnt.com/api/v1.

Versión 1.0.0 · Descargar el documento OpenAPI · Desarrolladores

REST API of the SportsMgnt demonstration platform built by WeldonPC. All data is sample data for the fictional Kestrel Basin Parks & Recreation District and resets nightly. Responses use the envelope {"data": ..., "meta": {...}}; errors use {"error": {"code", "message", "fields"}}.

catalog

Public activity catalog (no token needed)

GET `/activities`

Search activity sessions (same filters as the /activities page)

No necesita token

Parámetros: GET /activities
Nombre	Dónde	Tipo	Obligatorio	Descripción
`q`	query	string	No	Keyword (title, description or code)
`category`	query	string	No	Category slug, e.g. aquatics
`age`	query	integer	No	Participant age
`grade`	query	string	No	School grade K or 1-12
`location`	query	string	No	Location code, e.g. L-HPCC
`near_location`	query	string	No	Location code to measure distance from
`distance`	query	integer	No	Kilometres from near_location: 1, 3, 5 or 10
`day[]`	query	array of string (mon, tue, wed, thu, fri, sat, sun)	No	Days of week (mon..sun); repeat day[]
`time`	query	string	No	morning, afternoon or evening
`from`	query	string	No	Earliest start time HH:MM
`to`	query	string	No	Latest end time HH:MM
`language`	query	string	No	en, es or bilingual
`adaptive`	query	integer	No	1 = adaptive programs only
`open`	query	integer	No	1 = sessions with open seats only
`season`	query	string	No	Season code
`page`	query	integer	No	Page number
`per_page`	query	integer	No	Rows per page (max 100)

Respuestas

200 Paginated sessions
429 Too many requests; see Retry-After

Ejemplo de solicitud

curl 'https://sportsmgnt.com/api/v1/activities' \
  -H 'Accept: application/json'

GET `/activities/{code}`

One activity (program code like AQ-L2, or a session code) with its sessions

No necesita token

Parámetros: GET /activities/{code}
Nombre	Dónde	Tipo	Obligatorio	Descripción
`code`	path	string	Sí

Respuestas

200 Activity
404 Not found
429 Too many requests; see Retry-After

Ejemplo de solicitud

curl 'https://sportsmgnt.com/api/v1/activities/AQ-L2' \
  -H 'Accept: application/json'

GET `/locations`

Locations of the fictional district with grid coordinates

No necesita token

Respuestas

200 Locations
429 Too many requests; see Retry-After

Ejemplo de solicitud

curl 'https://sportsmgnt.com/api/v1/locations' \
  -H 'Accept: application/json'

core

Health and token information

GET `/health`

Service health

No necesita token

Respuestas

200 OK
429 Too many requests; see Retry-After

Ejemplo de solicitud

curl 'https://sportsmgnt.com/api/v1/health' \
  -H 'Accept: application/json'

GET `/me/token`

Describe the calling token

Requiere token

Respuestas

200 The token's user, scopes and expiry
401 Missing, invalid, revoked or expired token
429 Too many requests; see Retry-After

Ejemplo de solicitud

curl 'https://sportsmgnt.com/api/v1/me/token' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer SU_TOKEN'

facilities

Facility inventory and availability (public)

GET `/facilities`

List facilities

Public. Filters match the web catalog.

No necesita token

Parámetros: GET /facilities
Nombre	Dónde	Tipo	Obligatorio	Descripción
`type`	query	string	No	Facility type
`location`	query	integer	No	Location id
`capacity`	query	integer	No	Minimum capacity
`amenity`	query	string	No	Amenity key
`accessible`	query	string	No	Accessibility feature key
`bookable`	query	string	No	1 = bookable online only
`q`	query	string	No	Search text
`page`	query	integer	No	Page number
`per_page`	query	integer	No	Items per page (max 100)

Respuestas

200 OK
429 Too many requests; see Retry-After

Ejemplo de solicitud

curl 'https://sportsmgnt.com/api/v1/facilities' \
  -H 'Accept: application/json'

GET `/facilities/{slug}`

One facility

No necesita token

Parámetros: GET /facilities/{slug}
Nombre	Dónde	Tipo	Obligatorio	Descripción
`slug`	path	string	Sí

Respuestas

200 OK
404 Unknown facility

Ejemplo de solicitud

curl 'https://sportsmgnt.com/api/v1/facilities/riverbend-shelter-1' \
  -H 'Accept: application/json'

GET `/facilities/{slug}/availability`

Free and busy times per day

Agency-local times (meta.timezone). Busy blocks carry a state but never who booked them.

No necesita token

Parámetros: GET /facilities/{slug}/availability
Nombre	Dónde	Tipo	Obligatorio	Descripción
`slug`	path	string	Sí
`from`	query	string	No	First date (YYYY-MM-DD, default today)
`to`	query	string	No	Last date (default from + 6 days; at most 31 days)

Respuestas

200 OK
404 Unknown facility
422 Invalid date range

Ejemplo de solicitud

curl 'https://sportsmgnt.com/api/v1/facilities/riverbend-shelter-1/availability' \
  -H 'Accept: application/json'

household

The signed-in household (personal access token with household:read)

GET `/me/calendar`

Calendar items between two dates (agency time; default the next 30 days; scope household:read)

Requiere token

Parámetros: GET /me/calendar
Nombre	Dónde	Tipo	Obligatorio	Descripción
`from`	query	string (date)	No
`to`	query	string (date)	No

Respuestas

200 Calendar items
422 Invalid range
401 Missing, invalid, revoked or expired token
403 The token lacks a scope, or the user lacks a permission
429 Too many requests; see Retry-After

Ejemplo de solicitud

curl 'https://sportsmgnt.com/api/v1/me/calendar' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer SU_TOKEN'

GET `/me/cart`

The household's open cart with seat-hold expiry times (scope household:read)

Requiere token

Respuestas

200 Cart
401 Missing, invalid, revoked or expired token
403 The token lacks a scope, or the user lacks a permission
429 Too many requests; see Retry-After

Ejemplo de solicitud

curl 'https://sportsmgnt.com/api/v1/me/cart' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer SU_TOKEN'

GET `/me/enrollments`

Enrolments of the household, newest first (scope household:read)

Requiere token

Parámetros: GET /me/enrollments
Nombre	Dónde	Tipo	Obligatorio
`status`	query	string	No
`page`	query	integer	No
`per_page`	query	integer	No

Respuestas

200 Enrolments
401 Missing, invalid, revoked or expired token
403 The token lacks a scope, or the user lacks a permission
429 Too many requests; see Retry-After

Ejemplo de solicitud

curl 'https://sportsmgnt.com/api/v1/me/enrollments' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer SU_TOKEN'

GET `/me/household`

The token user's active household (scope household:read)

Requiere token

Respuestas

200 Household
401 Missing, invalid, revoked or expired token
403 The token lacks a scope, or the user lacks a permission
429 Too many requests; see Retry-After

Ejemplo de solicitud

curl 'https://sportsmgnt.com/api/v1/me/household' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer SU_TOKEN'

GET `/me/members`

Household members (scope household:read; no medical data)

Requiere token

Respuestas

200 Members
401 Missing, invalid, revoked or expired token
403 The token lacks a scope, or the user lacks a permission
429 Too many requests; see Retry-After

Ejemplo de solicitud

curl 'https://sportsmgnt.com/api/v1/me/members' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer SU_TOKEN'

reservations

Facility reservation requests (token)

GET `/reservations`

Your household's reservations

Token scope household:read.

Requiere token

Parámetros: GET /reservations
Nombre	Dónde	Tipo	Obligatorio	Descripción
`page`	query	integer	No	Page number
`per_page`	query	integer	No	Items per page (max 100)

Respuestas

200 OK
401 Missing, invalid, revoked or expired token
403 The token lacks a scope, or the user lacks a permission

Ejemplo de solicitud

curl 'https://sportsmgnt.com/api/v1/reservations' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer SU_TOKEN'

POST `/reservations`

Request a reservation

Token scope reservations:write. Creates a request only: no payment is taken and nothing is confirmed here. The same validation as the web form applies (booking windows, opening hours, capacity, slot locks). Pay, sign and upload paperwork from the reservation page.

Requiere token

Cuerpo de la solicitud

Cuerpo de la solicitud: POST /reservations
Propiedad	Tipo	Obligatorio	Descripción
`facility`	string	Sí	Facility slug
`household`	string	No	H-number; defaults to the token user's active household
`mode`	string (once, weekly, dates)	No
`date`	string (date)	No
`days`	array of integer	No	ISO weekdays for mode=weekly
`until`	string (date)	No
`dates`	array of string (date)	No
`start`	string	Sí	Agency-local time, 15-minute steps
`end`	string	Sí
`purpose`	string (private, nonprofit, school, commercial)	No
`attendees`	integer	Sí
`title`	string	No
`organisation`	string	No
`notes`	string	No
`on_conflict`	string (block, drop)	No
`agreement`	object	No	Optional: sign the rental agreement now

Respuestas

201 Request created
401 Missing, invalid, revoked or expired token
403 The token lacks a scope, or the user lacks a permission
409 A requested time is already taken (program, booking, league game or blackout)
422 Validation failed
429 Too many requests; see Retry-After

Ejemplo de solicitud

curl -X POST 'https://sportsmgnt.com/api/v1/reservations' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer SU_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{"facility":"string","household":"string","mode":"once","date":"2026-10-12","days":[1],"until":"2026-10-12","dates":["2026-10-12"],"start":"10:00","end":"13:00","purpose":"private","attendees":1,"title":"string","organisation":"string","notes":"string","on_conflict":"block","agreement":{"signer_name":"string","consent":true}}'

GET `/reservations/{id}`

One reservation

Token scope household:read.

Requiere token

Parámetros: GET /reservations/{id}
Nombre	Dónde	Tipo	Obligatorio	Descripción
`id`	path	string	Sí

Respuestas

200 OK
401 Missing, invalid, revoked or expired token
403 The token lacks a scope, or the user lacks a permission
404 Not found or not yours

Ejemplo de solicitud

curl 'https://sportsmgnt.com/api/v1/reservations/1' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer SU_TOKEN'

staff

Staff back office: rosters, attendance and reports. Requires a staff token with the matching scope; the token user's role and location scope apply, and an instructor-only user sees only the sessions they teach.

POST `/staff/attendance`

Record attendance for a meeting

Scope staff:attendance. The token user needs attendance.mark at the meeting's location (instructor-only users: their own sessions).

Requiere token

Cuerpo de la solicitud

Cuerpo de la solicitud: POST /staff/attendance
Propiedad	Tipo	Obligatorio	Descripción
`meeting_id`	integer	Sí
`records`	array of object	Sí

Respuestas

200 Saved
401 Missing, invalid, revoked or expired token
403 The token lacks a scope, or the user lacks a permission
404 No such meeting
422 Invalid records
429 Too many requests; see Retry-After

Ejemplo de solicitud

curl -X POST 'https://sportsmgnt.com/api/v1/staff/attendance' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer SU_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{"meeting_id":1,"records":[{"enrollment_id":1,"status":"present"}]}'

GET `/staff/reports/{key}`

Run a library report

Scope staff:reports. Rows are limited to the token user's location scope. Keys: enrolment, revenue_cost_center, daily_cash, transmittals, refunds_status, waitlists, facility_utilization, attendance_pct, instructor_hours, demographics, fee_assistance, inventory, donations_fund, passes, balances_aging, audit_summary.

Requiere token

Parámetros: GET /staff/reports/{key}
Nombre	Dónde	Tipo	Obligatorio
`key`	path	string	Sí
`from`	query	string (date)	No
`to`	query	string (date)	No
`location`	query	integer	No
`season`	query	integer	No

Respuestas

200 Report rows (sample data)
401 Missing, invalid, revoked or expired token
403 The token lacks a scope, or the user lacks a permission
404 Unknown report
429 Too many requests; see Retry-After

Ejemplo de solicitud

curl 'https://sportsmgnt.com/api/v1/staff/reports/key' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer SU_TOKEN'

GET `/staff/rosters/{session}`

Roster of a session

Scope staff:rosters. The token user needs rosters.view at the session's location; an instructor-only user must be assigned to the session.

Requiere token

Parámetros: GET /staff/rosters/{session}
Nombre	Dónde	Tipo	Obligatorio	Descripción
`session`	path	string	Sí	Session code (KB-F26-1012) or numeric id

Respuestas

200 Roster
401 Missing, invalid, revoked or expired token
403 The token lacks a scope, or the user lacks a permission
404 No such session
429 Too many requests; see Retry-After

Ejemplo de solicitud

curl 'https://sportsmgnt.com/api/v1/staff/rosters/KB-F26-1001' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer SU_TOKEN'

Esquemas

`Activity` object

Activity
Propiedad	Tipo	Obligatorio
`code`	string	Sí
`type`	string	Sí
`title`	string	Sí
`description`	string	Sí
`category`	string	Sí
`ages`	object	Sí
`grades`	object	No
`residents_only`	boolean	No
`language`	string	No
`adaptive`	boolean	No
`required_waivers`	array of string	No
`required_documents`	array of string	No
`accessibility_notes`	string	No
`sessions`	array of ActivitySession	Sí

`ActivitySession` object

ActivitySession
Propiedad	Tipo	Obligatorio
`code`	string	Sí
`program_code`	string	Sí
`title`	string	Sí
`type`	string (class, camp, overnight_camp, league, child_care, dropin, event)	Sí
`category`	string	No
`season`	string	No
`location`	object	Sí
`facility`	string \| null	No
`start_date`	string (date)	Sí
`end_date`	string (date)	Sí
`days`	array of string	Sí
`start_time`	string	Sí
`end_time`	string	Sí
`ages`	object	No
`language`	string	No
`adaptive`	boolean	No
`capacity`	integer	Sí
`seats_left`	integer	Sí
`waitlisted`	integer	Sí
`resident_price_cents`	integer	Sí
`registration`	object	Sí
`url`	string	No

`AttendanceRequest` object

AttendanceRequest
Propiedad	Tipo	Obligatorio	Descripción
`meeting_id`	integer	Sí
`records`	array of object	Sí

`AttendanceResult` object

AttendanceResult
Propiedad	Tipo	Obligatorio	Descripción
`data`	object	No
`meta`	Meta	No

`AvailabilityDay` object

AvailabilityDay
Propiedad	Tipo	Obligatorio
`date`	string (date)	Sí
`open`	boolean	Sí
`opens_at`	string	Sí
`closes_at`	string	Sí
`free`	array of object	Sí
`busy`	array of object	Sí

`CalendarItem` object

CalendarItem
Propiedad	Tipo	Obligatorio
`type`	string	Sí
`title`	string	Sí
`person`	string \| null	No
`person_id`	integer \| null	No
`starts_at`	string (date-time)	Sí
`ends_at`	string (date-time)	Sí
`location`	string	Sí
`facility`	string \| null	No
`notes`	string \| null	No

`Cart` object

Cart
Propiedad	Tipo	Obligatorio	Descripción
`items`	array of object	Sí
`total_cents`	integer	Sí

`Enrollment` object

Enrollment
Propiedad	Tipo	Obligatorio
`id`	integer	Sí
`session`	string	Sí
`title`	string	Sí
`person_id`	integer	Sí
`status`	string (pending_review, enrolled, waitlisted, offered, cancelled, transferred, completed)	Sí
`waitlist_position`	integer \| null	No
`enrolled_at`	string \| null (date-time)	No
`offer_expires_at`	string \| null (date-time)	No
`start_date`	string (date)	No
`end_date`	string (date)	No

`Error` object

Error
Propiedad	Tipo	Obligatorio	Descripción
`error`	object	Sí

`Facility` object

Facility
Propiedad	Tipo	Obligatorio
`slug`	string	Sí
`name`	string	Sí
`type`	string	Sí
`location`	object	Sí
`capacity`	integer	Sí
`amenities`	array of string	No
`accessible_features`	array of string	No
`bookable_online`	boolean	Sí
`approval_steps`	integer	Sí
`instant_booking`	boolean	Sí
`insurance_required`	boolean	Sí
`deposit_cents`	integer	Sí
`min_notice_days`	integer	Sí
`max_advance_days`	integer	Sí
`cutoff_days`	integer	Sí
`opens_at`	string	Sí
`closes_at`	string	Sí
`url`	string	Sí

`FacilityDetail`

`Household` object

Household
Propiedad	Tipo	Obligatorio
`public_id`	string	Sí
`name`	string	Sí
`kind`	string	No
`residency`	string (resident, nonresident)	Sí
`zip`	string \| null	No
`status`	string	No
`income_status`	string	No
`income_verified_until`	string \| null (date)	No
`role`	string \| null (primary, secondary, )	Sí
`members`	integer	Sí
`balance_cents`	integer	Sí
`credit_cents`	integer	Sí

`Location` object

Location
Propiedad	Tipo	Obligatorio
`code`	string	Sí
`name`	string	Sí
`address`	string	Sí
`phone`	string \| null	No
`x_km`	number	Sí
`y_km`	number	Sí
`point_of_sale`	boolean	No
`hours`	object	No

`Member` object

Member
Propiedad	Tipo	Obligatorio
`id`	integer	Sí
`first_name`	string	Sí
`last_name`	string	Sí
`age`	integer \| null	No
`relation`	string	Sí
`guardian_role`	string	Sí
`school_grade`	string \| null	No
`has_allergy`	boolean	No

`Meta` object

Meta
Propiedad	Tipo	Obligatorio
`total`	integer	No
`page`	integer	No
`per_page`	integer	No

`ReportResult` object

ReportResult
Propiedad	Tipo	Obligatorio	Descripción
`data`	object	No
`meta`	object	No

`Reservation` object

Reservation
Propiedad	Tipo	Obligatorio
`id`	string	Sí
`status`	string (draft, submitted, in_review, approved, awaiting_payment, confirmed, denied, cancelled)	Sí
`status_label`	string	No
`facility`	object	Sí
`household`	string	Sí
`purpose`	string (private, nonprofit, school, commercial)	Sí
`attendees`	integer	Sí
`title`	string \| null	No
`current_step`	integer	Sí
`approval_steps`	integer	Sí
`total_cents`	integer	Sí
`deposit_cents`	integer	Sí
`amount_due_cents`	integer	Sí
`insurance_status`	string (not_required, required, submitted, approved, rejected)	Sí
`checkpoints`	object	Sí
`dates`	array of object	Sí
`url`	string	Sí

`ReservationRequest` object

ReservationRequest
Propiedad	Tipo	Obligatorio	Descripción
`facility`	string	Sí	Facility slug
`household`	string	No	H-number; defaults to the token user's active household
`mode`	string (once, weekly, dates)	No
`date`	string (date)	No
`days`	array of integer	No	ISO weekdays for mode=weekly
`until`	string (date)	No
`dates`	array of string (date)	No
`start`	string	Sí	Agency-local time, 15-minute steps
`end`	string	Sí
`purpose`	string (private, nonprofit, school, commercial)	No
`attendees`	integer	Sí
`title`	string	No
`organisation`	string	No
`notes`	string	No
`on_conflict`	string (block, drop)	No
`agreement`	object	No	Optional: sign the rental agreement now

`Roster` object

Roster
Propiedad	Tipo	Obligatorio	Descripción
`data`	object	No
`meta`	Meta	No

`RosterParticipant` object

RosterParticipant
Propiedad	Tipo	Obligatorio	Descripción
`enrollment_id`	integer	Sí
`person_id`	integer	Sí
`first_name`	string	Sí
`last_name`	string	Sí
`age`	integer \| null	No
`household`	string	No
`allergy`	boolean	Sí
`allergy_note`	string \| null	No	Only for users with medical.view at the session's location; each read is audited.
`guardian_phone`	string \| null	No
`emergency_contacts`	array of object	No
`authorized_pickups`	array of string	No
`checkin_code`	string	Sí	Code on the participant's QR pass, for check-in.

Referencia de la API

catalog

GET /activities

Respuestas

GET /activities/{code}

Respuestas

GET /locations

Respuestas

core

GET /health

Respuestas

GET /me/token

Respuestas

facilities

GET /facilities

Respuestas

GET /facilities/{slug}

Respuestas

GET /facilities/{slug}/availability

Respuestas

household

GET /me/calendar

Respuestas

GET /me/cart

Respuestas

GET /me/enrollments

Respuestas

GET /me/household

Respuestas

GET /me/members

Respuestas

reservations

GET /reservations

Respuestas

POST /reservations

Cuerpo de la solicitud

Respuestas

GET /reservations/{id}

Respuestas

staff

POST /staff/attendance

Cuerpo de la solicitud

Respuestas

GET /staff/reports/{key}

Respuestas

GET /staff/rosters/{session}

Respuestas

Esquemas

Activity object

ActivitySession object

AttendanceRequest object

AttendanceResult object

AvailabilityDay object

CalendarItem object

Cart object

Enrollment object

Error object

Facility object

FacilityDetail

Household object

Location object

Member object

Meta object

ReportResult object

Reservation object

ReservationRequest object

Roster object

RosterParticipant object

GET `/activities`

GET `/activities/{code}`

GET `/locations`

GET `/health`

GET `/me/token`

GET `/facilities`

GET `/facilities/{slug}`

GET `/facilities/{slug}/availability`

GET `/me/calendar`

GET `/me/cart`

GET `/me/enrollments`

GET `/me/household`

GET `/me/members`

GET `/reservations`

POST `/reservations`

GET `/reservations/{id}`

POST `/staff/attendance`

GET `/staff/reports/{key}`

GET `/staff/rosters/{session}`

`Activity` object

`ActivitySession` object

`AttendanceRequest` object

`AttendanceResult` object

`AvailabilityDay` object

`CalendarItem` object

`Cart` object

`Enrollment` object

`Error` object

`Facility` object

`FacilityDetail`

`Household` object

`Location` object

`Member` object

`Meta` object

`ReportResult` object

`Reservation` object

`ReservationRequest` object

`Roster` object

`RosterParticipant` object