Listar eventos

GET

/v1/events

Do mais recente para o mais antigo, paginado por cursor: a resposta traz nextCursor, e você o devolve em cursor para buscar a página seguinte. Sem nextCursor, acabou.

Autorização

• Bearer

Parâmetros

Parâmetros de consulta

type

string

Só eventos deste tipo.

consumer

string

Só eventos deste Consumer, pelo externalId.

status

string

Só eventos com ao menos uma Entrega neste status: pending, processing, retrying, delivered, exhausted ou cancelled.

from

string formato: date-time

Publicados a partir deste instante (ISO 8601, inclusivo).

to

string formato: date-time

Publicados até este instante (ISO 8601, inclusivo).

cursor

string

O nextCursor da página anterior.

limit

integer | string formato: int32

/^-?(?:0|[1-9]\d*)$/

Itens por página, de 1 a 100. O padrão é 50.

Respostas

200

Sucesso.

Tipo de mídiaapplication/json

object

items

obrigatório

Array<object>

object

id

obrigatório

string

type

obrigatório

string

consumer

obrigatório

string

deliveries

obrigatório

integer | string formato: int32

/^-?(?:0|[1-9]\d*)$/

createdAt

obrigatório

string formato: date-time

nextCursor

obrigatório

null | string

Exemplo^gerado

{
  "items": [
    {
      "id": "example",
      "type": "example",
      "consumer": "example",
      "deliveries": 1,
      "createdAt": "2026-04-15T12:00:00Z"
    }
  ],
  "nextCursor": "example"
}

401

Chave de API ausente, inválida ou revogada.

422

status ou cursor inválido.

Tipo de mídiaapplication/problem+json

object

type

null | string

title

null | string

status

null | integer | string formato: int32

/^-?(?:0|[1-9]\d*)$/

detail

null | string

instance

null | string

Exemplo^gerado

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

429

Limite de requisições por segundo do plano, somado entre todas as chaves da organização.

Headers

Retry-After

integer

Segundos até a próxima janela.