Document pickup

List unacknowledged document deliveries

Opt-in polling fallback for systems without an inbound HTTPS endpoint. Webhooks remain the preferred delivery mechanism and continue independently.

GET/api/document-deliveries

List unacknowledged document deliveries

curl --request GET \
  --url 'https://app.output.rocks/api/document-deliveries?limit=100' \
  --header 'X-AUTH-TOKEN: <api-key>'

200

application/json

{
  "items": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "processId": 123,
      "renderingRequestId": 123,
      "componentType": "document",
      "externalReference": "string",
      "subClientId": 123,
      "fileName": "Example name",
      "format": "2024-08-23T00:00:00+00:00",
      "mimeType": "string",
      "size": 1,
      "sha256": "string",
      "availableAt": "2024-08-23T00:00:00+00:00",
      "availableUntil": "2024-08-23T00:00:00+00:00",
      "downloadUrl": "https://example.com",
      "ackUrl": "https://example.com"
    }
  ],
  "nextCursor": "string"
}

Authorizations

X-AUTH-TOKEN

stringheaderrequired

Value for the X-AUTH-TOKEN header parameter.

Query Parameters

limit

integerdefault:100

No description provided.

cursor

string

Opaque cursor valid for the current snapshot scan.

subClientId

integer

Optional sub-client scope for a main-client token.

Response

200application/json

Open document deliveries in a stable snapshot.

items

object[]required

nextCursor

string | nullrequired