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

This endpoint collects and aggregates all activities, provided by all modules

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

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

This API exposes 3 operations across 3 paths, and defines 15 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.

3 operations 3 paths 15 schemas 3 GET

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 Activities 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 3

Across 3 paths, the API surfaces 3 operations — 3 GET. Each is listed below with its method, path, parameters, and response codes.

Activities 3

This endpoint collects and aggregates all activities, provided by all modules

GET
/customers/{customer_id}/activities/earn
List all earn activities visible for a customer
1 param → 200404
GET
/customers/{customer_id}/activities/spend
List all available spend activities for a customer
1 param → 200404
GET
/customers/{customer_id}/activities
List all available activities for a customer
3 params → 200404

Schemas 15

The contract defines 15 schemas that model the data the API accepts and returns. The most detailed are SpendActivity (17 properties), Challenge (16 properties), Activity (9 properties), ContentConsumption (9 properties). Each schema is shown below with its type and property counts.

OfflineTreasure
object
Activities where users participate in offline treasure hunts.
7 properties
Progress
object
Progress details of the customer's challenge completion.
3 properties
IncentivizedPurchase
object
Activity where users complete a purchase to earn points.
7 properties
Challenge
object
Activity where users participate in a challenge.
16 properties
GamifiedReviews
object
Activity encouraging users to leave reviews. If the Multi-accounts module is used, the response includes point logic settings for all configured accounts.
9 properties
Activity
object
9 properties
GamifiedProfiling
object
Activity where users answer questions for gamified profiling flows.
9 properties
Image
object
Object contains different sizes of the image asset.
3 properties
ListofallActivitiesResponse
object
1 property
SpendActivity
object
17 properties
ContentConsumption
object
Activity where users consume content (videos or articles).
9 properties
SocialFollow
object
Activity encouraging users to follow a social media profile.
9 properties
ProgressCriterion
object
Individual criterion contributing to the overall progress.
5 properties
ImageSet
object
Object containing image URLs of various sizes.
3 properties
ErrorResponse
object
This describes the structure returned if an error occurred
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

antavo-activities-api-openapi.yml Raw ↑

Other APIs Antavo publishes across the network.

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
Antavo Data extensions API
Where this information came from

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