PDF Monkey · Example Payload

List Documents

Example request and response for listing document cards with filtering and pagination.

PDFDocument GenerationTemplatesHandlebarsREST APIWebhooks

List Documents is an example object payload from PDF Monkey, with 4 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

titledescriptionrequestresponse

Example Payload

{
  "title": "List Document Cards Example",
  "description": "Example request and response for listing document cards with filtering and pagination.",
  "request": {
    "method": "GET",
    "url": "https://api.pdfmonkey.io/api/v1/document_cards?q[status]=success&page[number]=1",
    "headers": {
      "Authorization": "Bearer YOUR_API_KEY"
    }
  },
  "response": {
    "status": 200,
    "headers": {
      "Content-Type": "application/json"
    },
    "body": {
      "document_cards": [
        {
          "id": "d4e5f6a7-b8c9-0123-defa-234567890123",
          "app_id": "c3d4e5f6-a7b8-9012-cdef-123456789012",
          "created_at": "2024-06-13T14:35:00Z",
          "document_template_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
          "document_template_identifier": "invoice-template",
          "download_url": "https://cdn.pdfmonkey.io/documents/d4e5f6a7-b8c9-0123-defa-234567890123/download?token=signed_token",
          "failure_cause": null,
          "filename": "invoice-001.pdf",
          "meta": {
            "order_id": "ORD-789"
          },
          "output_type": "pdf",
          "preview_url": "https://cdn.pdfmonkey.io/documents/d4e5f6a7-b8c9-0123-defa-234567890123/preview",
          "public_share_link": null,
          "status": "success",
          "updated_at": "2024-06-13T14:35:07Z"
        },
        {
          "id": "e5f6a7b8-c9d0-1234-efab-345678901234",
          "app_id": "c3d4e5f6-a7b8-9012-cdef-123456789012",
          "created_at": "2024-06-12T10:00:00Z",
          "document_template_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
          "document_template_identifier": "invoice-template",
          "download_url": "https://cdn.pdfmonkey.io/documents/e5f6a7b8-c9d0-1234-efab-345678901234/download?token=signed_token",
          "failure_cause": null,
          "filename": "invoice-002.pdf",
          "meta": null,
          "output_type": "pdf",
          "preview_url": "https://cdn.pdfmonkey.io/documents/e5f6a7b8-c9d0-1234-efab-345678901234/preview",
          "public_share_link": null,
          "status": "success",
          "updated_at": "2024-06-12T10:00:08Z"
        }
      ],
      "meta": {
        "current_page": 1,
        "next_page": null,
        "prev_page": null,
        "total_pages": 1
      }
    }
  }
}