Read Hello Club members, events, bookings and transactions; add members and charges.
Call this server's tools from your browser. Nothing to install.
Requests go through mcptry because browsers can't call most MCP servers directly. Header values are sent to the server for that request only and are never stored or logged.
Tool list from our last check. Connect live to refresh it.
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.
Last name.
First name.
Email address.
Other phone number.
Gender.
Mobile phone number.
This tool isn't marked read-only, so it may change something on the server or in an account you connected.
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.
| Argument | Type | Description |
|---|---|---|
| string | Email address. | |
| phone | string | Other phone number. |
| gender | string | Gender. |
| mobile | string | Mobile phone number. |
| last_name* | string | Last name. |
| first_name* | string | First name. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"first_name",
"last_name"
],
"properties": {
"email": {
"type": "string",
"format": "email",
"pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
"maxLength": 254,
"description": "Email address."
},
"phone": {
"type": "string",
"maxLength": 40,
"minLength": 3,
"description": "Other phone number."
},
"gender": {
"enum": [
"female",
"male",
"other"
],
"type": "string",
"description": "Gender."
},
"mobile": {
"type": "string",
"maxLength": 40,
"minLength": 3,
"description": "Mobile phone number."
},
"last_name": {
"type": "string",
"maxLength": 100,
"minLength": 1,
"description": "Last name."
},
"first_name": {
"type": "string",
"maxLength": 100,
"minLength": 1,
"description": "First name."
}
}
}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.
| Argument | Type | Description |
|---|---|---|
| date | string | Transaction date (default: now). |
| type* | string | Transaction type (use 'other' for a manual charge). |
| amount* | number | Amount in the club's currency, a positive number (tax inclusive). |
| details* | string | Description shown on the invoice. |
| due_date | string | Payment due date. |
| is_credit | boolean | True = a credit to the member instead of a charge (default false). |
| member_id* | string | Member the transaction is for. |
| notify_by_email |
One event by id: dates, recurrence, activity, area, organiser, capacity, attendance rules, questions. GET /event/{id}.
| Argument | Type | Description |
|---|---|---|
| event_id* | string | Event id - find it with hello_club_list_events. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"event_id"
],
"properties": {
"event_id": {
"type": "string",
"pattern": "^[0-9a-fA-F]{24}$",
"description": "Event id - find it with hello_club_list_events."
}
}
}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}.
| Argument | Type | Description |
|---|---|---|
| member_id* | string | Hello Club member id (24 hex characters) - find it with hello_club_list_members. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"member_id"
],
"properties": {
"member_id": {
"type": "string",
"pattern": "^[0-9a-fA-F]{24}$",
"description": "Hello Club member id (24 hex characters) - find it with hello_club_list_members."
}
}
}One membership type by id. GET /membership/{id}.
| Argument | Type | Description |
|---|---|---|
| membership_id* | string | Membership type id. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"membership_id"
],
"properties": {
"membership_id": {
"type": "string",
"pattern": "^[0-9a-fA-F]{24}$",
"description": "Membership type id."
}
}
}One transaction by id: member, type, amount, tax, details, dates, paid state. GET /transaction/{id}.
| Argument | Type | Description |
|---|---|---|
| transaction_id* | string | Transaction id - find it with hello_club_list_transactions. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"transaction_id"
],
"properties": {
"transaction_id": {
"type": "string",
"pattern": "^[0-9a-fA-F]{24}$",
"description": "Transaction id - find it with hello_club_list_transactions."
}
}
}List door / access-control logs in a date range: member, door, event, whether it was an override or an unknown person. GET /accessLog.
| Argument | Type | Description |
|---|---|---|
| door | string | Only entries for this door id. |
| limit | integer | Results per page, 1-100 (default 25). |
| fields | array | Only return these fields of each item (e.g. ["id","firstName","lastName","email"]). Smaller replies are faster. |
| offset | integer | Number of results to skip (default 0). Pass the previous reply's next_offset. |
| to_date* | string | End of the range (required). |
| event_id | string | Only entries for this event. |
| from_date* | string | Start of the range (required). |
| member_id | string | Only entries of this member. |
| is_unknown | boolean |
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.
| Argument | Type | Description |
|---|---|---|
| limit | integer | Results per page, 1-100 (default 25). |
| fields | array | Only return these fields of each item (e.g. ["id","firstName","lastName","email"]). Smaller replies are faster. |
| offset | integer | Number of results to skip (default 0). Pass the previous reply's next_offset. |
| search | string | Free-text search. |
| area_id | string | Only bookings of this area. |
| is_paid | boolean | Only paid (true) or unpaid (false) bookings. |
| mode_id | string | Only bookings of this mode. |
| to_date | string | Bookings up to this date (use together with from_date). |
| from_date | string |
List check-in logs (members arriving at the club): who, when, how (type). Filter by member or type, or only unknown people. GET /checkInLog.
| Argument | Type | Description |
|---|---|---|
| type | string | Check-in type (as recorded by the club). |
| limit | integer | Results per page, 1-100 (default 25). |
| fields | array | Only return these fields of each item (e.g. ["id","firstName","lastName","email"]). Smaller replies are faster. |
| offset | integer | Number of results to skip (default 0). Pass the previous reply's next_offset. |
| search | string | Free-text search. |
| member_id | string | Only check-ins of this member. |
| is_unknown | boolean | Only check-ins of unknown people (true). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"type": {
"type": "string",
"maxLength": 60,
"minLength": 1,
"description": "Check-in type (as recorded by the club)."
},
"limit": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"description": "Results per page, 1-100 (default 25)."
},
"fields": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[A-Za-z][A-Za-z0-9_.]{0,59}$"
},
"maxItems": 40,
"minItems": 1,
"description": "Only return these fields of each item (e.g. [\"id\",\"firstName\",\"lastName\",\"email\"]). Smaller replies are faster."
},
"offset": {
"type": "integer",
"maximum": 1000000,
"minimum": 0,
"description": "Number of results to skip (default 0). Pass the previous reply's next_offset."
},
"search": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Free-text search."
},
"member_id": {
"type": "string",
"pattern": "^[0-9a-fA-F]{24}$",
"description": "Only check-ins of this member."
},
"is_unknown": {
"type": "boolean",
"description": "Only check-ins of unknown people (true)."
}
}
}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.
| Argument | Type | Description |
|---|---|---|
| limit | integer | Results per page, 1-100 (default 25). |
| fields | array | Only return these fields of each item (e.g. ["id","firstName","lastName","email"]). Smaller replies are faster. |
| offset | integer | Number of results to skip (default 0). Pass the previous reply's next_offset. |
| event_id | string | Only attendees of this event. |
| guest_id | string | Only attendances of this guest. |
| member_id | string | Only attendances of this member. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"limit": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"description": "Results per page, 1-100 (default 25)."
},
"fields": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[A-Za-z][A-Za-z0-9_.]{0,59}$"
},
"maxItems": 40,
"minItems": 1,
"description": "Only return these fields of each item (e.g. [\"id\",\"firstName\",\"lastName\",\"email\"]). Smaller replies are faster."
},
"offset": {
"type": "integer",
"maximum": 1000000,
"minimum": 0,
"description": "Number of results to skip (default 0). Pass the previous reply's next_offset."
},
"event_id": {
"type": "string",
"pattern": "^[0-9a-fA-F]{24}$",
"description": "Only attendees of this event."
},
"guest_id": {
"type": "string",
"pattern": "^[0-9a-fA-F]{24}$",
"description": "Only attendances of this guest."
},
"member_id": {
"type": "string",
"pattern": "^[0-9a-fA-F]{24}$",
"description": "Only attendances of this member."
}
}
}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.
| Argument | Type | Description |
|---|---|---|
| limit | integer | Results per page, 1-100 (default 25). |
| fields | array | Only return these fields of each item (e.g. ["id","firstName","lastName","email"]). Smaller replies are faster. |
| offset | integer | Number of results to skip (default 0). Pass the previous reply's next_offset. |
| search | string | Free-text search. |
| area_id | string | Only events in this area id. |
| to_date | string | Events up to this date (use together with from_date). |
| from_date | string | Events from this date on (use together with to_date). |
| is_hidden | boolean | Only hidden events (true) or visible ones (false). |
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.
| Argument | Type | Description |
|---|---|---|
| role | string | Filter on role. |
| limit | integer | Results per page, 1-100 (default 25). |
| fields | array | Only return these fields of each item (e.g. ["id","firstName","lastName","email"]). Smaller replies are faster. |
| gender | string | Filter on gender. |
| offset | integer | Number of results to skip (default 0). Pass the previous reply's next_offset. |
| search | string | Free-text search (name, email, member number...). |
| is_staff | boolean | Only staff members (true) or only non-staff (false). |
| membership_id | string | Membership type id (hello_club_list_membership_types), used together with one of the subscription filters. |
The membership types (plans) the club sells: name, fee, term, age limits, renewal rules and access. GET /membership.
No arguments.
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {}
}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.
| Argument | Type | Description |
|---|---|---|
| type | string | Transaction type. |
| limit | integer | Results per page, 1-100 (default 25). |
| fields | array | Only return these fields of each item (e.g. ["id","firstName","lastName","email"]). Smaller replies are faster. |
| offset | integer | Number of results to skip (default 0). Pass the previous reply's next_offset. |
| is_paid | boolean | Only paid (true) or unpaid (false) transactions. |
| to_date | string | Up to this date (use together with from_date). |
| from_date | string | From this date on (use together with to_date). |
| is_credit | boolean | Only credit (true) or charge (false) transactions. |
| boolean |
| Email the member about this transaction (default false). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"member_id",
"type",
"amount",
"details"
],
"properties": {
"date": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}(?:[T ]\\d{2}:\\d{2}(?::\\d{2}(?:\\.\\d{1,3})?)?(?:Z|[+-]\\d{2}:\\d{2})?)?$",
"description": "Transaction date (default: now)."
},
"type": {
"enum": [
"accountCredit",
"activity",
"booking",
"coupon",
"deposit",
"donation",
"event",
"interclub",
"other",
"purchase",
"resource",
"subscription"
],
"type": "string",
"description": "Transaction type (use 'other' for a manual charge)."
},
"amount": {
"type": "number",
"maximum": 1000000,
"description": "Amount in the club's currency, a positive number (tax inclusive).",
"exclusiveMinimum": 0
},
"details": {
"type": "string",
"maxLength": 500,
"minLength": 1,
"description": "Description shown on the invoice."
},
"due_date": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}(?:[T ]\\d{2}:\\d{2}(?::\\d{2}(?:\\.\\d{1,3})?)?(?:Z|[+-]\\d{2}:\\d{2})?)?$",
"description": "Payment due date."
},
"is_credit": {
"type": "boolean",
"description": "True = a credit to the member instead of a charge (default false)."
},
"member_id": {
"type": "string",
"pattern": "^[0-9a-fA-F]{24}$",
"description": "Member the transaction is for."
},
"notify_by_email": {
"type": "boolean",
"description": "Email the member about this transaction (default false)."
}
}
}| Only unknown people (true). |
| is_override | boolean | Only manual overrides (true). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"from_date",
"to_date"
],
"properties": {
"door": {
"type": "string",
"maxLength": 100,
"minLength": 1,
"description": "Only entries for this door id."
},
"limit": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"description": "Results per page, 1-100 (default 25)."
},
"fields": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[A-Za-z][A-Za-z0-9_.]{0,59}$"
},
"maxItems": 40,
"minItems": 1,
"description": "Only return these fields of each item (e.g. [\"id\",\"firstName\",\"lastName\",\"email\"]). Smaller replies are faster."
},
"offset": {
"type": "integer",
"maximum": 1000000,
"minimum": 0,
"description": "Number of results to skip (default 0). Pass the previous reply's next_offset."
},
"to_date": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}(?:[T ]\\d{2}:\\d{2}(?::\\d{2}(?:\\.\\d{1,3})?)?(?:Z|[+-]\\d{2}:\\d{2})?)?$",
"description": "End of the range (required)."
},
"event_id": {
"type": "string",
"pattern": "^[0-9a-fA-F]{24}$",
"description": "Only entries for this event."
},
"from_date": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}(?:[T ]\\d{2}:\\d{2}(?::\\d{2}(?:\\.\\d{1,3})?)?(?:Z|[+-]\\d{2}:\\d{2})?)?$",
"description": "Start of the range (required)."
},
"member_id": {
"type": "string",
"pattern": "^[0-9a-fA-F]{24}$",
"description": "Only entries of this member."
},
"is_unknown": {
"type": "boolean",
"description": "Only unknown people (true)."
},
"is_override": {
"type": "boolean",
"description": "Only manual overrides (true)."
}
}
}| Bookings from this date on (use together with to_date). |
| member_id | string | Only bookings that include this member. |
| is_removed | boolean | Only removed (true) or active (false) bookings. |
| activity_id | string | Only bookings of this activity. |
| is_recurring | boolean | Only recurring bookings (true) or one-off bookings (false). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"limit": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"description": "Results per page, 1-100 (default 25)."
},
"fields": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[A-Za-z][A-Za-z0-9_.]{0,59}$"
},
"maxItems": 40,
"minItems": 1,
"description": "Only return these fields of each item (e.g. [\"id\",\"firstName\",\"lastName\",\"email\"]). Smaller replies are faster."
},
"offset": {
"type": "integer",
"maximum": 1000000,
"minimum": 0,
"description": "Number of results to skip (default 0). Pass the previous reply's next_offset."
},
"search": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Free-text search."
},
"area_id": {
"type": "string",
"pattern": "^[0-9a-fA-F]{24}$",
"description": "Only bookings of this area."
},
"is_paid": {
"type": "boolean",
"description": "Only paid (true) or unpaid (false) bookings."
},
"mode_id": {
"type": "string",
"pattern": "^[0-9a-fA-F]{24}$",
"description": "Only bookings of this mode."
},
"to_date": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}(?:[T ]\\d{2}:\\d{2}(?::\\d{2}(?:\\.\\d{1,3})?)?(?:Z|[+-]\\d{2}:\\d{2})?)?$",
"description": "Bookings up to this date (use together with from_date)."
},
"from_date": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}(?:[T ]\\d{2}:\\d{2}(?::\\d{2}(?:\\.\\d{1,3})?)?(?:Z|[+-]\\d{2}:\\d{2})?)?$",
"description": "Bookings from this date on (use together with to_date)."
},
"member_id": {
"type": "string",
"pattern": "^[0-9a-fA-F]{24}$",
"description": "Only bookings that include this member."
},
"is_removed": {
"type": "boolean",
"description": "Only removed (true) or active (false) bookings."
},
"activity_id": {
"type": "string",
"pattern": "^[0-9a-fA-F]{24}$",
"description": "Only bookings of this activity."
},
"is_recurring": {
"type": "boolean",
"description": "Only recurring bookings (true) or one-off bookings (false)."
}
}
}| is_public |
| boolean |
| Only public events (true) or member-only ones (false). |
| rule_type | string | Only events with this attendance rule type. |
| activity_id | string | Only events of this activity id. |
| category_id | string | Only events in this category id. |
| is_recurring | boolean | Only recurring events (true) or one-off events (false). |
| organiser_id | string | Only events organised by this member id. |
| has_attendees | boolean | Only events with at least one attendee. |
| membership_id | string | Only events that can be attended with this membership type id. |
| has_spaces_left | boolean | Only events that still have places left. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"limit": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"description": "Results per page, 1-100 (default 25)."
},
"fields": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[A-Za-z][A-Za-z0-9_.]{0,59}$"
},
"maxItems": 40,
"minItems": 1,
"description": "Only return these fields of each item (e.g. [\"id\",\"firstName\",\"lastName\",\"email\"]). Smaller replies are faster."
},
"offset": {
"type": "integer",
"maximum": 1000000,
"minimum": 0,
"description": "Number of results to skip (default 0). Pass the previous reply's next_offset."
},
"search": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Free-text search."
},
"area_id": {
"type": "string",
"pattern": "^[0-9a-fA-F]{24}$",
"description": "Only events in this area id."
},
"to_date": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}(?:[T ]\\d{2}:\\d{2}(?::\\d{2}(?:\\.\\d{1,3})?)?(?:Z|[+-]\\d{2}:\\d{2})?)?$",
"description": "Events up to this date (use together with from_date)."
},
"from_date": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}(?:[T ]\\d{2}:\\d{2}(?::\\d{2}(?:\\.\\d{1,3})?)?(?:Z|[+-]\\d{2}:\\d{2})?)?$",
"description": "Events from this date on (use together with to_date)."
},
"is_hidden": {
"type": "boolean",
"description": "Only hidden events (true) or visible ones (false)."
},
"is_public": {
"type": "boolean",
"description": "Only public events (true) or member-only ones (false)."
},
"rule_type": {
"enum": [
"free",
"fee",
"coupon",
"membership"
],
"type": "string",
"description": "Only events with this attendance rule type."
},
"activity_id": {
"type": "string",
"pattern": "^[0-9a-fA-F]{24}$",
"description": "Only events of this activity id."
},
"category_id": {
"type": "string",
"pattern": "^[0-9a-fA-F]{24}$",
"description": "Only events in this category id."
},
"is_recurring": {
"type": "boolean",
"description": "Only recurring events (true) or one-off events (false)."
},
"organiser_id": {
"type": "string",
"pattern": "^[0-9a-fA-F]{24}$",
"description": "Only events organised by this member id."
},
"has_attendees": {
"type": "boolean",
"description": "Only events with at least one attendee."
},
"membership_id": {
"type": "string",
"pattern": "^[0-9a-fA-F]{24}$",
"description": "Only events that can be attended with this membership type id."
},
"has_spaces_left": {
"type": "boolean",
"description": "Only events that still have places left."
}
}
}| updated_since | string | Only members updated on or after this timestamp. |
| has_money_owing | boolean | Only members with unpaid transactions (true) or without (false). |
| signed_up_since | string | Sign-up date threshold. |
| has_account_credit | boolean | Only members with account credit (true) or without (false). |
| subscription_ended | string | Members whose subscription ended within the past hour/day/week/month/year. |
| subscription_ending | string | Members whose subscription ends within the next hour/day/week/month/year. |
| with_current_subscription | boolean | Only members with a current membership subscription. |
| without_current_subscription | boolean | Only members without a current membership subscription. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"role": {
"enum": [
"admin",
"viewer",
"eventManager",
"member"
],
"type": "string",
"description": "Filter on role."
},
"limit": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"description": "Results per page, 1-100 (default 25)."
},
"fields": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[A-Za-z][A-Za-z0-9_.]{0,59}$"
},
"maxItems": 40,
"minItems": 1,
"description": "Only return these fields of each item (e.g. [\"id\",\"firstName\",\"lastName\",\"email\"]). Smaller replies are faster."
},
"gender": {
"enum": [
"female",
"male",
"diverse",
"hidden",
"unknown"
],
"type": "string",
"description": "Filter on gender."
},
"offset": {
"type": "integer",
"maximum": 1000000,
"minimum": 0,
"description": "Number of results to skip (default 0). Pass the previous reply's next_offset."
},
"search": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Free-text search (name, email, member number...)."
},
"is_staff": {
"type": "boolean",
"description": "Only staff members (true) or only non-staff (false)."
},
"membership_id": {
"type": "string",
"pattern": "^[0-9a-fA-F]{24}$",
"description": "Membership type id (hello_club_list_membership_types), used together with one of the subscription filters."
},
"updated_since": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}(?:[T ]\\d{2}:\\d{2}(?::\\d{2}(?:\\.\\d{1,3})?)?(?:Z|[+-]\\d{2}:\\d{2})?)?$",
"description": "Only members updated on or after this timestamp."
},
"has_money_owing": {
"type": "boolean",
"description": "Only members with unpaid transactions (true) or without (false)."
},
"signed_up_since": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}(?:[T ]\\d{2}:\\d{2}(?::\\d{2}(?:\\.\\d{1,3})?)?(?:Z|[+-]\\d{2}:\\d{2})?)?$",
"description": "Sign-up date threshold."
},
"has_account_credit": {
"type": "boolean",
"description": "Only members with account credit (true) or without (false)."
},
"subscription_ended": {
"enum": [
"hour",
"day",
"week",
"month",
"year"
],
"type": "string",
"description": "Members whose subscription ended within the past hour/day/week/month/year."
},
"subscription_ending": {
"enum": [
"hour",
"day",
"week",
"month",
"year"
],
"type": "string",
"description": "Members whose subscription ends within the next hour/day/week/month/year."
},
"with_current_subscription": {
"type": "boolean",
"description": "Only members with a current membership subscription."
},
"without_current_subscription": {
"type": "boolean",
"description": "Only members without a current membership subscription."
}
}
}| member_id |
| string |
| Only transactions of this member. |
| date_field | string | Which date from_date / to_date apply to (default date). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"type": {
"enum": [
"accountCredit",
"activity",
"booking",
"coupon",
"deposit",
"donation",
"event",
"interclub",
"other",
"purchase",
"resource",
"subscription"
],
"type": "string",
"description": "Transaction type."
},
"limit": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"description": "Results per page, 1-100 (default 25)."
},
"fields": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[A-Za-z][A-Za-z0-9_.]{0,59}$"
},
"maxItems": 40,
"minItems": 1,
"description": "Only return these fields of each item (e.g. [\"id\",\"firstName\",\"lastName\",\"email\"]). Smaller replies are faster."
},
"offset": {
"type": "integer",
"maximum": 1000000,
"minimum": 0,
"description": "Number of results to skip (default 0). Pass the previous reply's next_offset."
},
"is_paid": {
"type": "boolean",
"description": "Only paid (true) or unpaid (false) transactions."
},
"to_date": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}(?:[T ]\\d{2}:\\d{2}(?::\\d{2}(?:\\.\\d{1,3})?)?(?:Z|[+-]\\d{2}:\\d{2})?)?$",
"description": "Up to this date (use together with from_date)."
},
"from_date": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}(?:[T ]\\d{2}:\\d{2}(?::\\d{2}(?:\\.\\d{1,3})?)?(?:Z|[+-]\\d{2}:\\d{2})?)?$",
"description": "From this date on (use together with to_date)."
},
"is_credit": {
"type": "boolean",
"description": "Only credit (true) or charge (false) transactions."
},
"member_id": {
"type": "string",
"pattern": "^[0-9a-fA-F]{24}$",
"description": "Only transactions of this member."
},
"date_field": {
"enum": [
"date",
"dueDate",
"paymentDate"
],
"type": "string",
"description": "Which date from_date / to_date apply to (default date)."
}
}
}