Listar Usuários de um Cupom
Descrição
Retorna todos os usuários vinculados a um cupom específico com paginação, busca por nome/email e filtros por status de uso. Inclui dados como nome, e-mail, status de uso do cupom e data de vinculação.
Verbo
GET
URL Base
https://api.soargi.com
Endpoint
/coupons/users/{coupon_id}?page=1&limit=12&search=&status=
Cabeçalhos
| Parâmetro | Valor |
|---|---|
| Authorization | Bearer Token |
Parâmetros de Query
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| page | int | Não | Número da página (padrão: 1) |
| limit | int | Não | Registros por página (padrão: 12) |
| search | string | Não | Busca por nome ou email |
| status | string | Não | Filtro por status de uso (yes/no) |
Sucesso - 200
{
"success": true,
"message": "Users retrieved successfully.",
"page": 1,
"limit": 12,
"total": 2,
"data": [
{
"user_id": "12",
"first_name": "John",
"last_name": "Doe",
"email": "joao@email.com",
"used": "no",
"created_at": "2025-01-15 10:00:00"
},
{
"user_id": "34",
"first_name": "Marie",
"last_name": "Stone",
"email": "maririe@email.com",
"used": "yes",
"created_at": "2025-01-14 15:30:00"
}
]
}Erro - 404 (Nenhum usuário encontrado para cupom buscado)
{
"status": 404,
"error": 404,
"messages": {
"error": "No users found for this coupon."
}
}Códigos de Resposta
- 200 - Lista de usuários retornada com sucesso
- 404 - Nenhum usuário encontrado para o cupom