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

Antavo Coupons API

Bulk Coupons API endpoints

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

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

This API exposes 6 operations across 6 paths, and defines 22 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.

6 operations 6 paths 22 schemas 5 GET1 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
Resource Areas
1

Authentication & Security 1

Antavo Coupons API declares 1 security scheme for authenticating requests. An API key is passed in the query as api_key (api_key).

  • api_key — Provides API Key access to the endpoint.

Paths & Operations 6

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

Coupons 6

Bulk Coupons API endpoints

GET
/v1/bulk-operation/coupons/{batch_id}/status/error
Query the list of errors related to a coupon import
1 param → 200404
GET
/v1/bulk-operation/coupons/{batch_id}/status
Query the status of a coupon import
1 param → 200404
POST
/v1/bulk-operation/coupons/{coupon_pool_id}/{action}
Manage coupon codes in coupon pools
2 params body → 200400404
GET
/coupons
Query coupons independent of customer
Coupons 4 params → 200400
GET
/customers/{customer_id}/coupons
List coupons assigned to a customer
6 params → 200404
GET
/v1/customers/{customer_id}/coupons
Retrieve the list of a customer's coupons
listCustomerCoupons 5 params → 2004014225XX

Schemas 22

The contract defines 22 schemas that model the data the API accepts and returns. The most detailed are CouponEntity (26 properties), Coupon (15 properties), Coupon_2 (11 properties), DateTimeFilter (5 properties). Each schema is shown below with its type and property counts.

BadRequestResponse
object
2 properties
AddCouponsRequest
object
1 property
NotFoundErrorResponse
object
2 properties
AssignCouponsRequest
object
1 property 1 required
UnassignCouponsRequest
object
1 property 1 required
CouponsResponse
object
3 properties
CouponsStatusResponse
object
3 properties
ListBatchNotFound
object
2 properties
Couponlist
object
1 property 1 required
Coupon
object
15 properties
CouponError
object
3 properties
Coupon_2
object
11 properties
ErrorResponse
object
This describes the structure returned if an error occurred
1 property
SortDirection
string
PaginationLinks
object
2 properties 2 required
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
CustomerCouponSortEntry
object
Defines a single sorting instruction by specifying the field and direction.
2 properties 2 required
CouponsFilter
object
Filter by allowed fields and operators.
4 properties
CouponEntity
object
Coupon entity. The fields returned depend on the coupon data configured for the workspace. In addition to the standard fields listed below, custom coupon attri…
26 properties
ErrorEnvelope
object
1 property 1 required
CouponStatus
string
The coupon status to match. The status is determined from the coupon’s claim, redemption, expiration, invalidation, and balance data.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

antavo-coupons-api-openapi.yml Raw ↑

Other APIs Antavo publishes across the network.

Antavo Activities API
Antavo Async Events API
Antavo Authentication API
Antavo Cart API
Antavo Challenges API
Antavo Clubs API
Antavo Content consumption API
Antavo Contests API
Antavo Coupon pools API
Antavo Customer lists API
Antavo Customers API
Antavo Data extensions API
Where this information came from

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