Raw schema
{
"type": "object",
"properties": {
"search": {
"description": "Free-text search (name, email, member number...).",
"type": "string",
"minLength": 1,
"maxLength": 200
},
"gender": {
"description": "Filter on gender.",
"type": "string",
"enum": [
"female",
"male",
"diverse",
"hidden",
"unknown"
]
},
"role": {
"description": "Filter on role.",
"type": "string",
"enum": [
"admin",
"viewer",
"eventManager",
"member"
]
},
"is_staff": {
"description": "Only staff members (true) or only non-staff (false).",
"type": "boolean"
},
"has_money_owing": {
"description": "Only members with unpaid transactions (true) or without (false).",
"type": "boolean"
},
"has_account_credit": {
"description": "Only members with account credit (true) or without (false).",
"type": "boolean"
},
"with_current_subscription": {
"description": "Only members with a current membership subscription.",
"type": "boolean"
},
"without_current_subscription": {
"description": "Only members without a current membership subscription.",
"type": "boolean"
},
"subscription_ending": {
"description": "Members whose subscription ends within the next hour/day/week/month/year.",
"type": "string",
"enum": [
"hour",
"day",
"week",
"month",
"year"
]
},
"subscription_ended": {
"description": "Members whose subscription ended within the past hour/day/week/month/year.",
"type": "string",
"enum": [
"hour",
"day",
"week",
"month",
"year"
]
},
"membership_id": {
"description": "Membership type id (hello_club_list_membership_types), used together with one of the subscription filters.",
"type": "string",
"pattern": "^[0-9a-fA-F]{24}$"
},
"signed_up_since": {
"description": "Sign-up date threshold.",
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}(?:[T ]\\d{2}:\\d{2}(?::\\d{2}(?:\\.\\d{1,3})?)?(?:Z|[+-]\\d{2}:\\d{2})?)?$"
},
"updated_since": {
"description": "Only members updated on or after this timestamp.",
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}(?:[T ]\\d{2}:\\d{2}(?::\\d{2}(?:\\.\\d{1,3})?)?(?:Z|[+-]\\d{2}:\\d{2})?)?$"
},
"limit": {
"description": "Results per page, 1-100 (default 25).",
"type": "integer",
"minimum": 1,
"maximum": 100
},
"offset": {
"description": "Number of results to skip (default 0). Pass the previous reply's next_offset.",
"type": "integer",
"minimum": 0,
"maximum": 1000000
},
"fields": {
"description": "Only return these fields of each item (e.g. [\"id\",\"firstName\",\"lastName\",\"email\"]). Smaller replies are faster.",
"minItems": 1,
"maxItems": 40,
"type": "array",
"items": {
"type": "string",
"pattern": "^[A-Za-z][A-Za-z0-9_.]{0,59}$"
}
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}