> ## Documentation Index
> Fetch the complete documentation index at: https://docs.basaltic.sh/llms.txt
> Use this file to discover all available pages before exploring further.

# Listar registros de entrega

> Diagnóstico de entregas: cada registro inclui quantidade de tentativas, último status HTTP e último erro.

<Info>
  Exige a ação IAM **`notifications:ListDeliveries`**. Veja [NOTIFICATIONS permissões](/pt/notifications/permissions) para a lista completa, o escopo de cada ação e um exemplo de política.
</Info>


## OpenAPI

````yaml /pt/api-reference/specs/notifications.yaml get /v1/topics/{topic_id}/deliveries
openapi: 3.0.3
info:
  title: API Basaltic Notifications
  version: 1.0.0
  description: >-
    Tópicos de publicação e assinatura com entrega por email, webhook e fila.
    Publicar distribui a mensagem a cada assinatura confirmada cujo filtro
    corresponda.


    A publicação é assíncrona: 202 confirma armazenamento e enfileiramento, não
    entrega. Consulte `GET /v1/topics/{topic_id}/messages/{message_id}` para o
    estado de distribuição e `GET /v1/topics/{topic_id}/deliveries?message=...`
    para resultados por destino.


    Email e webhooks começam em `pending_confirmation` e recebem um token: link
    por email ou POST `subscription_confirmation`. A janela é de 72 horas;
    assinaturas não confirmadas são removidas depois. `POST
    /v1/topics/{topic_id}/subscriptions/{id}/resend-confirmation` gera outro
    token; somente o hash é armazenado.


    Webhooks precisam de endereços públicos. Loopback, RFC1918, link-local e
    unique-local são recusados na assinatura e na entrega. Cada POST inclui
    `X-Basaltic-Signature: v1,t=<unix-seconds>,s=<hex>`, um HMAC-SHA256 sobre
    `"<t>.<raw-request-body>"` com o segredo da assinatura. O segredo é
    retornado na criação e pode ser consultado no endpoint próprio. Verifique o
    corpo original, sem serializá-lo novamente, e rejeite timestamps com mais de
    cinco minutos de diferença.
  contact:
    name: Basaltic Support
    email: ping@basaltic.sh
  license:
    name: Proprietary
    url: https://basaltic.sh/terms
servers:
  - url: https://notifications.{region}.basaltic.sh
    description: Endpoint de API regional
    variables:
      region:
        default: sa-saopaulo-1
        description: Código de região
security:
  - BearerAuth: []
tags:
  - name: Topics
    description: Tópicos de distribuição
  - name: Subscriptions
    description: Assinaturas de destinos e confirmação
  - name: Messages
    description: Publicação e status de entrega
  - name: Confirmations
    description: Ações sem autenticação do proprietário do destino
