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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Antavo

Antavo Customers API

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

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

This API exposes 11 operations across 11 paths, and defines 26 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against 2 base URLs: https://api.staging.antavo.com, https://read-api..antavo.com.

11 operations 11 paths 26 schemas 6 GET5 POST

Metadata

The identity and technical contract details declared by the specification.

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

Authentication & Security 2

Antavo Customers API declares 2 security schemes for authenticating requests. An API key is passed in the query as api_key (ApiKeyAuth). An API key is passed in the query as api_key (api_key).

  • api_key — Provides API Key access to the endpoint

Paths & Operations 11

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

Customers 11
GET
/customers/-/count
Returns the number of active customers
→ 200
GET
/customers/{customer_id}
Returns detailed customer data using the Antavo unique ID
2 params → 200400404
GET
/customers
Search Antavo database using customer filters
6 params → 200404
POST
/customers/{customer_id}/merge
Merges the current customer into the target account
1 param body → 200400404
GET
/customers/-/verify/
Verify credentials provided during registration
2 params → 200400
POST
/customers/{customer_id}/opt-in
Create a new customer with log-in credentials
1 param body → 200400
POST
/customers/-/login
Log in a specific customer to Antavo
body → 200400
POST
/customers/-/password/request
Request a new password for Antavo login
body → 200400
POST
/customers/-/password/reset
Reset the password of the current customer
body → 200400
GET
/v1/customers/{customer_id}
Retrieve detailed customer data of a single customer
getCustomer 1 param → 2004014045XX
GET
/v1/customers
Retrieve the list of customers
listCustomers 4 params → 2004014225XX

Schemas 26

The contract defines 26 schemas that model the data the API accepts and returns. The most detailed are CustomerEntity (43 properties), Customer (29 properties), Customer_2 (21 properties), Optin (11 properties). Each schema is shown below with its type and property counts.

Customers
object
Returns Customer unique id which match the search criteria
1 property
TierStructure
object
The overall structure in which the current tier is located.
2 properties
Customer
object
Detailed customer information for a given Customer unique id.
29 properties
Count
object
Number of customers
1 property
Properties
object
Custom attributes you track about the customer. Data returned in this object depends on profiling questions or custom data recorded by custom events (may requi…
1 property
TierNext
object
Information about the next available loyalty tier.
3 properties
ErrorResponse
object
occurred
1 property 1 required
Gender
string
Gender of the customer.
PasswordRequest
object
2 properties
PasswordReset
object
3 properties
Status9
string
Status of the customer.
token
string
Token needed for [password reset](https://developers.antavo.com/reference/postcustomers-password-reset).
Optin
object
Customer opt-in properties
11 properties 2 required
PasswordResponse
object
This describes the structure returned if an error occurred.
1 property
Customer_2
object
Customer object
21 properties
Login
object
2 properties
ErrorResponse_2
object
This describes the structure returned if an error occurred
1 property
NextCustomerTier
object
Information about the next tier available to the customer. The object is empty when no higher tier is available.
3 properties
PaginationLinks
object
2 properties 2 required
CustomersFilter
object
Filter object for GET /v1/customers. URL form: ?filter[ ][ ]= . Multiple operators on the same field are allowed.
2 properties
DateTimeFilter
object
Filters a date or date-time field. The following formats are accepted: - YYYY-MM-DD (interpreted as midnight UTC) - YYYY-MM-DDTHH:MM:SS (no time zone offset, i…
5 properties
CollectionMetadata
object
1 property 1 required
CustomerEntity
object
Customer entity. The fields and values returned may differ based on workspace configuration.
43 properties
CustomerSortEntry
object
Defines a single sorting instruction by specifying the field and direction.
2 properties 2 required
ErrorEnvelope
object
1 property 1 required
SortDirection
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

antavo-customers-api-openapi.yml Raw ↑

Other APIs Antavo publishes across the network.

Antavo Activities API
AE Profile APIs.io
Antavo Async Events API
AE Profile APIs.io
Antavo Authentication API
AE Profile APIs.io
Antavo Cart API
AE Profile APIs.io
Antavo Challenges API
AE Profile APIs.io
Antavo Clubs API
AE Profile APIs.io
Antavo Content consumption API
AE Profile APIs.io
Antavo Contests API
AE Profile APIs.io
Antavo Coupon pools API
AE Profile APIs.io
Antavo Coupons API
AE Profile APIs.io
Antavo Customer lists API
AE Profile APIs.io
Antavo Data extensions API
AE Profile APIs.io
#Customers
← Back to A APIs
API Details
ID
antavo:antavo-customers-api
Base URL
https://api.antavo.com
Docs
https://developers.antavo.com/docs/antavo-apis
Provider
Antavo
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=antavo-customers-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/antavo-customers-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

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

Where this information came from

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