The primary headless API for building the member-facing loyalty experience - listing earn and spend activities, challenges, rewards, offers, coupons, transactions, wallet passes, quizzes, contests, prize wheels, and profiling flows, plus claiming and revoking rewards.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
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.curl "https://apis.io/api/v1/apis/antavo-display-api"curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
openapi: 3.0.0
info:
contact: {}
title: Antavo Display API
version: 1.0.0
servers:
- url: https://api.staging.antavo.com
description: The Antavo staging environment
paths:
/customers/{customer_id}/activities/challenges:
get:
tags:
- Challenges
summary: List all available challenges for a customer
description: This endpoint returns all active challenges that are available for the customer to
complete. To access a filtered result, please use the [v2 endpoint](/reference/get_v2-customers-customer-id-activities-challenges).
parameters:
- name: customer_id
in: path
required: true
description: "Unique customer ID. This can be \n\n * The Antavo customer ID\n * An external\
\ ID (requires [configuration](/docs/customers#external-identifiers)): ``{external_field:external_id_value}``\n"
schema:
type: string
example: 280e674c-c4ea-4a30-987a-d9267d1a5018
responses:
'200':
description: List of challenges
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/ChallengeActivity'
'404':
description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
Customer not found:
value:
type: NotFoundException
code: 160212
message: Customer not found
/customers/{customer_id}/activities/content-consumption:
get:
tags:
- Content consumption
summary: List available content consumption activities for a customer
description: This endpoint returns all content consumption activities that are available for a specific
customer to complete.
parameters:
- name: customer_id
in: path
required: true
description: "Unique customer ID. This can be \n\n * The Antavo customer ID\n * An external\
\ ID (requires [configuration](/docs/customers#external-identifiers)): ``{external_field:external_id_value}``\n"
schema:
type: string
example: 280e674c-c4ea-4a30-987a-d9267d1a5018
responses:
'200':
description: List of content consumption activities for the specific customer
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/ContentConsumptionActivityEndpoint'
'404':
description: Customer not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
Customer not found:
value:
type: NotFoundException
code: 160212
message: Customer not found
/customers/{customer_id}/activities/contests:
get:
tags:
- Contests
summary: List all available contests for a customer
description: This endpoint returns all contests that are available for a specific customer to enter.
parameters:
- in: path
name: customer_id
description: "Unique customer ID. This can be \n\n* The Antavo customer ID\n* An external ID (requires\
\ [configuration](/docs/customers#external-identifiers)): ``{external_field:external_id_value}``\n"
required: true
schema:
type: string
example: 280e674c-c4ea-4a30-987a-d9267d1a5018
- name: fields
in: query
description: Comma separated list of custom attributes to include in the response.
schema:
type: string
example: cf_prize_cost
responses:
'200':
description: List of available contests
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/ContestActivity'
'404':
description: Customer not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
Customer not found:
value:
type: NotFoundException
code: 160212
message: Customer not found
/customers/{customer_id}/activities/earn:
get:
tags:
- Activities
summary: List all earn activities visible for a customer
description: 'Aggregates all earn activities relevant to the customer, provided by modules including:
* [Challenges](https://docs.antavo.com/docs/challenges)
* [Gamified profiling](https://docs.antavo.com/docs/gamified-profiling)
* [Incentivized purchase](https://docs.antavo.com/docs/incentivized-purchase)
* [Social follow](https://docs.antavo.com/docs/social-follow)
* [Offline treasure hunt](https://docs.antavo.com/docs/offline-treasure-hunt)
* [Content consumption](https://docs.antavo.com/docs/content-consumption)
* [Gamified reviews](https://docs.antavo.com/docs/gamified-reviews)
'
parameters:
- name: customer_id
in: path
required: true
description: "Unique customer ID. This can be \n\n * The Antavo customer ID\n * An external\
\ ID (requires [configuration](/docs/customers#external-identifiers)): ``{external_field:external_id_value}``\n"
schema:
type: string
example: 280e674c-c4ea-4a30-987a-d9267d1a5018
responses:
'200':
description: List of earn activities for the specific customer.<br> The list of information
returned in the response depends on the type of the activity and its configured attributes.
content:
application/json:
schema:
type: object
properties:
data:
type: array
description: List of activities available to the customer
items:
oneOf:
- $ref: '#/components/schemas/GamifiedReviews'
- $ref: '#/components/schemas/SocialFollow'
- $ref: '#/components/schemas/Challenge'
- $ref: '#/components/schemas/ContentConsumption'
- $ref: '#/components/schemas/IncentivizedPurchase'
- $ref: '#/components/schemas/OfflineTreasure'
- $ref: '#/components/schemas/GamifiedProfiling'
'404':
description: Customer not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
Customer not found:
value:
type: NotFoundException
code: 160212
message: Customer not found
/customers/{customer_id}/activities/offers:
get:
tags:
- Offers
summary: List all offers available for the customer
description: This endpoints provides the list of all available offers for a specific customer.
parameters:
- name: customer_id
in: path
required: true
description: "Unique customer ID. This can be \n\n * The Antavo customer ID\n * An external\
\ ID (requires [configuration](/docs/customers#external-identifiers)): ``{external_field:external_id_value}``\n"
schema:
type: string
example: 280e674c-c4ea-4a30-987a-d9267d1a5018
responses:
'200':
description: List of all available offers.
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/OfferActivity'
'404':
description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
Customer not found:
value:
type: NotFoundException
code: 160212
message: Customer not found
/customers/{customer_id}/activities/profiling/{flow_id}/next:
get:
tags:
- Profiling
summary: Retrieve the next question to answer within a profiling flow
description: This endpoints returns the next question within a profiling flow that the customer
should answer. If there are no more questions left to answer in the given flow, the call will
trigger the ``profiling_flow`` event, and any associated points will be awarded to the customer.
parameters:
- name: customer_id
in: path
required: true
description: "Unique customer ID. This can be \n\n * The Antavo customer ID\n * An external\
\ ID (requires [configuration](/docs/customers#external-identifiers)): ``{external_field:external_id_value}``\n"
schema:
type: string
example: 280e674c-c4ea-4a30-987a-d9267d1a5018
- name: flow_id
in: path
required: true
description: The ID of the profiling flow to complete.
schema:
type: string
example: 63d8d8cc17572c6ec15e688c
- name: Accept-language
in: header
description: 'If set in the Antavo Management UI, this header will ensure the response returns
translated values for the following question attributes:
* title
* description
* possible answers
'
required: false
schema:
type: string
description: ISO639 code of the language.
example: de
responses:
'200':
description: The next question to answer.<br> The information returned in the response depends
on the type of answer and its configured attributes. This example shows the attributes of
a **text_options** question.
content:
application/json:
schema:
$ref: '#/components/schemas/ProfilingQuestionOptions'
'400':
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
No more questions to answer:
value:
type: BadRequestException
code: 0
message: There are no more questions
'404':
description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
Customer not found:
value:
type: NotFoundException
code: 160212
message: Customer not found
/customers/{customer_id}/activities/profiling:
get:
tags:
- Profiling
summary: List profiling flows available to the customer
description: This endpoints provides the list of all available profiling flow for a specific customer
to complete.
parameters:
- name: customer_id
in: path
required: true
description: "Unique customer ID. This can be \n\n * The Antavo customer ID\n * An external\
\ ID (requires [configuration](/docs/customers#external-identifiers)): ``{external_field:external_id_value}``\n"
schema:
type: string
example: 280e674c-c4ea-4a30-987a-d9267d1a5018
responses:
'200':
description: List of profiling flows activities
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/Activity'
'404':
description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
Customer not found:
value:
type: NotFoundException
code: 160212
message: Customer not found
/customers/{customer_id}/activities/quizzes/{quiz_id}:
get:
tags:
- Quizzes
summary: List quiz details
description: This endpoint returns configured attributes of quiz questions.
parameters:
- name: customer_id
in: path
description: "Unique customer ID. This can be \n\n* The Antavo customer ID\n* An external ID (requires\
\ [configuration](/docs/customers#external-identifiers)): ``{external_field:external_id_value}``\n"
required: true
style: simple
schema:
type: string
example: 280e674c-c4ea-4a30-987a-d9267d1a5018
- name: quiz_id
in: path
description: Unique identifier of the quiz.
required: true
style: simple
schema:
type: string
example: 6689b5735aa0eb191451a2f5
responses:
'200':
description: Quiz details
content:
application/json:
schema:
$ref: '#/components/schemas/QuizDetailsResponse'
'404':
description: Customer not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
fail:
summary: Customer not found
value:
type: NotFoundException
code: 160212
message: Customer not Found
deprecated: false
/customers/{customer_id}/activities/quizzes:
get:
tags:
- Quizzes
summary: List all quizzes
description: This endpoint returns all configured quiz questions that the customer may answer.
parameters:
- name: customer_id
in: path
description: "Unique customer ID. This can be \n\n* The Antavo customer ID\n* An external ID (requires\
\ [configuration](/docs/customers#external-identifiers)): ``{external_field:external_id_value}``\n"
required: true
schema:
type: string
example: 280e674c-c4ea-4a30-987a-d9267d1a5018
- name: offset
in: query
description: Offsets the starting number of quiz questions to return. This is used in pagination
in conjunction with the limit query.
schema:
type: integer
default: 0
- name: limit
in: query
description: Limits the number of quiz questions returned in one response. Other values are accessible
by pagination made accessible via the offset.
schema:
type: integer
default: 20
responses:
'200':
description: List of all quiz questions
content:
application/json:
schema:
$ref: '#/components/schemas/QuizActivity'
'404':
description: Customer not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
fail:
summary: Customer not found
value:
type: NotFoundException
code: 160212
message: Customer not Found
deprecated: false
/customers/{customer_id}/activities/rewards/{reward_id}:
get:
tags:
- Rewards
summary: Retrieve a specific reward available for a customer
description: A endpoint provides detailed information about a specified reward available for a specific
customer.
parameters:
- name: customer_id
in: path
required: true
description: "Unique customer ID. This can be \n\n * The Antavo customer ID\n * An external\
\ ID (requires [configuration](/docs/customers#external-identifiers)): ``{external_field:external_id_value}``\n"
schema:
type: string
example: 280e674c-c4ea-4a30-987a-d9267d1a5018
- name: reward_id
in: path
required: true
description: Unique indentifier of the reward.
schema:
type: string
example: 668434f93d963535a513bf37
- name: fields
in: query
description: 'Use the `claims` field to see the claimed rewards and associated information for
each **currently** available reward.
'
schema:
type: string
example: claims
responses:
'200':
description: The list of attributes of the reward. The list of information returned in the response
depends on the type of the reward and its configured attribute. This example shows the attributes
of claiming a **dynamic coupon** reward.
content:
application/json:
schema:
$ref: '#/components/schemas/DynamicCouponRewardActivity'
'400':
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
Reward is not active:
value:
type: BadRequestException
code: 160321
message: Reward is not active
'404':
description: Customer not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
Customer not found:
value:
type: NotFoundException
code: 160212
message: Customer not found
/customers/{customer_id}/activities/rewards:
get:
tags:
- Rewards
summary: List all available rewards for a customer
description: This endpoints provides the list of all available rewards for a specific customer.
parameters:
- name: customer_id
in: path
required: true
description: "Unique customer ID. This can be \n\n * The Antavo customer ID\n * An external\
\ ID (requires [configuration](/docs/customers#external-identifiers)): ``{external_field:external_id_value}``\n"
schema:
type: string
example: 280e674c-c4ea-4a30-987a-d9267d1a5018
- name: fields
in: query
description: "Comma separated list of non-standard fields to be included in the response. Accepted\
\ values: \n\n* `claims`: See the claimed rewards and associated information for each **currently**\
\ available reward.\n\n* `custom_data`: Access this field set in the reward configuration.\n\
\n* `gallery`: Provides, where available, image links specified in the reward configuration.\n\
\n* `instructions`: Access redeem instructions set in the reward configuration.\n\n* `terms`:\
\ Access terms and conditions set in the reward configuration.\n\n* Any custom attributes configued\
\ in the [Entities module](https://docs.antavo.com/docs/custom-entities#adding-custom-entity-attributes)\
\ with `cf_` prefix.\n"
schema:
type: string
enum:
- claims
- custom_data
- events
- gallery
- instructions
- terms
- name: limit
in: query
description: 'Limits the number of rewards to be returned in one response. Other values are accessible
by pagination made accessible via the offset.
'
schema:
type: integer
default: 100
- name: offset
in: query
description: 'Offsets the starting number of rewards to return. This is used in pagination in
conjunction with the limit query.
'
schema:
type: integer
default: 0
- name: sort
in: query
description: 'Sorts the results by the selected value, which can be `starts_at`, `ends_at`, or
`order`. This query can be used in conjunction with the order query.
'
schema:
type: string
example: starts_at
- name: order
in: query
description: 'Used in conjunction with the sort query to list the results in ascending or descending
order. The value can be `asc` for an ascending order or `desc` for a descending order.
'
schema:
type: string
example: desc
responses:
'200':
description: List of rewards <br> The list of information returned in the response depends on
the type of the reward and its configured attributes. This example shows the attributes of
a **coupon** reward.
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/CouponPoolRewardActivity'
'404':
description: Customer not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
Customer not found:
value:
type: NotFoundException
code: 160212
message: Customer not found
/customers/{customer_id}/activities/spend:
get:
tags:
- Activities
summary: List all available spend activities for a customer
description: 'Aggregates available earn and spend options provided by modules including:
* [Rewards](https://docs.antavo.com/docs/rewards)
* [Contest lite](https://docs.antavo.com/docs/contest-lite)
'
parameters:
- name: customer_id
in: path
required: true
description: "Unique customer ID. This can be \n\n * The Antavo customer ID\n * An external\
\ ID (requires [configuration](/docs/customers#external-identifiers)): ``{external_field:external_id_value}``\n"
schema:
type: string
responses:
'200':
description: List of earn activities for the specific customer. <br> The list of information
returned in the response depends on the type of the spend activity and its configured attribute.
This example shows the attributes of **claiming a coupon reward**.
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/SpendActivity'
'404':
description: Customer not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
Customer not found:
value:
type: NotFoundException
code: 160212
message: Customer not found
/customers/{customer_id}/activities/treasure-hunt:
get:
tags:
- Treasure hunt
summary: List all available treasure hunts
description: This endpoint returns the list of all available online treasure hunts for a specific
customer.
parameters:
- name: customer_id
in: path
required: true
description: "Unique customer ID. This can be \n\n* The Antavo customer ID\n* An external ID (requires\
\ [configuration](/docs/customers#external-identifiers)): ``{external_field:external_id_value}``\n"
schema:
type: string
example: 280e674c-c4ea-4a30-987a-d9267d1a5018
responses:
'200':
description: Available treasure hunts
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/TreasureHuntResponse'
'404':
description: Customer not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
fail:
summary: Customer not found
value:
type: NotFoundException
code: 160212
message: Customer not Found
/customers/{customer_id}/activities:
get:
tags:
- Activities
summary: List all available activities for a customer
description: 'Aggregates available earn and spend options provided by modules including:
* [Challenges](https://docs.antavo.com/docs/challenges)
* [Gamified profiling](https://docs.antavo.com/docs/gamified-profiling)
* [Incentivized purchase](https://docs.antavo.com/docs/incentivized-purchase)
* [Rewards](https://docs.antavo.com/docs/rewards)
* [Social follow](https://docs.antavo.com/docs/social-follow)
* [Social share](https://docs.antavo.com/docs/social-share)
* [Offline treasure hunt](https://docs.antavo.com/docs/offline-treasure-hunt)
* [Contest lite](https://docs.antavo.com/docs/contest-lite)
* [Content consumption](https://docs.antavo.com/docs/content-consumption)
* [Gamified reviews](https://docs.antavo.com/docs/gamified-reviews)
* [Friend referral](https://docs.antavo.com/docs/friend-referral)
* [Instagram contests](https://docs.antavo.com/docs/instagram-contests)
* [Offers](https://docs.antavo.com/docs/offers)
* [Quizzes](https://docs.antavo.com/docs/quizzes)
* [Online treasure hunt](https://docs.antavo.com/docs/online-treasure-hunt)
* [Prize wheels](https://docs.antavo.com/docs/prize-wheels)
* [Workflow campaigns](https://docs.antavo.com/docs/workflow-configuration#configure-campaign-settings)
'
parameters:
- name: customer_id
in: path
description: "Unique customer ID. This can be \n\n * The Antavo customer ID\n * An external\
\ ID (requires [configuration](/docs/customers#external-identifiers)): ``{external_field:external_id_value}``\n"
required: true
style: simple
schema:
type: string
example: 280e674c-c4ea-4a30-987a-d9267d1a5018
- name: activity_types
in: query
description: "A comma-separated list of activity types to filter the results. Options:\n * `challenge`\n\
\ * `reward`\n * `social_share`\n * `profiling`\n * `offer`\n * `treasure`\n * `offline_treasure`\n\
\ * `contest`\n * `incentivized_purchase`\n * `content_consumption`\n * `social_follow`\n\
\ * `review`\n * `friend_referral`\n * `instagram_contests`\n * `prize wheels`\n * `quiz`\n\
\ * `campaign`\n"
style: form
explode: true
schema:
type: string
example: reward,profiling
- name: fields
in: query
description: Comma separated list of custom attributes to include in the response.
schema:
type: string
example: cf_prize_cost
responses:
'200':
description: List of all activities for the specific customer.<br> The list of information returned
in the response depends on the type of the activity and its configured attribute. This example
shows the attributes of a **profiling** activity.
content:
application/json:
schema:
$ref: '#/components/schemas/ListofallActivitiesResponse'
'404':
description: Customer not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
Customer not found:
value:
type: NotFoundException
code: 160212
message: Customer not found
deprecated: false
/customers/{customer_id}/challenges:
get:
tags:
- Challenges
summary: List a customer's completed challenges
description: This endpoint returns a customer's challenge completion history. Use the [v2 endpoint](/reference/get_v2-customers-customer-id-challenges)
to get a more complete and filterable view.
parameters:
- name: customer_id
in: path
required: true
description: "Unique customer ID. This can be \n\n * The Antavo customer ID\n * An external\
\ ID (requires [configuration](/docs/customers#external-identifiers)): ``{external_field:external_id_value}``\n"
schema:
type: string
example: 280e674c-c4ea-4a30-987a-d9267d1a5018
responses:
'200':
description: List of the customer's challenge completions
content:
application/json:
schema:
type: object
description: Lists challenge completions
properties:
data:
type: array
items:
$ref: '#/components/schemas/ChallengeCompletion'
'404':
description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
Customer not found:
value:
type: NotFoundException
code: 160212
message: Customer not found
/customers/{customer_id}/coupons:
get:
tags:
- Coupons
summary: List coupons assigned to a customer
description: Returns all coupons that has been assigned to a specified customer.
parameters:
- in: path
name: customer_id
description: "Unique customer ID. This can be \n\n* The Antavo customer ID\n* An external ID (requires\
\ [configuration](/docs/customers#external-identifiers)): ``{external_field:external_id_value}``\n"
required: true
schema:
type: string
example: 280e674c-c4ea-4a30-987a-d9267d1a5018
- in: query
name: code
description: Filter by the coupon code
required: false
schema:
type: string
example: TC22341
- in: query
name: name
description: Filter by the name of the coupon
required: false
schema:
type: string
example: 10% off
- in: query
name: status
description: 'Filter by coupon status. Accepted values: `claimed`, `expired`, `partially_redeemed`
and `redeemed`.'
required: false
schema:
type: string
enum:
- claimed
- expired
- partially_redeemed
- redeemed
- in: query
name: type
description: 'Filter by type of coupon. Accepted values: `amount`, `free_shipping`, `gift_card`,
`percentage`.'
required: false
schema:
type: string
enum:
- amount
- free_shipping
- gift_card
- percentage
- in: query
name: value
# --- truncated at 32 KB (220 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/antavo/refs/heads/main/openapi/antavo-display-openapi.yml