Antavo Loyalty Engine API
Agent-ready OpenAPI document · curated by JenticMarketingMarketing AutomationapiKey, bearer18 EndpointsREST
Know of an official OpenAPI document? Contribute it →
For Agents
Drive loyalty programs by posting earn/spend events, claiming rewards, and reading customer point balances and transaction history through Antavo's events and customers endpoints.
Use for: I need to award loyalty points for a completed purchase, Spend points to claim a reward on behalf of a customer, Look up the current point balance for a loyalty member, Retrieve the activity history for a customer
Not supported: Does not handle payment processing, email/SMS delivery, or product-catalogue management - use for loyalty events, point balances, and reward claims only.
Jentic publishes the only available OpenAPI specification for Antavo Loyalty Engine API, keeping it validated and agent-ready. Antavo is a loyalty-program engine that exposes 18 REST endpoints covering customer profiles, point-earning and point-spending activities, reward claiming, custom-event ingestion, and entity records that drive program rules. The API is structured around the events and customers resources so agents can post earn/spend activities, retrieve a customer's transaction history, and trigger reward claims directly from a CRM or e-commerce flow. Authentication supports both an api_key query parameter and HTTP bearer tokens.
Install Jentic One Beta
Connect the Antavo Loyalty Engine API to your agent
Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Antavo Loyalty Engine API, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.
Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.
1
Step 1: Jentic One Host machine
# On the machine that will host your Jentic One instance:
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Fantavo.com%2Fantavo" | sh2
Step 2: Agent machine
# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Fantavo.com%2Fantavo" | sh
jentic register # connects your agent to your Jentic One instanceJentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.
Capabilities
What an agent can do with Antavo Loyalty Engine API.
Post point-earning events (purchases, signups, referrals) to a customer's loyalty profile
Spend points or claim catalogue rewards on behalf of a loyalty member
Bulk-ingest historical events to seed or backfill loyalty data via the events/bulk endpoint
Merge two loyalty customer profiles when a duplicate is detected
Read a customer's transaction history and point balance for in-app display
Push custom entity records that loyalty rules and tier logic reference
Use Cases
Patterns agents use Antavo Loyalty Engine API for, with concrete tasks.
★ E-Commerce Earn-on-Purchase Hook
Wire a checkout webhook to call POST /events with the order amount, customer ID, and an 'earn' event type so points are awarded the moment a purchase completes. Antavo applies the program's tier rules and multipliers server-side, so the storefront does not need to encode loyalty math. Bulk historical seeding is supported via POST /events/bulk for migrations from another platform.
Call POST /events with type 'earn', the customer ID, and the order subtotal, then verify the response confirms the point award
Reward Redemption Flow
Let a customer redeem a reward in-app by calling POST /customers/{customerId}/activities/rewards/{rewardId}/claim with the desired reward ID. Antavo verifies the customer has enough points, applies the spend, and returns the claim status. Pair with POST /customers/{customerId}/activities/spend for ad-hoc point deductions outside the catalogue.
Call POST /customers/{customerId}/activities/rewards/{rewardId}/claim and surface the returned claim status to the user
Customer Profile and History Lookup
Display a member's point balance, tier, and recent activity by calling GET /customers/{customerId} and GET /customers/{customerId}/transactions. The agent uses these to render the loyalty section of an account page or to answer support questions like 'why did I only get 5 points on this order?' without screen-scraping the Antavo dashboard.
Call GET /customers/{customerId} for the member's profile, then GET /customers/{customerId}/transactions to list their last 10 point movements
AI Agent Loyalty Operations via Jentic
An AI agent embedded in a CRM or chat support flow can drive Antavo loyalty actions through Jentic without managing the api_key or bearer token directly. Jentic's intent search routes to POST /events or the customer activities endpoints with their input schema, and the credential is loaded from the vault at execution time so it never enters the agent's prompt context.
Search Jentic for 'award loyalty points for a purchase', load POST /events, and execute with the customer ID and purchase amount supplied by the support workflow
Key Endpoints
18 endpoints — jentic publishes the only available openapi specification for antavo loyalty engine api, keeping it validated and agent-ready.
METHOD
PATH
DESCRIPTION
POST
/events
Post a single earn or spend event
POST
/events/bulk
Bulk-ingest historical events
GET
/customers
List customers in the loyalty program
GET
/customers/{customerId}
Retrieve a customer profile and balance
POST
/customers/{customerId}/merge
Merge two duplicate customer profiles
POST
/customers/{customerId}/activities/earn
Award points for a custom earn activity
POST
/customers/{customerId}/activities/spend
Deduct points for a custom spend activity
POST
/customers/{customerId}/activities/rewards/{rewardId}/claim
Claim a catalogue reward for a customer
POST
/events
Post a single earn or spend event
POST
/events/bulk
Bulk-ingest historical events
GET
/customers
List customers in the loyalty program
GET
/customers/{customerId}
Retrieve a customer profile and balance
POST
/customers/{customerId}/merge
Merge two duplicate customer profiles
POST
/customers/{customerId}/activities/earn
Award points for a custom earn activity
POST
/customers/{customerId}/activities/spend
Deduct points for a custom spend activity
POST
/customers/{customerId}/activities/rewards/{rewardId}/claim
Claim a catalogue reward for a customer
Why Jentic?
What agents get from Jentic-routed access to this vendor.
Setup
Wiring the Antavo Loyalty Engine API by hand means managing both the api_key and a bearer token and shaping event payloads for its earn and spend flows yourself. Through Jentic you install once, import Antavo from the API Directory, store the credentials once, and your agent calls it.
Permission scoping
Antavo puts the customer id in the URL path (/customers/{customerId}/activities/...), so a rule can pin your agent to one customer: it can read that customer and record their activities and nothing else. You choose the operations it may call, so a customer merge is not included unless you add it.
Credential isolation
Your Antavo api_key and bearer token are stored once, encrypted, by your own Jentic One instance and injected at execution time. They never enter the agent's prompt, logs, or context.
Intent-based discovery
Agents search Jentic by intent such as 'award loyalty points for a purchase' or 'get a customer point balance', and Jentic returns the matching Antavo operation with its input schema so the agent calls the right endpoint without browsing the reference docs.
Related APIs
Alternatives and complements available in the Jentic catalogue.
FAQs
Specific to using Antavo Loyalty Engine API through Jentic.
Why is there no official OpenAPI spec for Antavo Loyalty Engine API?
Antavo publishes its docs at developers.antavo.com but does not ship a downloadable OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call Antavo via structured tooling. It is validated against the live API and kept up to date. Get started with Jentic One, the self-hosted execution layer.
What authentication does the Antavo Loyalty Engine API use?
Antavo accepts either an api_key query parameter or an HTTP bearer token. Through Jentic both credential types are stored in the encrypted vault and injected at execution time, so the raw key or token never enters the agent's prompt context.
Can I bulk-load historical events into Antavo?
Yes. POST /events/bulk accepts an array of historical earn or spend events for backfill or migration from another loyalty platform. Single-event traffic uses POST /events instead.
What are the rate limits for the Antavo Loyalty Engine API?
The OpenAPI spec does not declare explicit rate limits. Antavo enforces per-tenant throughput on the live service - confirm the limit for your plan and use POST /events/bulk for backfills rather than rapid-fire single-event calls.
How do I award loyalty points after a purchase with Antavo through Jentic?
Run pip install jentic, then search Jentic for 'award loyalty points for a purchase'. Jentic returns POST /events with its earn-event schema. Execute with the customer ID and order subtotal, and Antavo applies the program's tier and multiplier rules server-side.
Does Antavo support customer profile merging?
Yes. POST /customers/{customerId}/merge merges two loyalty profiles when a duplicate is detected, consolidating point balance, tier, and transaction history under a single record.
Can I limit what my agent is allowed to do with the Antavo Loyalty Engine API?
Yes. Because Jentic One is self-hosted, you set the rules that decide which Antavo operations and credentials your agent can use. Antavo puts the customer id in the URL path (/customers/{customerId}/activities/...), so a rule can pin the agent to a single customer, letting it read that profile and record earn and spend activities and nothing else. You also choose the exact operations it may call, so an action like POST /customers/{customerId}/merge stays out of reach unless you explicitly allow it.
GET STARTED