Antavo

Antavo Clubs API

The Clubs API from Antavo — 21 operation(s) for clubs.

GitHub OpenAPI
Business capability
Loyalty & Retention Management BC-420.40

Operations 22

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /v1/clubs/{club_id}/history Show a club's action history · Retrieve club history #
Ask an LLM
“What actions have happened in a club over time?”
“Can I filter a club's history by event type or member?”
Tell an agent
Show the history of club {club_id}.
List {type} actions in club {club_id} by customer {customer_id}.
GET /v1/clubs/{club_id}/members/{customer_id} Get one club member's details · Retrieve details of a specific club member #
Ask an LLM
“What role, balance and spending limit does a specific club member have?”
“Can I check one person's status inside a club?”
Tell an agent
Get member {customer_id}'s details in club {club_id}.
Show the role and balance of customer {customer_id} within club {club_id}.
GET /v1/clubs/{club_id}/members List a club's members · List members of a specific club #
Ask an LLM
“Who belongs to a given club?”
“Can I list only club members with a certain role or status?”
Tell an agent
List the members of club {club_id}.
Show {status} members with role {role} in club {club_id}.
GET /v1/clubs/{club_id}/point-expiry List a club's expiring points by date · List expiring points by date #
Ask an LLM
“Which club points will expire within a date range?”
“Can I see when a club's points are due to lapse?”
Tell an agent
List points expiring in club {club_id} between {from} and {to}.
Find the dates club {club_id}'s points lapse from {from} through {to}.
GET /v1/clubs/{club_id} Get a club's details · Retrieve club details #
Ask an LLM
“What are the details of one particular club?”
“Can I look up a club by its ID?”
Tell an agent
Get the details of club {club_id}.
Look up club {club_id}.
GET /v1/clubs/templates List club templates · List club templates #
Ask an LLM
“Which club templates are configured?”
“Can I filter club templates by contribution or expiration type?”
Tell an agent
List all club templates.
Show club templates with status {status} and contribution type {contribution_type}.
GET /v1/clubs List clubs · List clubs #
Ask an LLM
“Which clubs exist in my loyalty program?”
“Can I find clubs created from a specific template?”
Tell an agent
List all clubs.
Find clubs named {name} built on template {template_id}.
POST /v1/clubs Create a club · Create a new club #
Ask an LLM
“Can I create a new club for members to join?”
“Who becomes the owner when a new club is created?”
Tell an agent
Create a club named {name} from template {template_id} owned by {owner_id}.
Start a new club {name} with template {template_id}.
POST /v1/clubs/{club_id}/applicants/{customer_id}/accept Accept a club applicant · Accept club membership #
Ask an LLM
“How does a club owner accept someone's request to join?”
“Is an event recorded when a club applicant is accepted?”
Tell an agent
Accept applicant {customer_id} into club {club_id}.
Approve customer {customer_id}'s membership request for club {club_id} with reason {reason}.
POST /v1/clubs/{club_id}/applicants/{customer_id}/ban Ban a club applicant · Ban an applicant from a club #
Ask an LLM
“Can I stop an applicant from ever applying to a club again?”
“What does banning a pending club applicant do?”
Tell an agent destructive · confirm first
Ban applicant {customer_id} from club {club_id}.
Block customer {customer_id}'s application to club {club_id} for good, reason {reason}.
POST /v1/clubs/{club_id}/applicants/{customer_id}/refuse Refuse a club applicant · Refuse a club applicant #
Ask an LLM
“Can I turn down a club application but let them reapply later?”
“What happens to an applicant whose club request is declined?”
Tell an agent
Refuse applicant {customer_id} for club {club_id}.
Decline customer {customer_id}'s request to join club {club_id}, leaving them free to reapply.
POST /v1/clubs/{club_id}/disband Disband a club · Disband a club #
Ask an LLM
“Can a club owner shut down a club entirely?”
“What events are recorded when a club is disbanded?”
Tell an agent destructive · confirm first
Disband club {club_id} as actor {actor}.
Dissolve club {club_id} on behalf of {actor} with reason {reason}.
POST /v1/clubs/{club_id}/invitations Invite a member to a club · Create an invitation to a club #
Ask an LLM
“Can one club member invite another customer to join?”
“Who has to be named when sending a club invitation?”
Tell an agent
Invite customer {invitee_customer_id} to club {club_id} on behalf of {inviter_customer_id}.
Create a club {club_id} invitation from {inviter_customer_id} to {invitee_customer_id}.
POST /v1/clubs/{club_id}/members/{customer_id}/ban Ban a club member · Ban a member from a club #
Ask an LLM
“Can I remove a current club member and prevent them from rejoining?”
“What is recorded when an existing member is banned from a club?”
Tell an agent destructive · confirm first
Ban member {customer_id} from club {club_id} as {actor}.
Kick customer {customer_id} out of club {club_id} permanently, actor {actor}.
POST /v1/clubs/{club_id}/members/{customer_id}/club-update Rename a club · Update club details #
Ask an LLM
“Can a club member change the club's name?”
“Is a reason stored when a club's details are edited?”
Tell an agent
Rename club {club_id} to {name} as member {customer_id}.
Change club {club_id}'s name to {name} on behalf of {customer_id}, reason {reason}.
POST /v1/clubs/{club_id}/members/{customer_id}/ownership Transfer club ownership · Assign club ownership #
Ask an LLM
“Can I hand club ownership over to another member?”
“What happens to the previous owner when a new club owner is assigned?”
Tell an agent
Make member {customer_id} the owner of club {club_id}, actor {actor}.
Transfer ownership of club {club_id} to customer {customer_id} as {actor}.
POST /v1/clubs/{club_id}/members/{customer_id}/point-adjustment Adjust a club member's points · Adjust points for a specific club member #
Ask an LLM
“Can I correct a club member's point contribution up or down?”
“Can club point adjustments be negative?”
Tell an agent
Adjust member {customer_id}'s points in club {club_id} by {points}.
Change customer {customer_id}'s point contribution to club {club_id} by {points}, reason {reason}.
POST /v1/clubs/{club_id}/members/{customer_id}/point-donation Donate account points to a club · Donate account points to clubs #
Ask an LLM
“Can a member donate their own loyalty points to a club?”
“Do club cycle limits apply to point donations?”
Tell an agent
Donate {donated_account_points} account points from member {customer_id} to club {club_id}.
Have customer {customer_id} give {donated_account_points} points from account {account} to club {club_id}.
POST /v1/clubs/{club_id}/members/{customer_id}/remove Remove a member from a club · Remove a member from a club #
Ask an LLM
“Can I remove someone from a club but still let them rejoin later?”
“Which event is logged when a member is removed without a ban?”
Tell an agent destructive · confirm first
Remove member {customer_id} from club {club_id} as {actor}.
Take customer {customer_id} out of club {club_id} without banning them, actor {actor}.
POST /v1/clubs/{club_id}/members/{customer_id}/unban Unban a club member · Unban a banned member from a club #
Ask an LLM
“Can a banned club member be allowed back in?”
“Is lifting a club ban recorded in the member's history?”
Tell an agent
Unban customer {customer_id} from club {club_id} as {actor}.
Lift the ban on member {customer_id} in club {club_id}, reason {reason}, actor {actor}.
POST /v1/clubs/{club_id}/members/join-public Join a customer to a public club · Add a customer to a public club #
Ask an LLM
“Can a loyalty member join a public club directly without an invitation?”
“Can I record which channel a member used to join an open club?”
Tell an agent
Add customer {customer_id} to public club {club_id}.
Join customer {customer_id} to open club {club_id} via channel {channel}.
POST /v1/clubs/invitations/{invitation_id} Join a private club with an invitation · Add a customer to a private club #
Ask an LLM
“How does a member join a private club they were invited to?”
“What do I need to accept a private club invitation?”
Tell an agent
Accept invitation {invitation_id} to join the private club.
Join the private club using invitation {invitation_id} via channel {channel}.

Documentation

📖
Documentation
https://developers.antavo.com/docs/antavo-apis
📖
APIReference
https://apidocs.antavo.com/api/index.html
📖
Documentation
https://developers.antavo.com/docs/api-signing
📖
APIReference
https://developers.antavo.com/reference/about-faq-api
📖
APIReference
https://developers.antavo.com/reference/about-loyalty-read-api
📖
APIReference
https://developers.antavo.com/reference/social-share-campaigns-api

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/antavo/refs/heads/main/openapi/antavo-clubs-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/antavo:antavo-clubs-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

antavo-clubs-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  contact: {}
  title: Antavo Clubs API
  version: 1.0.0.0
servers:
- url: https://api.staging.antavo.com
  description: The Antavo staging environment
security:
- api_key: []
tags:


# --- truncated at 32 KB (160 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/antavo/refs/heads/main/openapi/antavo-clubs-api-openapi.yml