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 Rewards API

Bulk Reward Claim API endpoints

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

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

This API exposes 17 operations across 14 paths, and defines 33 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

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

17 operations 14 paths 33 schemas 1 DELETE9 GET6 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

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

Authentication & Security 2

Antavo Rewards API declares 2 security schemes for authenticating requests. An API key is passed in the query as api_key (api_key). An API key is passed in the query as api_key (ApiKeyAuth).

  • api_key — Provides API Key access to the endpoint.

Paths & Operations 17

Across 14 paths, the API surfaces 17 operations — 1 DELETE, 9 GET, 6 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Rewards 17

Bulk Reward Claim API endpoints

GET
/v1/bulk-operation/reward/claim/{batch_id}/status/error
Query the failed reward claim attempts
3 params → 200404
GET
/v1/bulk-operation/reward/claim/{batch_id}/status
Query the status of the reward claim process
1 param → 200404
POST
/v1/bulk-operation/reward/claim/{reward_id}
Claim a specific reward to multiple customers
1 param body → 200400404
GET
/customers/{customer_id}/activities/rewards/{reward_id}
Retrieve a specific reward available for a customer
3 params → 200400404
GET
/customers/{customer_id}/activities/rewards
List all available rewards for a customer
6 params → 200404
GET
/customers/{customer_id}/rewards
List a customer's claimed rewards
6 params → 200404
POST
/customers/{customer_id}/activities/rewards/{reward_id}/bid
Submit a bid for the customer on a specified bidding reward
2 params body → 200400404
POST
/customers/{customer_id}/activities/rewards/{reward_id}/claim
Claim a reward for a specific customer
3 params body → 200400404
POST
/customers/{customer_id}/activities/rewards/{reward_id}/revoke
Revoke a previously claimed reward
2 params body → 200400404
DELETE
/entities/rewards/reward/{entity_id}
Archive an inactive reward
Rewarddelete 1 param → 200400
POST
/entities/rewards/reward/{entity_id}
Update specific reward attributes
Rewardupdate 1 param body → 200400
GET
/entities/rewards/reward/{entity_id}
Returns all information regarding a specific reward
Rewardget 1 param → 200400
GET
/entities/rewards/reward
List all available rewards
1 param → 200
PUT
/entities/rewards/reward
Create a new reward
Rewardcreate body → 200400
GET
/rewards/{reward_id}
Retrieve reward-specific information
1 param → 200404
GET
/rewards
List reward items
6 params → 200404
POST
/rewards/{reward_id}/claimdeprecated
Claims a specific reward (deprecated)
1 param body → 200404

Schemas 33

The contract defines 33 schemas that model the data the API accepts and returns. The most detailed are DynamicCouponRewardActivity (27 properties), GetRewardResponse (24 properties), CouponPoolRewardActivity (20 properties), BidResponse (18 properties). Each schema is shown below with its type and property counts.

StatusResponse
object
3 properties
BulkRewardClaim
object
4 properties 1 required
ResponseBadRequest
object
2 properties
RewardNotFound
object
2 properties
BatchNotFound
object
2 properties
metadata
object
2 properties
response
object
3 properties
ErrorResponse
object
3 properties
RewardClaimA
object
2 properties
Image
object
Object contains different sizes of the image asset.
3 properties
CouponClaim
object
9 properties
BidResponse
object
18 properties
CouponPoolRewardActivity
object
20 properties
DynamicCouponRewardActivity
object
27 properties
ErrorResponse_2
object
This describes the structure returned if an error occurred
1 property
Category
object
Reward category associated with the reward.
1 property
Account
object
Account assiciated with the reward.
2 properties
RedeemInstructions
object
Instructions on how to redeem the reward.
2 properties
Description
object
Description of the reward.
2 properties
RestrictedMessage
object
Message displayed to customer who cannot claim the reward.
2 properties
RewardPut
object
11 properties
ClaimButtonLabel
object
Label of the claim button.
2 properties
Segment
object
Segments associated with the reward.
3 properties
Name
object
The name of the reward.
2 properties
Terms
object
Terms and conditions of reward redemption.
2 properties
GetRewardResponse
object
24 properties
PUTError
object
3 properties
Price
object
Price of the reward in different currencies.
2 properties
ErrorResponse_3
object
3 properties
Rewards
object
Array of reward entries.
6 properties
Reward
object
A reward item
6 properties
Error
object
Errors occured.
1 property 1 required
Success
object
A successful reward claim.
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

antavo-rewards-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 Clubs API
Antavo Content consumption API
Antavo Contests API
Antavo Coupon pools API
Antavo Coupons API
Antavo Customer lists API
Antavo Customers API
Where this information came from

This is an independent, third-party profile of Antavo Rewards 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.