Pular para o conteúdo principal
GET
Listar campanhas

Parâmetros de consulta

limit
integer<int64>

Número de registros a serem retornados

Exemplo:

50

offset
integer<int64>

Número do começo de registros a serem retornados.

Nota: Limitado a 10.000 registros. Recomendamos a utilização do keyset para paginação continua.

Exemplo:

0

keyset
string

Identificador usado para paginação baseada em cursor.

Nota: Somente será considerado caso o valor do campo offset seja 0.

Exemplo:

"cGl0OmJXRnBibDlwYm1SbGVDNXdjbWx0WVhKNTpbMTcwMDAwMDAwMDAwMF0="

term
string

Termo da pesquisa

Exemplo:

"Dia das mães"

startsBefore
string<date-time>

Filtra pela data de início da vigência igual ou inferior.

É esperada uma string de timestamp no formato RFC3339.

Exemplo:

"2024-06-05T09:00:00-03:00"

startsAfter
string<date-time>

Filtra pela data de início da vigência igual ou superior.

É esperada uma string de timestamp no formato RFC3339.

Exemplo:

"2024-06-05T09:00:00-03:00"

endsBefore
string<date-time>

Filtra pela data de término da vigência igual ou inferior.

É esperada uma string de timestamp no formato RFC3339.

Exemplo:

"2030-06-05T23:59:59-03:00"

endsAfter
string<date-time>

Filtra pela data de término da vigência igual ou superior.

É esperada uma string de timestamp no formato RFC3339.

Exemplo:

"2030-06-05T23:59:59-03:00"

features
enum<string>[]

Filtra pelos recursos para a campanha

Opções disponíveis:
coupons,
referrals,
loyalty,
giveaways
Exemplo:
tags
string[]

Filtra pelas tags das campanhas

Exemplo:
states
enum<string>[]

Filtra pelos estados das campanhas

Opções disponíveis:
draft,
enabled,
disabled,
archived
Exemplo:
statuses
enum<string>[]

Filtra pelas situações das campanhas

Opções disponíveis:
draft,
disabled,
archived,
scheduled,
running,
expired
Exemplo:

Resposta

OK

data
object[] | null
read-only
pagination
object