List vouchers

Developing

GET

https://api.targetcircle.com/api/v2/publisher/vouchers

Using this endpoint you can list deals and vouchers that are available to your offers.

Request

Authorization

API Key

Add parameter in header

X-Api-Token

Example:

X-Api-Token: ********************

Query Params

Header Params

Responses

🟢200Success

application/json

Bodyapplication/json

🟠401Unauthorized

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://api.targetcircle.com/api/v2/publisher/vouchers?offerSid=undefined&adInventorySid=undefined&page=undefined&perPage=undefined' \
--header 'X-Api-Token: <api-key>'

Response Example

{
    "data": [
        {
            "name": "string",
            "type": "deal",
            "clickTrackingUrl": "string",
            "code": "BLACK_10",
            "validFrom": "2019-08-24",
            "validUntil": "2019-08-24",
            "discount": {
                "type": "fixed",
                "value": 0,
                "currency": "string"
            },
            "language": "string",
            "description": "string",
            "termsAndConditions": "string"
        }
    ],
    "meta": {
        "page": 0,
        "perPage": 0
    },
    "links": {
        "next": {
            "rel": "next",
            "href": "string",
            "method": "GET"
        },
        "prev": {
            "rel": "next",
            "href": "string",
            "method": "GET"
        }
    }
}

Modified at 2026-02-19 15:10:21

List offers