Listar entregas

GET

/v1/deliveries

As Entregas do ambiente, da mais recente para a mais antiga, com o desfecho da última tentativa de cada uma.

É a listagem para responder “chegou?” sem abrir uma a uma: status diz em que pé está, e statusCode e durationMs dizem o que o endpoint respondeu e em quanto tempo. Filtre por status=exhausted para ver só o que desistiu, ou status=retrying para o que ainda está tentando.

Lista as duas direções. kind é outbound para o envio (Evento para Endpoint de um Consumer) e inbound para o repasse do recebimento (Mensagem de uma Fonte para um Destino). Filtre por kind para ver só uma.

Os campos acompanham a direção: name é o tipo do Evento no envio e o nome da Fonte no recebimento, target é sempre a URL que recebeu, e consumer só existe no envio.

Autorização

• Bearer

Parâmetros

Parâmetros de consulta

status

string

pending, processing, retrying, delivered, exhausted ou cancelled.

kind

string

outbound (envio) ou inbound (recebimento). Sem ele, as duas.

consumer

string

O externalId de um Consumer. Só faz sentido no envio.

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

endpoint

obrigatório

string

url

obrigatório

string

status

obrigatório

string

attemptCount

obrigatório

integer | string formato: int32

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

nextAttemptAt

obrigatório

null | string formato: date-time

deliveredAt

obrigatório

null | string formato: date-time

createdAt

obrigatório

string formato: date-time

nextCursor

obrigatório

null | string

Exemplo^gerado

{
  "items": [
    {
      "id": "example",
      "endpoint": "example",
      "url": "example",
      "status": "example",
      "attemptCount": 1,
      "nextAttemptAt": "2026-04-15T12:00:00Z",
      "deliveredAt": "2026-04-15T12:00:00Z",
      "createdAt": "2026-04-15T12:00:00Z"
    }
  ],
  "nextCursor": "example"
}

401

Chave de API ausente, inválida ou revogada.

422

Pedido inválido. O motivo vem em title.

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.