Skip to main content
GET
Listar cupons

Authorizations

Authorization
string
header
required

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

Query Parameters

page
integer
default:1

Página desejada, começando em 1.

Required range: x >= 1
pageSize
integer
default:10

Quantidade de itens por página (máximo 100).

Required range: 1 <= x <= 100
active
enum<string>

Filtra por cupons ligados (true) ou desligados (false).

Available options:
true,
false
code
string

Filtra pelos cupons cujo código começa com este trecho.

Minimum string length: 1

Response

Página de cupons da empresa.

Página de cupons da empresa.

success
boolean
required

Sempre true em uma resposta bem-sucedida.

data
object[]
required
pagination
object
required