ConnectCloud Developers

A delivery with its attempts (comms:read)

GET /api/comms/v1/deliveries/{id}

Module: Comms · operationId: getDelivery · Tag: Delivery log · Auth: access token (Authorization: Bearer <accessToken>)

Parameters

Name In Type Required Description
id path string (uuid) yes

Responses

  • 200 Delivery (application/json)
  • 404 Error (application/json)

Fields of the 200 answer:

  • attempts (integer): Number of send attempts so far
  • channelId (string (uuid)): Channel the delivery is sent on
  • channelName (string): Name of the channel
  • createdAt (string (date-time)): Creation time
  • feedback (string): What the provider (Amazon SES) reported after accepting the mail; a hard bounce or complaint also suppresses the address (one of delivered, delay, bounced, complaint)
  • feedbackAt (string (date-time)): When the provider's feedback arrived
  • feedbackDetail (string): Detail of the provider's feedback (e.g. the bounce reason)
  • id (string (uuid)): Delivery id
  • lastError (string): Error message of the last failed attempt
  • lastErrorCode (string): Error code of the last failed attempt
  • medium (string): Medium of the channel (email, webhook, teams, push)
  • messageId (string (uuid)): The message the delivery belongs to
  • nextAttemptAt (string (date-time)): When the next attempt is due
  • origin (string): api, job, test, subscription or event_push
  • recipient (string): Recipient address or webhook target
  • recipientKind (string): person, distribution (a shared mailbox) or channel (a webhook)
  • recipientName (string): Display name of the recipient
  • sentAt (string (date-time)): When the provider accepted the delivery
  • status (string): held waits for the recipient's digest or the end of an absence; bundled was sent inside a digest; suppressed with code opted_out was switched off by the recipient (one of queued, sending, retry, sent, dead, suppressed, expired, cancelled, held, bundled)
  • subject (string): Rendered subject
  • subscriptionId (string): The personal subscription the message was sent for (origin subscription)
  • subscriptionName (string): Its name while it exists
  • template (string): Template key of the message
  • updatedAt (string (date-time)): Time of the last change
  • attemptLog (array of object): The recorded send attempts
    • attempt (integer): Number of the attempt, from 1
    • durationMs (integer): Duration in milliseconds
    • error (string): Error message of a failed attempt
    • errorCode (string): Error code of a failed attempt
    • httpStatus (integer): HTTP status the provider answered
    • outcome (string): Result of the attempt (one of sent, transient, rate_limited, permanent, misconfigured)
    • startedAt (string (date-time)): Start of the attempt
  • correlationId (string): Correlation id the sender passed with the message
  • expiresAt (string (date-time)): After this time the message is no longer sent
  • purged (boolean): The message content was removed (action links)

Example 200 answer:

{
  "attemptLog": [
    {
      "attempt": 1,
      "durationMs": 384,
      "outcome": "sent",
      "startedAt": "2026-11-17T09:41:06Z"
    }
  ],
  "attempts": 1,
  "channelId": "6b1f3c2a-8d4e-4f5a-9b7c-1e2d3f4a5b6c",
  "channelName": "Plattform-E-Mail",
  "correlationId": "hr.absence:5a1c7e3b-9d2f-4b6a-8e4c-3f1a2b9c7d6e",
  "createdAt": "2026-11-17T09:41:05Z",
  "expiresAt": "2026-11-20T09:41:05Z",
  "feedback": "delivered",
  "feedbackAt": "2026-11-17T09:41:09Z",
  "id": "2f8a6c1e-4b3d-4e5f-a7b9-0c1d2e3f4a5b",
  "medium": "email",
  "messageId": "7d3e9f1a-2b4c-4d5e-8f6a-9b0c1d2e3f4a",
  "origin": "api",
  "purged": false,
  "recipient": "lena.vogel@muster-it.example",
  "recipientKind": "person",
  "recipientName": "Lena Vogel",
  "sentAt": "2026-11-17T09:41:07Z",
  "status": "sent",
  "subject": "Abwesenheit genehmigt: Lena Vogel (23.12.2026 – 02.01.2027)",
  "template": "hr.absence.approved",
  "updatedAt": "2026-11-17T09:41:09Z"
}

Example request

curl -X GET 'https://api.mbcom.cloud/api/comms/v1/deliveries/3f2b8c1e-7d4a-4e9b-9c2a-5b1d6e8f0a12' \
  -H "Authorization: Bearer $ACCESS_TOKEN"

View as Markdown · Interactive reference · OpenAPI