hello_club_list_members
List members
List or search the club's members (people and staff) with contact details, roles, memberships (subscriptions), account credit and amount owing. Filter by free text, gender, role, staff, money owing, account credit, current subscription state, ending subscriptions or a membership type. GET /member.
Parametersrolelimitfieldsgenderoffsetsearchis_staffmembership_idupdated_sincehas_money_owingsigned_up_sincehas_account_credit+4 more
hello_club_get_member
Get member
One member by id: profile, contact details, roles, subscriptions, account credit, amount owing, custom fields. Password hashes and payment-provider data are not returned. GET /member/{id}.
Parametersmember_idrequired
hello_club_list_membership_types
List membership types
The membership types (plans) the club sells: name, fee, term, age limits, renewal rules and access. GET /membership.
Takes no parameters.
hello_club_get_membership_type
Get membership type
One membership type by id. GET /membership/{id}.
Parametersmembership_idrequired
hello_club_list_events
List events
List or search events and classes (sessions, courses, tournaments) with dates, activity, area, organiser, capacity and attendance rules. Filter by date range, recurring, hidden, public, has attendees, has spaces left, rule type, activity, area or organiser. GET /event.
Parameterslimitfieldsoffsetsearcharea_idto_datefrom_dateis_hiddenis_publicrule_typeactivity_idcategory_id+5 more
hello_club_get_event
Get event
One event by id: dates, recurrence, activity, area, organiser, capacity, attendance rules, questions. GET /event/{id}.
Parametersevent_idrequired
hello_club_list_event_attendees
List event attendees
List who is signed up to events: member or guest, event, sign-up date, paid state, whether they attended. Filter by event, member or guest. GET /eventAttendee.
Parameterslimitfieldsoffsetevent_idguest_idmember_id
hello_club_list_bookings
List bookings
List resource bookings (courts, rooms, lanes): owner, activity, area, start/end, paid state, recurrence. Filter by date range, member, activity, mode, area, recurring, paid or removed. GET /booking.
Parameterslimitfieldsoffsetsearcharea_idis_paidmode_idto_datefrom_datemember_idis_removedactivity_id+1 more
hello_club_list_transactions
List transactions
List the club's financial transactions (invoices, charges, credits): member, type, amount, tax, due and payment dates, paid state. Filter by member, type, paid, credit or a date range on date / dueDate / paymentDate. GET /transaction.
Parameterstypelimitfieldsoffsetis_paidto_datefrom_dateis_creditmember_iddate_field
hello_club_get_transaction
Get transaction
One transaction by id: member, type, amount, tax, details, dates, paid state. GET /transaction/{id}.
Parameterstransaction_idrequired
hello_club_list_check_ins
List check-ins
List check-in logs (members arriving at the club): who, when, how (type). Filter by member or type, or only unknown people. GET /checkInLog.
Parameterstypelimitfieldsoffsetsearchmember_idis_unknown
hello_club_list_access_logs
List door access logs
List door / access-control logs in a date range: member, door, event, whether it was an override or an unknown person. GET /accessLog.
Parametersdoorlimitfieldsoffsetto_daterequiredevent_idfrom_daterequiredmember_idis_unknownis_override
hello_club_create_member
Create member
WRITE: create a new member in the club (first and last name required; email, mobile, phone and gender optional). Creates a real member record in the club's database; it does not assign a membership or send an invoice. Not idempotent: calling twice creates two members, so search with hello_club_list_members first. POST /member.
Parametersemailphonegendermobilelast_namerequiredfirst_namerequired
hello_club_create_transaction
Create transaction
WRITE: create a financial transaction for a member (a charge, or a credit when is_credit is true), e.g. an invoice line or a manual adjustment. This changes the member's amount owing / account credit in the club's books and, with notify_by_email, emails the member. Not idempotent: calling twice creates two transactions. Confirm member, amount and type with the user first. POST /transaction.
Parametersdatetyperequiredamountrequireddetailsrequireddue_dateis_creditmember_idrequirednotify_by_email