paths:
  /v1/topics/{topic_id}/deliveries:
    parameters:
      - $ref: '#/components/parameters/TopicId'
    get:
      tags:
        - Messages
      summary: Listar registros de entrega
      description: >-
        Diagnóstico de entregas: cada registro inclui quantidade de tentativas,
        último status HTTP e último erro.
      operationId: listDeliveries
      parameters:
        - name: crn
          in: query
          description: >-
            Identidade exata message/UUID/delivery/UUID. CRNs de outro escopo
            retornam página vazia; CRNs malformados são inválidos.
          schema:
            type: string
            example: >-
              crn:notifications:sa-saopaulo-1:acme:message/019400aa-bbbb-7ccc-8ddd-eeeeffff0000/delivery/c3d4e5f6-7a8b-4c9d-8e0f-1a2b3c4d5e6f
        - name: message
          in: query
          description: >-
            Restringe a uma mensagem publicada. Resolvida antes da listagem: ID
            desconhecido retorna 404. Aceita UUID ou CRN, nunca nome simples.
          schema:
            type: string
            example: 019400aa-bbbb-7ccc-8ddd-eeeeffff0000
        - name: subscription
          in: query
          description: >-
            Restringe a uma assinatura por UUID ou CRN aninhado
            topic/name/subscription/UUID. Nomes simples são inválidos.
          schema:
            type: string
            example: b2c3d4e5-6f7a-4b8c-9d0e-1f2a3b4c5d6e
        - name: status
          in: query
          schema:
            type: string
            enum:
              - pending
              - delivered
              - failed
            example: failed
        - $ref: '#/components/parameters/Marker'
        - $ref: '#/components/parameters/Limit'
      responses:
        '200':
          description: Lista paginada de registros de entrega.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeliveryListResponse'
        '400':
          description: Status, referência de mensagem/assinatura ou marcador UUID inválido.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          description: >-
            O tópico não existe nesta conta ou o filtro `message` ou
            `subscription` identifica um recurso de outra conta.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  parameters:
    TopicId:
      name: topic_id
      in: path
      required: true
      schema:
        type: string
        format: uuid
        example: a1b2c3d4-5e6f-4a7b-8c9d-0e1f2a3b4c5d
    Marker:
      name: marker
      in: query
      description: ID do último item da página anterior.
      schema:
        type: string
        format: uuid
        example: a1b2c3d4-5e6f-4a7b-8c9d-0e1f2a3b4c5d
    Limit:
      name: limit
      in: query
      description: >-
        Número máximo de itens a devolver. Um valor maior é fixado ao máximo em
        vez de rejeitado, então page until `meta.has_more` é false.
      schema:
        type: integer
        default: 50
        minimum: 1
        maximum: 200
        example: 50
  schemas:
    DeliveryListResponse:
      type: object
      required:
        - deliveries
      properties:
        deliveries:
          type: array
          items:
            $ref: '#/components/schemas/Delivery'
        meta:
          $ref: '#/components/schemas/PaginationMeta'
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
            - request_id
          properties:
            code:
              type: string
              description: Código de erro identificando o tipo de erro
              example: INVALID_INPUT
            message:
              type: string
              description: Mensagem de erro legível pelo ser humano
              example: Invalid request parameters
            params:
              type: object
              additionalProperties: true
              description: >-
                Valores não sensíveis opcionais para interpolação de erros
                localizados, codificados por código de erro. Nunca presente para
                erros de servidor.
              example:
                instances: 2
                pools: 0
            request_id:
              type: string
              format: uuid
              description: Solicitar ID para depuração
              example: 550e8400-e29b-41d4-a716-446655440000
    Delivery:
      type: object
      required:
        - id
        - crn
        - message
        - subscription
        - protocol
        - endpoint
        - status
        - attempts
        - created_at
      properties:
        crn:
          type: string
          description: CRN canônico message/UUID/delivery/UUID.
          example: >-
            crn:notifications:sa-saopaulo-1:acme:message/019400aa-bbbb-7ccc-8ddd-eeeeffff0000/delivery/c3d4e5f6-7a8b-4c9d-8e0f-1a2b3c4d5e6f
        id:
          type: string
          format: uuid
          example: c3d4e5f6-7a8b-4c9d-8e0f-1a2b3c4d5e6f
        message:
          $ref: '#/components/schemas/ResourceRef'
        subscription:
          $ref: '#/components/schemas/ResourceRef'
        protocol:
          type: string
          enum:
            - email
            - https
            - http
            - queue
          example: https
        endpoint:
          type: string
          description: Destino registrado na distribuição.
          example: https://hooks.example.com/basaltic
        status:
          type: string
          enum:
            - pending
            - delivered
            - failed
          example: delivered
        attempts:
          type: integer
          example: 2
        last_status_code:
          type: integer
          nullable: true
          description: >-
            Status HTTP da última tentativa. Ausente em falhas de transporte e
            entregas por email.
          example: 200
        last_error:
          type: string
          description: Truncado em 1024 caracteres.
          example: 'endpoint returned 503: upstream unavailable'
        created_at:
          type: string
          format: date-time
          example: '2026-01-18T11:45:01Z'
        last_attempt_at:
          type: string
          format: date-time
          nullable: true
          example: '2026-01-18T11:45:22Z'
        completed_at:
          type: string
          format: date-time
          nullable: true
          example: '2026-01-18T11:45:22Z'
    PaginationMeta:
      type: object
      properties:
        total:
          type: integer
          description: Número total de itens
          example: 150
        limit:
          type: integer
          description: Número de itens por página
          example: 20
        marker:
          type: string
          description: >-
            Cursor opaco para a próxima página. Passe-o de volta como o
            parâmetro de consulta `marker`; trate-o como um token, não um valor
            para analisar.
          example: 550e8400-e29b-41d4-a716-446655440000
        has_more:
          type: boolean
          description: Se há mais itens
          example: true
    ResourceRef:
      type: object
      required:
        - id
        - crn
      properties:
        id:
          type: string
          format: uuid
          example: 288aa1e9-bbf5-5584-bce9-6a688f06d8a1
        crn:
          type: string
          example: crn:catalog::platform:country/288aa1e9-bbf5-5584-bce9-6a688f06d8a1
        name:
          type: string
          description: >-
            Rótulo no momento da resposta: o nome do recurso, quando houver, ou
            seu rótulo legível (número de fatura, nome de exibição da conta).
            Ausente quando o destino não existe mais. Não é uma chave de
            consulta.
          example: Brazil
  responses:
    Unauthorized:
      description: Autenticação necessária ou token inválido
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: UNAUTHORIZED
              message: Authentication required
              request_id: 550e8400-e29b-41d4-a716-446655440000
    Forbidden:
      description: Permissões insuficientes
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: ACCESS_DENIED
              message: You don't have permission to perform this action
              request_id: 550e8400-e29b-41d4-a716-446655440000
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >+
        Um token bearer OAuth 2.0, enviado como `Authorization: Bearer <token>`.
        Esta é a forma recomendada de autenticação.


        Obtenha o token trocando o par de chaves de acesso de uma conta de
        serviço em `POST /v1/oauth/token` com `grant_type=client_credentials`.
        Esse é o fluxo padrão de credenciais de cliente; bibliotecas compatíveis
        com OAuth podem obter e renovar o token para você.


        ```

        curl -s -u "$KEY_ID:$SECRET" -d grant_type=client_credentials \
          https://iam.basaltic.sh/v1/oauth/token
        ```


        Os tokens duram uma hora por padrão. O mesmo par de chaves de acesso
        também serve como credencial AWS SigV4 para o endpoint de objetos
        compatível com S3, que aceita somente esse método de autenticação.


````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.