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 Customer lists API

Bulk Customer List API endpoints

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

This API exposes 9 operations across 6 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.

9 operations 6 paths 15 schemas 1 DELETE4 GET3 POST1 PUT

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 Customer lists 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 9

Across 6 paths, the API surfaces 9 operations — 1 DELETE, 4 GET, 3 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Customer lists 9

Bulk Customer List API endpoints

GET
/v1/bulk-operation/customer-list/{batch_id}/status/errors
Query the erronous list operation attempts
3 params → 200404
GET
/v1/bulk-operation/customer-list/{batch_id}/status
Query the status of a list operation process
1 param → 200404
POST
/v1/bulk-operation/customer-list/add/{customer_list_id}
Add customers to a customer list
1 param body → 200400404
POST
/v1/bulk-operation/customer-list/remove/{customer_list_id}
Remove customers from a customer list
1 param body → 200400404
DELETE
/entities/core/customer-list/{entity_id}
Archive a customer list
1 param → 200400
GET
/entities/core/customer-list/{entity_id}
Retrieve information of a specific customer list
1 param → 200400
POST
/entities/core/customer-list/{entity_id}
Update a customer list
1 param body → 200400
GET
/entities/core/customer-list
List all available customer lists
→ 200
PUT
/entities/core/customer-list
Create a new customer list
body → 200

Schemas 15

The contract defines 15 schemas that model the data the API accepts and returns. The most detailed are ListErrorResponse (3 properties), SegmentResponse (3 properties), SuccesfulResponse (3 properties), SegmentError (3 properties). Each schema is shown below with its type and property counts.

BadRequestResponse
object
2 properties
ListNotFoundResponseAdd
object
2 properties
CustomerList
object
1 property 1 required
NotFoundErrorResponse
object
2 properties
CustomerListRemove
object
1 property 1 required
ListNotFoundResponseRemove
object
2 properties
ListErrorResponse
object
3 properties
metadatalist
object
2 properties
SuccesfulResponse
object
3 properties
ListStatusResponse
object
2 properties
ListBatchNotFound
object
2 properties
SegmentError
object
3 properties
PUTlistresponse
object
2 properties
SegmentErrorResponse
object
This describes the generic structure returned if an error occurred - A reward entity has been used as an example.
1 property
SegmentResponse
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

antavo-customer-lists-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 Customers API
AE Profile APIs.io
Antavo Data extensions API
AE Profile APIs.io
#Customer lists
← Back to A APIs
API Details
ID
antavo:antavo-customer-lists-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-customer-lists-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/antavo-customer-lists-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 Customer lists 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.