How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Antavo Clubs API

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

Antavo Clubs API is one of 29 APIs that Antavo publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Clubs. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 22 operations across 21 paths, and defines 63 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.0.

Requests are made against a single base URL, https://api.staging.antavo.com.

22 operations 21 paths 63 schemas 7 GET15 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0.0
Base URL
https://api.antavo.com
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Antavo Clubs API declares 1 security scheme for authenticating requests. An API key is passed in the query as api_key (api_key). By default, every request must be authenticated.

Paths & Operations 22

Across 21 paths, the API surfaces 22 operations — 7 GET, 15 POST. Each is listed below with its method, path, parameters, and response codes.

Clubs 22
GET
/v1/clubs/{club_id}/history
Retrieve club history
6 params → 200400404
GET
/v1/clubs/{club_id}/members/{customer_id}
Retrieve details of a specific club member
2 params → 200404
GET
/v1/clubs/{club_id}/members
List members of a specific club
6 params → 200400
GET
/v1/clubs/{club_id}/point-expiry
List expiring points by date
3 params → 200400404
GET
/v1/clubs/{club_id}
Retrieve club details
1 param → 200404
GET
/v1/clubs/templates
List club templates
13 params → 200400
GET
/v1/clubs
List clubs
7 params → 200400404
POST
/v1/clubs
Create a new club
body → 200400
POST
/v1/clubs/{club_id}/applicants/{customer_id}/accept
Accept club membership
2 params body → 200400404
POST
/v1/clubs/{club_id}/applicants/{customer_id}/ban
Ban an applicant from a club
2 params body → 200400404
POST
/v1/clubs/{club_id}/applicants/{customer_id}/refuse
Refuse a club applicant
2 params body → 200400404
POST
/v1/clubs/{club_id}/disband
Disband a club
1 param body → 200400404
POST
/v1/clubs/{club_id}/invitations
Create an invitation to a club
1 param body → 200400404
POST
/v1/clubs/{club_id}/members/{customer_id}/ban
Ban a member from a club
2 params body → 200400404
POST
/v1/clubs/{club_id}/members/{customer_id}/club-update
Update club details
2 params body → 200400404
POST
/v1/clubs/{club_id}/members/{customer_id}/ownership
Assign club ownership
2 params body → 200400404
POST
/v1/clubs/{club_id}/members/{customer_id}/point-adjustment
Adjust points for a specific club member
2 params body → 200400404
POST
/v1/clubs/{club_id}/members/{customer_id}/point-donation
Donate account points to clubs
2 params body → 200400404
POST
/v1/clubs/{club_id}/members/{customer_id}/remove
Remove a member from a club
2 params body → 200400404
POST
/v1/clubs/{club_id}/members/{customer_id}/unban
Unban a banned member from a club
2 params body → 200400404
POST
/v1/clubs/{club_id}/members/join-public
Add a customer to a public club
1 param body → 200400404
POST
/v1/clubs/invitations/{invitation_id}
Add a customer to a private club
1 param body → 200400404

Schemas 63

The contract defines 63 schemas that model the data the API accepts and returns. The most detailed are PointAlignmentResponse (3 properties), UnbanMemberResponse (3 properties), PublicJoinResponse (3 properties), DisbandSuccessResponse (3 properties). Each schema is shown below with its type and property counts.

ClubHistoryBadRequestErrorResponse
object
ClubHistoryNotFoundErrorResponse
object
2 properties
RefuseNotFoundError
object
2 properties 2 required
OwnerNotFoundResponses
object
Not Found error responses for owner assignments.
2 properties
CreateClubSuccessResponse
object
3 properties
BanMemberNotFoundResponse
object
2 properties
PointAlignmentResponse
object
3 properties
ClubDetailsSuccessResponse
object
3 properties
ListExpiryErrorResponse
object
2 properties
AccessBadRequestError
object
2 properties
InvitationNotFoundErrorResponse
object
2 properties
AcceptSuccessResponse
object
3 properties
OffsetError
object
2 properties
PrivateJoinResponse
object
3 properties
OwnerBadRequestResponses
object
Possible error responses when attempting to assign an owner.
2 properties
MemberDetailsResponse
object
3 properties
PublicJoinBadRequestResponse
object
2 properties
ListClubsEmptySuccessResponse
object
3 properties
PublicJoinNotFoundResponse
object
2 properties
UnbanMemberNotFoundResponse
object
2 properties
QueryParameterError
object
2 properties
CreateClubBadRequestResponse
object
2 properties
ListExpirySuccessResponse
object
3 properties
SuccessRefuseResponse
object
3 properties 3 required
RemoveMemberResponse
object
3 properties
RemoveMemberBadRequestResponse
object
2 properties
UnbanMemberBadRequestResponse
object
2 properties
LimitError
object
2 properties
InvitationBadRequestErrorResponse
object
2 properties
ClubMembersBadRequestResponse
object
2 properties
DisbandNotFoundResponses
object
Possible not found error responses when attempting to disband a club.
2 properties
BanMemberResponse
object
3 properties
PointAlignmentNotFoundErrorResponse
object
2 properties
ListTemplatesBadRequestResponse
object
2 properties
DisbandBadRequestResponses
object
Possible error responses when attempting to disband a club.
2 properties
OwnershipSuccessResponse
object
3 properties
BanNotFoundError
object
Not Found error responses for banning members.
2 properties
PointAlignmentBadRequestErrorResponse
object
2 properties
SuccessBanResponse
object
3 properties 3 required
ClubHistoryResponse
object
3 properties
BanMemberBadRequestResponse
object
2 properties
PublicJoinResponse
object
3 properties
ClubUpdateNotFoundResponse
object
2 properties
BanBadRequestError
object
Bad Request error responses for banning members.
2 properties
PointDonationRequest
object
3 properties 1 required
ClubDetailsNotFoundResponse
object
2 properties
ClubMembersSuccessResponse
object
3 properties
ListClubsBadRequestResponse
object
2 properties
PrivateJoinNotFoundResponse
object
2 properties
ErrorResponse
object
2 properties
ClubUpdateBadRequestResponse
object
2 properties
UnbanMemberResponse
object
3 properties
ListTemplatesSuccessResponse
object
3 properties
AccessNotFoundError
object
2 properties
PointDonationSuccessResponse
object
3 properties
RefuseBadRequestError
object
2 properties 2 required
InvitationSuccessResponse
object
3 properties
DisbandSuccessResponse
object
3 properties
ListClubsSuccessResponse
object
3 properties
ClubUpdateSuccessResponse
object
3 properties
RemoveMemberNotFoundResponse
object
2 properties
PrivateJoinBadRequestResponse
object
2 properties
MemberNotFoundResponse
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

antavo-clubs-api-openapi.yml Raw ↑

Other APIs Antavo publishes across the network.

Antavo Activities API
Antavo Async Events API
Antavo Authentication API
Antavo Cart API
Antavo Challenges API
Antavo Content consumption API
Antavo Contests API
Antavo Coupon pools API
Antavo Coupons API
Antavo Customer lists API
Antavo Customers API
Antavo Data extensions API
Where this information came from

This is an independent, third-party profile of Antavo Clubs API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.