Antavo

Antavo Customers API

The Customers API from Antavo — 11 operation(s) for customers.

GitHub OpenAPI
Business capability
Customer Data Management BC-420.10

Operations 11

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /customers/-/count Count active customers · Returns the number of active customers #
Ask an LLM
“How many active members are in my loyalty program?”
“Is there a quick way to get the total active customer count?”
Tell an agent
Count the active customers in the program.
Tell me how many loyalty members currently have active status.
GET /customers/{customer_id} Fetch a customer with selected fields · Returns detailed customer data using the Antavo unique ID #
Ask an LLM
“Can I limit which profile fields come back when fetching one customer?”
“Which endpoint returns a member's data trimmed to the attributes I pick?”
Tell an agent
Fetch customer {customer_id} returning only the fields {fields}.
Pull member {customer_id} from the original customers endpoint.
GET /customers Search customers to find their Antavo ID · Search Antavo database using customer filters #
Ask an LLM
“Can I find a customer's Antavo ID by searching on their email?”
“Is the customer search case-sensitive, and does it allow partial matches?”
Tell an agent
Search customers for {search} and return their Antavo IDs.
Find customers matching {search} with match mode {match}, up to {limit} results.
POST /customers/{customer_id}/merge Merge a customer into another account · Merges the current customer into the target account #
Ask an LLM
“Can I merge a duplicate loyalty account into another one?”
“Is merging two customer accounts reversible?”
Tell an agent destructive · confirm first
Merge customer {customer_id} into target account {target}.
Permanently fold duplicate member {customer_id} into account {target}.
GET /customers/-/verify/ Verify a customer's registration · Verify credentials provided during registration #
Ask an LLM
“What activates a new member's account after they register?”
“What happens to a customer's status once verification succeeds?”
Tell an agent
Verify registration token {token}.
Confirm the sign-up with token {token} and send the member to {redirect_url}.
POST /customers/{customer_id}/opt-in Register a customer with login credentials · Create a new customer with log-in credentials #
Ask an LLM
“Can a customer self-register with a password for the loyalty program?”
“Which profile fields can be set when a member opts in?”
Tell an agent
Opt in customer {customer_id} with password {password}, confirmed as {confirm_password}.
Register member {customer_id} with email {email}, password {password} and confirmation {confirm_password}.
POST /customers/-/login Log a customer in · Log in a specific customer to Antavo #
Ask an LLM
“Can I authenticate a loyalty member with a username and password?”
“What does a successful member login return?”
Tell an agent
Log in member {username} with password {password}.
Sign customer {username} into the loyalty program using {password}.
POST /customers/-/password/request Send a password reset request · Request a new password for Antavo login #
Ask an LLM
“What lets a member who forgot their password get a reset link?”
“Can I control the URL in the password reset email?”
Tell an agent
Send a password reset email to {username}.
Request a new password for {username} with the reset link pointing to {url}.
POST /customers/-/password/reset Reset a customer's password with a token · Reset the password of the current customer #
Ask an LLM
“Can a customer set a new password using the token from the reset email?”
“Does the password reset check that both passwords match?”
Tell an agent
Reset the password with token {token} to {password}, confirmed as {confirm_password}.
Set new member password {password} using reset token {token} and confirmation {confirm_password}.
GET /v1/customers/{customer_id} Retrieve one customer's profile · Retrieve detailed customer data of a single customer #
Ask an LLM
“How do I get the full profile of one loyalty member by their customer ID?”
“Can I look up a customer using an external ID instead of the Antavo ID?”
Tell an agent
Get the details of customer {customer_id}.
Show me the profile data for loyalty member {customer_id}.
GET /v1/customers List loyalty program customers · Retrieve the list of customers #
Ask an LLM
“Which customers have joined the loyalty program, including custom attributes?”
“Can I filter the customer list by status or creation date?”
Tell an agent
List all customers in the workspace.
List {limit} customers matching {filter}, sorted by {sort}.

Documentation

📖
Documentation
https://developers.antavo.com/docs/antavo-apis
📖
APIReference
https://apidocs.antavo.com/api/index.html
📖
Documentation
https://developers.antavo.com/docs/api-signing
📖
APIReference
https://developers.antavo.com/reference/about-faq-api
📖
APIReference
https://developers.antavo.com/reference/about-loyalty-read-api
📖
APIReference
https://developers.antavo.com/reference/social-share-campaigns-api

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/antavo/refs/heads/main/openapi/antavo-customers-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • 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.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/antavo:antavo-customers-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

antavo-customers-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Antavo Customers API
  version: '1.0'
  description: 'Operations tagged Customers across 3 of this provider''s published API definitions: antavo-customer-openapi.yml, antavo-display-openapi.yml, antavo-loyalty-read-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.staging.antavo.com
  description: The Antavo staging environment
- url: https://read-api.<environment>.antavo.com
tags:


# --- truncated at 32 KB (64 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/antavo/refs/heads/main/openapi/antavo-customers-api-openapi.yml