Antavo

Antavo Rewards API

Bulk Reward Claim API endpoints

GitHub OpenAPI
Business capability
Loyalty & Retention Management BC-420.40

Operations 17

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/bulk-operation/reward/claim/{batch_id}/status/error List errors from a bulk reward claim · Query the failed reward claim attempts #
Ask an LLM
“Which customers failed to get the reward in my bulk claim batch?”
“Can I page through the errors from a mass reward claim?”
Tell an agent
Show the failed claims in bulk reward batch {batch_id}.
List errors {limit} at a time from reward claim batch {batch_id}, starting at {offset}.
GET /v1/bulk-operation/reward/claim/{batch_id}/status Check the status of a bulk reward claim · Query the status of the reward claim process #
Ask an LLM
“Is my bulk reward claim batch still processing or already done?”
“What is the overall completion status of a mass reward claim?”
Tell an agent
Check the processing status of bulk reward claim batch {batch_id}.
Tell me whether reward claim batch {batch_id} has finished.
POST /v1/bulk-operation/reward/claim/{reward_id} Claim one reward for many customers · Claim a specific reward to multiple customers #
Ask an LLM
“Can I give one reward to thousands of customers at once?”
“What is the maximum number of customers in a single bulk reward claim?”
Tell an agent
Bulk-claim reward {reward_id} for customers {customers}.
Claim reward {reward_id} for the batch {customers} and call {callback_url} when it completes.
GET /customers/{customer_id}/activities/rewards/{reward_id} Show one reward available to a customer · Retrieve a specific reward available for a customer #
Ask an LLM
“Can I see the details of a specific reward as a particular member would see it?”
“What does a single claimable reward look like for one customer?”
Tell an agent
Get reward {reward_id} as offered to customer {customer_id}.
Show claimable reward {reward_id} for member {customer_id} with fields {fields}.
GET /customers/{customer_id}/activities/rewards List rewards a customer can claim · List all available rewards for a customer #
Ask an LLM
“Which rewards can this loyalty member redeem right now?”
“Can I sort the rewards a customer is able to claim?”
Tell an agent
List the rewards customer {customer_id} can claim.
Show {limit} claimable rewards for customer {customer_id}, sorted by {sort} {order}.
GET /customers/{customer_id}/rewards List a customer's claimed rewards · List a customer's claimed rewards #
Ask an LLM
“What rewards has this member already claimed?”
“Can I page through a customer's reward redemption history?”
Tell an agent
List the rewards customer {customer_id} has already claimed.
Show customer {customer_id}'s past reward claims ordered by {sort} {order}, {limit} per page.
POST /customers/{customer_id}/activities/rewards/{reward_id}/bid Bid on an auction reward for a customer · Submit a bid for the customer on a specified bidding reward #
Ask an LLM
“Can a member place a bid on an auction-style reward?”
“How is the bid amount worked out for a bidding reward?”
Tell an agent
Place a bid for customer {customer_id} on bidding reward {reward_id}.
Bid {amount} for customer {customer_id} on auction reward {reward_id}.
POST /customers/{customer_id}/activities/rewards/{reward_id}/claim Claim a reward for a customer · Claim a reward for a specific customer #
Ask an LLM
“How do I redeem a reward on behalf of a loyalty member?”
“Can a customer claim several of the same reward in one go?”
Tell an agent
Claim reward {reward_id} for customer {customer_id}.
Redeem {count} of reward {reward_id} for member {customer_id}.
POST /customers/{customer_id}/activities/rewards/{reward_id}/revoke Revoke a customer's reward claim · Revoke a previously claimed reward #
Ask an LLM
“Can I undo a reward a customer already claimed?”
“Is there a way to take back a reward that was claimed by mistake?”
Tell an agent destructive · confirm first
Revoke customer {customer_id}'s claim on reward {reward_id}.
Cancel reward {reward_id} claimed by member {customer_id}, referencing claim event {event}.
DELETE /entities/rewards/reward/{entity_id} Archive a deactivated reward · Archive an inactive reward #
Ask an LLM
“How do I archive a reward that is no longer active?”
“Will members still see a reward after it has been archived?”
Tell an agent destructive · confirm first
Archive inactive reward {entity_id} so members can no longer see it.
Remove deactivated loyalty reward {entity_id} from the catalog by archiving it.
POST /entities/rewards/reward/{entity_id} Update attributes of a reward · Update specific reward attributes #
Ask an LLM
“Can I change an attribute on a reward that already exists in Antavo?”
“Which endpoint edits an existing loyalty reward's attributes?”
Tell an agent
Update the attributes of reward {entity_id}.
Edit existing loyalty reward {entity_id} with new attribute values.
GET /entities/rewards/reward/{entity_id} Retrieve a loyalty reward's details · Returns all information regarding a specific reward #
Ask an LLM
“How do I see all the settings of one reward in my loyalty program?”
“What parameters does a single reward carry when I fetch it by ID?”
Tell an agent
Get the full details of reward {entity_id}.
Show me the configuration of loyalty reward {entity_id}.
GET /entities/rewards/reward List all rewards in the catalog · List all available rewards #
Ask an LLM
“Which rewards are configured in my loyalty program, regardless of customer?”
“Can I list only the rewards offered at certain stores?”
Tell an agent
List every reward entity in the program.
List the reward entities available at stores {stores}.
PUT /entities/rewards/reward Create a new loyalty reward · Create a new reward #
Ask an LLM
“Can I add a new reward to my loyalty program through the API?”
“What endpoint creates a reward members can claim?”
Tell an agent
Create a new reward in the loyalty program.
Add a brand-new loyalty reward to the rewards catalog.
GET /rewards/{reward_id} Look up a reward on the rewards endpoint · Retrieve reward-specific information #
Ask an LLM
“Can I fetch one reward item by its reward ID without naming a customer?”
“What reward-specific information is returned for a single reward item?”
Tell an agent
Look up reward item {reward_id}.
Fetch the reward-specific info for reward {reward_id} from the rewards endpoint.
GET /rewards List reward items by price range · List reward items #
Ask an LLM
“Can I find rewards priced between a minimum and maximum?”
“Which reward item matches a given external ID?”
Tell an agent
List reward items priced between {min_price} and {max_price}.
Find the reward item with external ID {external_id}.
POST /rewards/{reward_id}/claim Claim a reward via the deprecated endpoint · Claims a specific reward (deprecated) #
Ask an LLM
“Is the old rewards claim endpoint still supported?”
“Where does the deprecated reward claim call record which customer claimed it?”
Tell an agent
Register that customer {customer} claimed reward {reward_id} using the deprecated claim endpoint.
Use the legacy claim call to record reward {reward_id} for {customer} with external ID {external_id}.

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-rewards-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-rewards-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-rewards-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Antavo Rewards API
  version: '1.0'
  description: 'Operations tagged Rewards across 4 of this provider''s published API definitions: antavo-bulk-operations-openapi.yml, antavo-display-openapi.yml, antavo-entities-openapi.yml, antavo-rewards-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.staging.antavo.com
  description: The Antavo staging environment
tags:


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