APG PayAPG Paydocs

Operations

Get queue dead letter

GET/queues/{queueId}/dead-letters/{deadLetterId}
Request
GEThttps://api.tst.au.apgpay.dev/queues/{queueId}/dead-letters/{deadLetterId}
curl -X GET https://api.tst.au.apgpay.dev/queues/{queueId}/dead-letters/{deadLetterId} \
  -H "Authorization: Bearer $API_KEY"

Return one dead letter, with the message exactly as it was published. A deadLetter that does not belong to this queue is a 404, not a redirect.

Permissions

Required permission
queues:query

Requires the `query` action on `queues` for the supplied runtime context

Path parameters

queueIdstring
required
deadLetterIdstring
required

Responses

The response is a tagged shape: type is always "QueueDeadLetterAttributes". Switch on it; subtypes can be added, and a client that already reads it will not break.

Discriminated by type
type = "QueueDeadLetterAttributes"
queueDeadLetterIdstringrequired
queuestringrequired

The queue it was published to.

consumerstringrequired

The group that could not handle it. Never a single member: members come and go, the group does not.

diedAtstring (date-time)required

When it was given up on.

Example 2026-08-19T04:21:07Z

reasonstring

Why, as the consumer reported it. Absent when nothing said.

Example Requested by the customer.

eventIdinteger (int64)required

The queue's own id for the message, as it was when published.

Example 1250

publishedAtstring (date-time)required

When it was published, which with diedAt is how long it survived.

Example 2026-08-19T04:21:07Z

The message as published. Opaque here on purpose: what these fields mean belongs to whatever wrote them.

Example
{
  "type": "QueueDeadLetterAttributes",
  "queueDeadLetterId": "string",
  "queue": "string",
  "consumer": "string",
  "diedAt": "2026-08-19T04:21:07Z",
  "reason": "Requested by the customer.",
  "eventId": 1250,
  "publishedAt": "2026-08-19T04:21:07Z",
  "message": {
    "type": "QueueMessageAttributes",
    "eventType": "string",
    "data": "string",
    "extra1": "string",
    "extra2": "string",
    "extra3": "string",
    "extra4": "string"
  }
}

Error responses