documentDeliveries

Requires at least one of the permissions settings:documents:read or settings:email:read.

Durable document-delivery outbox rows for this org, newest first.

Errors: a failed call returns a GraphQL errors entry, not a field on the result, and data may be null or partial. Read the entry's extensions.code and message; every shape and code is in the Error reference.

Example:

GraphQL

query DocumentDeliveries {
  documentDeliveries {
    total
    items {
      id
      documentNumber
      status
      createdAt
      attempts
      contentHash
    }
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query DocumentDeliveries {\n  documentDeliveries {\n    total\n    items {\n      id\n      documentNumber\n      status\n      createdAt\n      attempts\n      contentHash\n    }\n  }\n}"
}
EOF

Response:

{
  "data": {
    "documentDeliveries": {
      "total": 0,
      "items": [
        {
          "id": "string",
          "documentNumber": "string",
          "status": "DELIVERED",
          "createdAt": "2025-01-15T00:00:00Z",
          "attempts": 0,
          "contentHash": "string"
        }
      ]
    }
  }
}

documentDeliveries(
  skip: Int = 0
  status: OutboxDeliveryStatus
  take: Int = 25
): OutboxDeliveryPage!

Arguments

documentDeliveries.skip ● Int scalar

Number of records to skip. Send with take to page through results.

documentDeliveries.status ● OutboxDeliveryStatus enum

Only deliveries with this status.

documentDeliveries.take ● Int scalar

Number of records to return.

Type

OutboxDeliveryPage object

A page of outbound document emails.