Buscar Usuários de um Cupom
Descrição
Busca usuários vinculados a um cupom específico por nome ou email. É necessário informar pelo menos 2 caracteres no parâmetro de busca. Suporta filtros por status de uso e paginação. Retorna 12 registros por página por padrão.
Verbo
GET
URL Base
https://api.soargi.com
Endpoint
/coupons/users/{coupon_id}?search=John&page=1&limit=12&status=
Cabeçalhos
| Parâmetro | Valor |
|---|---|
| Authorization | Bearer Token |
Parâmetros de Query
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| search | string | Sim | Busca por nome ou email (mínimo 2 caracteres) - OBRIGATÓRIO |
| page | int | Não | Número da página (padrão: 1) |
| limit | int | Não | Registros por página (padrão: 12) |
| status | string | Não | Filtro por status de uso (yes/no) |
Sucesso - 200
{
"success": true,
"message": "Users retrieved successfully.",
"page": 1,
"limit": 12,
"total": 1,
"data": [
{
"user_id": "12",
"first_name": "John",
"last_name": "Doe",
"email": "joao@email.com",
"used": "no",
"created_at": "2025-01-15 10:00:00"
}
]
}Erro - 422 (Termo de busca inválido)
{
"status": 422,
"error": "Please provide at least 2 characters to search."
}Erro - 404 (Nenhum usuário encontrado)
{
"status": 404,
"error": "No users found for this coupon."
}Erro - 500 (Erro interno do servidor)
{
"status": 500,
"error": "Failed to fetch users."
}Códigos de Resposta
- 200 - Usuários encontrados com sucesso
- 422 - Termo de busca inválido
- 404 - Nenhum usuário encontrado para o cupom
- 500 - Erro inesperado ao buscar