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

A general method for creating, accessing and modifying an Antavo entity.

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

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

This API exposes 7 operations across 3 paths, and defines 20 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

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

7 operations 3 paths 20 schemas 1 DELETE2 GET2 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

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

Authentication & Security 1

Antavo Generic 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.

  • api_key — Provides API Key access to the endpoint

Paths & Operations 7

Across 3 paths, the API surfaces 7 operations — 1 DELETE, 2 GET, 2 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Generic 7

A general method for creating, accessing and modifying an Antavo entity.

DELETE
/entities/{module}/{entity}/{entity_id}
Archive an inactive entity
Entitydelete 3 params → 200404
GET
/entities/{module}/{entity}/{entity_id}
Retrieve all information regarding a specific entity
entityget 4 params → 200400
POST
/entities/{module}/{entity}/{entity_id}
Update a specific entity
entityupdate 3 params body → 200400
PUT
/entities/{module}/{entity}/{entity_id}
Create a new entity with a specific entity ID
Genericspeccreate 3 params body → 200400
GET
/entities/{module}/{entity}
List all available entity of an entity module
5 params → 200400
PUT
/entities/{module}/{entity}
Create a new entity
Genericcreate 2 params body → 200400
POST
/entities
Submit entities in bulk
body → 200404

Schemas 20

The contract defines 20 schemas that model the data the API accepts and returns. The most detailed are GetRewardResponse (24 properties), RewardResponse (23 properties), RewardPut (11 properties), Entity (4 properties). Each schema is shown below with its type and property counts.

RestrictedMessage
object
Message displayed to customer who cannot claim the reward.
2 properties
RewardResponse
object
23 properties
GetRewardResponse
object
24 properties
PUTError
object
3 properties
Price
object
Price of the reward in different currencies.
2 properties
RedeemInstructions
object
Instructions on how to redeem the reward.
2 properties
Description
object
Description of the reward.
2 properties
Bulkentitytwoitems
object
3 properties
ClaimButtonLabel
object
Label of the claim button.
2 properties
Segment
object
Segments associated with the reward.
3 properties
Entity
object
A specified API call for a defined entity
4 properties
Bulkentityone
object
An API response for an error-free defined bulk entity call.
3 properties
Terms
object
Terms and conditions of reward redemption.
2 properties
Category
object
Reward category associated with the reward.
1 property
Bulkentitytwo
object
An API response containing an erroneous bulk entity call.
4 properties
RewardPut
object
11 properties
GetRewardsResponse
object
1 property
ErrorResponse
object
3 properties
Account
object
Account assiciated with the reward.
2 properties
Name
object
The name of the reward.
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

antavo-generic-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 Generic 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.