Resgates

homolog

https://api2-homolog.vik.app

GET

{{BASE_URL}}/api/v1/coupons_claims

Retorna dados sobre os resgates de cupons realizados pelos colaboradores.

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_claims?page=1&user_id=3123214&claim_id=123112&coupon_id=21321&start_date=2024-02-01&end_date=2024-03-01&update_start_date=2025-10-01&update_end_date=2025-10-30' \
--header 'x-api-key: <api-key>'

Response Example

200 - Sucesso

{
    "data": [
        {
            "id": 4444564,
            "user_id": 217327,
            "coupon_id": 1221,
            "code": "2068f3fd",
            "coins": 1,
            "created_at": "2024-10-08T20:09:04.282Z",
            "updated_at": "2024-10-08T20:09:04.283Z"
        },
        {
            "id": 876354312321,
            "user_id": 21212121,
            "coupon_id": 22222,
            "code": "33ad1109",
            "coins": 25,
            "created_at": "2024-10-02T13:47:48.752Z",
            "updated_at": "2024-10-02T13:47:48.752Z"
        },
        {
            "id": 321321321,
            "user_id": 12122121,
            "coupon_id": 13247121,
            "code": "33280ad8",
            "coins": 50,
            "created_at": "2024-10-02T13:47:31.933Z",
            "updated_at": "2024-10-02T13:47:31.934Z"
        }
    ],
    "pagy": {
        "page": 1,
        "per_page": 100,
        "total_items": 400,
        "total_pages": 4,
        "next_page": 2,
        "prev_page": null
    }
}

Modificado em 2025-10-08 13:14:58