APG PayAPG Paydocs

Operations

List queue dead letters

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

Return the messages this queue's consumers could not handle, newest first.

Permissions

Required permission
queues:query

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

Path parameters

queueIdstring
required

Query parameters

pageinteger (int32)

1-based page number.

limitinteger (int32)

Maximum items per page.

consumerstring

Only the messages this consumer group could not handle.

Responses

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

Discriminated by type
type = "QueuedlqPageAttributes"
hasMorebooleanrequired

Whether further items exist after this page.

Example true

nextStartingAfterstring

Id to pass as startingAfter to fetch the next page. Present in cursor mode only.

totalCountinteger (int64)

Total items matching the query.

Example 42

pageinteger (int32)

The 1-based page returned. Present in offset mode only.

Example 1250

totalPagesinteger (int32)

Total pages available. Present in offset mode only.

Example 1250

Example
{
  "type": "QueuedlqPageAttributes",
  "data": [
    {
      "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"
      }
    }
  ],
  "hasMore": true,
  "nextStartingAfter": "string",
  "totalCount": 42,
  "page": 1250,
  "totalPages": 1250
}

Error responses