Cupons

homolog

https://api2-homolog.vik.app

GET

{{BASE_URL}}/api/v1/coupons

Retorna os registros de cupons cadastrados

Requisição

Authorization

Adicionar parâmetro em header

x-api-key

Exemplo:

x-api-key: ********************

Parâmetros de Consulta

Respostas

🟢200OK

application/json

Body

🟠401Não autorizado

🟠422Erro de parâmetro

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request GET '{{BASE_URL}}/api/v1/coupons?page=2&started_on=2025-05-02&ended_on=2025-05-20&coupon_id=157728&active=true&start_date=2025-02-10&end_date=2025-02-28&update_start_date=2025-10-01&update_end_date=2025-10-30' \
--header 'x-api-key: <api-key>'

Response Example

200 - Sucesso

{
    "data": [
        {
            "id": 1213223,
            "sponsor": 532,
            "title": "Coupon_fe16077e",
            "coins": 5,
            "start_date": "2024-10-10",
            "end_date": null,
            "total_reached_users": 16315,
            "total_visualizations": 185,
            "engagement": 18.5,
            "total_redeemed": 1,
            "adhesion": 0.0,
            "coupons_number": 0,
            "coupons_remaining": 0,
            "active": true,
            "created_at": "2024-10-10T18:17:50.553Z",
            "updated_at": "2024-10-10T18:17:50.575Z"
        },
        {
            "id": 49846841,
            "sponsor": 54,
            "title": "Coupon_6e10dc13",
            "coins": 5,
            "start_date": "2024-10-08",
            "end_date": null,
            "total_reached_users": 16315,
            "total_visualizations": 744,
            "engagement": 74.4,
            "total_redeemed": 403,
            "adhesion": 74.4,
            "coupons_number": 1000,
            "coupons_remaining": 1000,
            "active": true,
            "created_at": "2024-10-08T14:03:53.853Z",
            "updated_at": "2024-10-08T14:04:22.772Z"
        }
    ],
    "pagy": {
        "page": 5,
        "per_page": 100,
        "total_items": 570,
        "total_pages": 6,
        "next_page": 6,
        "prev_page": 4
    }
}

Modificado em 2025-10-08 13:24:40