courtreserve_list_members
List members
List the club's members (name, email, phone, membership type and status, start/end/next payment dates, family id). Filter by member id, family, exact email, phone or the created (at most 30 days) / created-or-updated (at most 31 days) time. Paged: pass next_page back as page. PIN codes and SSO links are not returned. Needs the Member role (Read). GET /api/v1/member/get.
输入参数pageemailfamily_idpage_sizecreated_tocreated_fromphone_numberinclude_ratingscreated_or_updated_toinclude_custom_fieldsorganization_member_idcreated_or_updated_from另有 1 个
courtreserve_get_member_reservations
Get a member's reservations
A member's upcoming (or dated) court bookings and event registrations: type, start/end, courts, event name and players. For a family member the reply covers the whole family. Give the member id or your own external id. Needs the Member role (Read). GET /api/v1/member/reservations.
输入参数limitend_datestart_dateexternal_idorganization_member_id
courtreserve_list_families
List families
List family accounts (family id, name, number, members and membership). Needs the Family role (Read). GET /api/v1/family/get.
输入参数limitfamily_id
courtreserve_list_membership_types
List membership types
The club's membership types (id, name, price, billing and status). Use the ids to filter the membership report. Needs the MembershipType role (Read). GET /api/v1/membershiptype/get.
输入参数limitmembership_type_id
courtreserve_membership_report
Membership report
The Membership report: one row per member or family membership with status, billing cadence, start/end, next payment and cancellation history. Filter by type, assignment (family or individual) and the start, end, next-payment or cancellation dates. Paged. Needs the Membership Report role (Read). GET /api/v1/membershipreport/list.
输入参数pageend_toend_fromstart_topage_sizestart_fromcanceled_tocanceled_fromassignment_typenext_payment_tonext_payment_frommembership_type_ids
courtreserve_list_courts
List courts
The club's courts: id, label, court type and order. Use the ids in court utilization and court blocks. Needs the Reservation role (Read). GET /api/v1/reservation/courts.
输入参数limit
courtreserve_list_reservation_types
List reservation types
The club's reservation types (court booking, lesson, court block and so on) with ids. Needs the Reservation role (Read). GET /api/v1/reservation/reservationtypes.
输入参数limit
courtreserve_get_court_availability
Get court availability
Court availability: each court's operating hours and the time slots already booked, for one date or a date range of at most 31 days (time zone of the club in the reply). Needs the Reservation role (Read). GET /api/v1/reservation/availability.
输入参数dateto_datefrom_datecourt_type_id
courtreserve_list_reservations
List active reservations
Active court reservations for a reservation period (the dates played) or a created/updated period, at most 31 days each: type, courts, start/end, players with contact details and what they owe/paid. Give at least one period. PIN codes are not returned. Needs the ReservationReport role (Read). GET /api/v1/reservationreport/listactive.
输入参数limitinclude_ratingsreservations_toreservations_fromcreated_or_updated_toinclude_custom_fieldscreated_or_updated_from
courtreserve_list_cancelled_reservations
List cancelled reservations
Cancelled court reservations by the date they were cancelled or by the reservation period, at most 31 days each. Give at least one period. Needs the ReservationReport role (Read). GET /api/v1/reservationreport/listcancelled.
输入参数limitcancelled_tocancelled_fromreservations_toreservations_from
courtreserve_whos_here
Who is here
Who is booked in a time window (for example today): member reservations and event registrations with the member, court and time, optionally including or only cancelled ones. The window can be at most 31 days. Needs the ReservationReport role (Read). GET /api/v1/reservationreport/whoisheretoday.
输入参数end必填limitstart必填cancelled_onlyinclude_cancelled
courtreserve_court_utilization
Court utilization
Court utilization report (booked vs available time per time slot) for a period of at most 7 days, optionally for chosen courts, court types, event types, event tags or reservation types. Needs the ReservationReport role (Read). GET /api/v1/reservationreport/courtutilization.
输入参数end_date必填court_idsstart_date必填event_tag_idscourt_type_idsevent_type_idsreservation_type_ids
courtreserve_list_event_categories
List event categories
Event categories (clinics, round robins, tournaments, open play...) with ids. Needs the EventCalendar role (Read). GET /api/v1/eventcalendar/categories.
输入参数limitis_publiccategory_id
courtreserve_list_events
List events
Events on the club calendar between two dates: name, category, start/end, courts, instructors, capacity, registered and waitlist counts, price and rating limits. SSO links are not returned. Needs the EventCalendar role (Read). GET /api/v1/eventcalendar/eventlist.
输入参数limitstatusend_datestart_datecategory_idinclude_tagsinclude_price_infoinclude_rating_restrictions
courtreserve_list_event_registrations
List event registrations
Active registrations for events, clinics and lessons with the member, event and what was paid. Give an event period or a registration period, at most 31 days each. Needs the EventRegistrationReport role (Read). GET /api/v1/eventregistrationreport/listactive.
输入参数limitevent_toevent_fromregistered_toinclude_courtsregistered_frominclude_partner_info
courtreserve_list_event_waitlist
List event waitlist
People on event waitlists. Give an event period or a registration period, at most 31 days each. Needs the EventRegistrationReport role (Read). GET /api/v1/eventregistrationreport/listwaitlist.
输入参数limitevent_toevent_fromregistered_toinclude_courtsregistered_frominclude_partner_info
courtreserve_list_cancelled_event_registrations
List cancelled event registrations
Cancelled event registrations by cancellation date or by event date, at most 31 days each. Give at least one period. Needs the EventRegistrationReport role (Read). GET /api/v1/eventregistrationreport/listcancelled.
输入参数limitevent_toevent_fromcancelled_tocancelled_from
courtreserve_list_checkins
List check-ins
Check-in report: who checked in to court bookings and events, by check-in period or reservation period (at most 31 days each). Give at least one period. Role: the key's access to attendance data. GET /api/v1/attendancereport/checkin.
输入参数limitcheckin_tocheckin_frominclude_eventsreservations_toreservations_frominclude_court_booking
courtreserve_list_transactions
List transactions
Transactions (fees, membership fees, payments, refunds...) by transaction date or reservation date: id, type, date, subtotal, tax, total, unpaid amount, payment type, category and the member's name, email and phone. Filter by type, paid/unpaid and payment type. Give at least one period. Needs the Transactions role (Read). GET /api/v1/transactions/list.
输入参数limitonly_paidonly_unpaidpayment_typesreservation_totransaction_toreservation_fromtransaction_fromtransaction_typesinclude_promo_info
courtreserve_sales_summary
Sales summary
Detailed sales summary for a payment period of at most 31 days: paid fees plus refunds by category and payment type. Needs the Transactions role (Read). GET /api/v1/transactions/salessummarydetailed.
输入参数payment_to必填payment_from必填include_promo_info
courtreserve_list_promo_codes
List promo codes
The club's promo codes: code, name, type, value, dates, limits and what they apply to. Needs the PromoCodes role (Read). GET /api/v1/promocode/get.
输入参数limitpromo_code_id
courtreserve_list_leagues
List leagues
The club's leagues, with their sessions (id and name) when include_sessions is true (default). Paged. Needs the League role (Read). GET /api/v1/league/get.
输入参数pageleague_idpage_sizeinclude_sessions
courtreserve_list_league_sessions
List league sessions
League sessions, for one league or one session, optionally with their game days and registered players. Paged. Needs the League role (Read). GET /api/v1/league/sessions.
输入参数pageleague_idpage_sizesession_idinclude_playersinclude_game_days
