Skip to main content
GET

Descrição

Lista todas as indicações com filtros e paginação. Requer autenticação JWT.

Headers

Authorization
string
required
Token JWT no formato: Bearer

Query Parameters

email
string
Filtrar por email do indicador
status
string
Filtrar por status da indicação (active, pending, banned)
page
number
default:"1"
Número da página
limit
number
default:"20"
Número de itens por página (máximo: 100)
sort
string
default:"desc"
Ordenação: asc ou desc
sortField
string
default:"created_at"
Campo para ordenação

Response

success
boolean
Indica se a operação foi bem-sucedida
data
object

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

email
string

Filtrar por email do indicador

status
enum<string>

Filtrar por status

Available options:
active,
pending,
banned
page
number
default:1

Número da página

limit
number
default:20

Itens por página

Required range: x <= 100
sort
enum<string>
default:desc

Ordenação

Available options:
asc,
desc
sortField
string
default:created_at

Campo para ordenação

Response

200 - application/json

Lista de indicações

success
boolean
data
object