List members
hello_club_list_membersList 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.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| role | No | Filter on role. | |
| limit | No | Results per page, 1-100 (default 25). | |
| fields | No | Only return these fields of each item (e.g. ["id","firstName","lastName","email"]). Smaller replies are faster. | |
| gender | No | Filter on gender. | |
| offset | No | Number of results to skip (default 0). Pass the previous reply's next_offset. | |
| search | No | Free-text search (name, email, member number...). | |
| is_staff | No | Only staff members (true) or only non-staff (false). | |
| membership_id | No | Membership type id (hello_club_list_membership_types), used together with one of the subscription filters. | |
| updated_since | No | Only members updated on or after this timestamp. | |
| has_money_owing | No | Only members with unpaid transactions (true) or without (false). | |
| signed_up_since | No | Sign-up date threshold. | |
| has_account_credit | No | Only members with account credit (true) or without (false). | |
| subscription_ended | No | Members whose subscription ended within the past hour/day/week/month/year. | |
| subscription_ending | No | Members whose subscription ends within the next hour/day/week/month/year. | |
| with_current_subscription | No | Only members with a current membership subscription. | |
| without_current_subscription | No | Only members without a current membership subscription. |