PDF.co Web API (Application Programming Interface)

Get Your Free API Key

GET - https://api.pdf.co/v1/documents
Get all current user's documents data

Supported Formats

json

Errors

Code Description
401 unauthorized

Examples

GET /api/v1/documents
200
{
  "documents": [
    {
      "id": "bd2a126ae563e95827045a5faf040595cb09791db49400b125",
      "title": "Information_Technology_Professional_Services_Agreement.pdf",
      "created_at": "2017-12-02T15:44:26.463Z",
      "updated_at": "2017-12-03T15:52:39.892Z",
      "sender": {
        "id": "6b4de21ebd4db5cd",
        "name": "Brett Wheeler",
        "email": "brett@gmail.com"
      },
      "recipients": [
        {
          "name": "Alyssa French",
          "email": "alyssa@example.com",
          "invitation_url": "http://pdf.co/invite/71b90355552d29bc332f0bf2e24c90c32f54a6c1f9605dcfe2",
          "status": "completed",
          "id": "cb2dc3edd0a34a36"
        },
        {
          "name": "Super Company, Inc.",
          "email": "contracts@example.com",
          "invitation_url": "http://pdf.co/invite/2b12ad972c5238d6f9705d80f03131e38aa4572adcc4473cca",
          "status": "completed",
          "id": "2b45ecfa01363c9e"
        }
      ],
      "status": "completed"
    },
    {
      "id": "18371109fed2731366937e243792192846d4ea9485738303a9",
      "title": "contract-nda.pdf",
      "created_at": "2017-11-23T14:22:48.474Z",
      "updated_at": "2017-11-23T14:40:16.225Z",
      "sender": {
        "id": "6b4de21ebd4db5cd",
        "name": "Brett Wheeler",
        "email": "brett@example.com"
      },
      "recipients": [
        {
          "name": "Disclosing Party",
          "email": "client@example.com",
          "invitation_url": "http://pdf.co/invite/097a04d11d56f03f16b52254314a62fe08acefe752ee2280dc",
          "status": "completed",
          "id": "6b4de21ebd4db5cd"
        },
        {
          "name": "Receiving Party",
          "email": "freelancer@example.com",
          "invitation_url": "http://pdf.co/invite/64316ba3fb93e0c34225d7ff9a0bfd7b338d94155750fdd269",
          "status": "completed",
          "id": "c7b634b1ffac3308"
        }
      ],
      "status": "completed"
    },
    {
      "id": "ee0a44ff610c24cbb546d5904d642132979eff94e36591d34f",
      "title": "founders_agreement.docx",
      "created_at": "2017-10-13T18:06:48.789Z",
      "updated_at": "2017-10-13T21:51:15.878Z",
      "sender": {
        "id": "6b4de21ebd4db5cd",
        "name": "Disclosing Party",
        "email": "client@example.com"
      },
      "recipients": [
        {
          "name": "Kevin",
          "email": "kevin@example.com",
          "invitation_url": "http://pdf.co/invite/8a57f8870824948b77b2dc990af44c3bb10c5a14ab3a7ef614",
          "status": "completed",
          "id": "cf374b2c7e5c41ce"
        },
        {
          "name": "Wendy",
          "email": "wendy@example.com",
          "invitation_url": "http://pdf.co/invite/f69c50b7689fa9491283e36d1a994a096e8efbd1d32cc23a39",
          "status": "completed",
          "id": "5034ac41ce4532ab"
        },
        {
          "name": "Salvador",
          "email": "salvador@example.com",
          "invitation_url": "http://pdf.co/invite/34ad51c59e2acbbcf339159885860e88fb750f67b1a39f9787",
          "status": "completed",
          "id": "1dc654d2a7ab55c3"
        }
      ],
      "status": "completed"
    }
  ]
}

Supported Formats

json

Errors

Code Description
401 unauthorized
404 record not found

Examples

GET /api/v1/documents/b9d00ce740789717b3fa588684234d0e4ce8c667ad813945d9
200
{
  "document": {
    "id": "bd2a126ae563e95827045a5faf040595cb09791db49400b125",
    "title": "Information_Technology_Professional_Services_Agreement.pdf",
    "created_at": "2017-12-02T15:44:26.463Z",
    "updated_at": "2017-12-03T15:52:39.892Z",
    "executed_document_url": "https://pdf-user-files.s3-us-west-2.amazonaws.com/7b5dfd74b1f8e79073d95d17321f980583ab56803b24e1f6d2/206e227e0f8e45dcaa9aa5de7115197d/Information_Technology_Professional_Services_Agreement-signed-by-Alyssa%20Frenc...pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAJIIQVJKEFIER2WHA%2F20171203%2Fus-west-2%2Fs3%2Faws4_request&X-Amz-Date=20171203T155704Z&X-Amz-Expires=1200&X-Amz-SignedHeaders=host&X-Amz-Signature=113c6d7f71b9355bf13146e6da57895cd031e544d27a4bd5453f668b818f3779",
    "executed_document_hash": "cbc6e14e2b955ace22f2ef34ae3e96bd8147812aea376ae7c0219ae8859c3ea5",
    "fields": [
      {
        "role": "Client",
        "height": 63.33262935586062,
        "width": 130.5427666314678,
        "x": 46.853220696937704,
        "y": 725.4171066525871,
        "page": 1,
        "type": "signature",
        "name": "s1_s1",
        "transparent": true,
        "user_id": "2b45ecfa01363c9e"
      },
      {
        "role": "Contractor",
        "height": 63.33262935586062,
        "width": 130.5427666314678,
        "x": 416.5089757127772,
        "y": 717.9852164730729,
        "page": 1,
        "type": "signature",
        "name": "s2_s1",
        "transparent": true,
        "user_id": "cb2dc3edd0a34a36"
      },
      {
        "role": "Client",
        "height": 21.972544878563887,
        "width": 344.4519535374868,
        "x": 75.28827877507919,
        "y": 179.3347412882788,
        "page": 0,
        "type": "text",
        "name": "s1_t1",
        "transparent": true,
        "prefilled": "Brett Wheeler (CEO)",
        "user_id": "2b45ecfa01363c9e"
      },
      {
        "role": "Contractor",
        "height": 10.986272439281944,
        "width": 355.4382259767687,
        "x": 77.22703273495249,
        "y": 202.92291446673707,
        "page": 0,
        "type": "text",
        "name": "s2_t1",
        "transparent": true,
        "user_id": "cb2dc3edd0a34a36"
      },
      {
        "role": "Client",
        "height": 10.986272439281944,
        "width": 102.75395987328406,
        "x": 342.8363252375924,
        "y": 402.2914466737065,
        "page": 0,
        "type": "date",
        "name": "s1_d1",
        "transparent": true,
        "user_id": "2b45ecfa01363c9e"
      },
      {
        "role": "Client",
        "height": 10.986272439281944,
        "width": 113.74023231256601,
        "x": 68.17951425554382,
        "y": 414.24709609292506,
        "page": 0,
        "type": "date",
        "name": "s1_d2",
        "transparent": true,
        "user_id": "2b45ecfa01363c9e"
      }
    ],
    "include_certificate": true,
    "created_from": "api",
    "executed_at": "2017-12-03T15:52:39.871Z",
    "created_from_id": null,
    "sender": {
      "id": "6b4de21ebd4db5cd",
      "name": "Brett Wheeler (CEO)",
      "email": "brett@example.com"
    },
    "recipients": [
      {
        "name": "Alyssa French",
        "email": "alyssa@example.com",
        "invitation_url": "http://pdf.co/invite/71b90355552d29bc332f0bf2e24c90c32f54a6c1f9605dcfe2",
        "status": "completed",
        "id": "cb2dc3edd0a34a36"
      },
      {
        "name": "Super Company, Inc.",
        "email": "contracts@example.com",
        "invitation_url": "http://pdf.co/invite/2b12ad972c5238d6f9705d80f03131e38aa4572adcc4473cca",
        "status": "completed",
        "id": "2b45ecfa01363c9e"
      }
    ],
    "status": "completed",
    "audits": [
      {
        "user_id_from": "6b4de21ebd4db5cd",
        "user_id_to": null,
        "user_ip": null,
        "device_type": null,
        "browser": null,
        "browser_version": null,
        "os": null,
        "event_type": "document_created",
        "timestamp": "2017-12-02T15:44:26.000+00:00",
        "message": "Created the document"
      },
      {
        "user_id_from": "6b4de21ebd4db5cd",
        "user_id_to": null,
        "user_ip": null,
        "device_type": null,
        "browser": null,
        "browser_version": null,
        "os": null,
        "event_type": "invitation_created",
        "timestamp": "2017-12-02T15:44:26.000+00:00",
        "message": "Created the invitation for Alyssa French <alyssa@example.com>"
      },
      {
        "user_id_from": "6b4de21ebd4db5cd",
        "user_id_to": null,
        "user_ip": null,
        "device_type": null,
        "browser": null,
        "browser_version": null,
        "os": null,
        "event_type": "invitation_created",
        "timestamp": "2017-12-02T15:44:26.000+00:00",
        "message": "Created the invitation for Super Company, Inc. <contracts@example.com>"
      },
      {
        "user_id_from": "6b4de21ebd4db5cd",
        "user_id_to": null,
        "user_ip": null,
        "device_type": null,
        "browser": null,
        "browser_version": null,
        "os": null,
        "event_type": "invitation_sent",
        "timestamp": "2017-12-02T15:44:26.000+00:00",
        "message": "Invitation was sent to Super Company, Inc. <contracts@example.com>"
      },
      {
        "user_id_from": "6b4de21ebd4db5cd",
        "user_id_to": null,
        "user_ip": null,
        "device_type": null,
        "browser": null,
        "browser_version": null,
        "os": null,
        "event_type": "invitation_sent",
        "timestamp": "2017-12-02T15:44:27.000+00:00",
        "message": "Invitation was sent to Alyssa French <alyssa@example.com>"
      },
      {
        "user_id_from": "cb2dc3edd0a34a36",
        "user_id_to": null,
        "user_ip": "22.11.33.44",
        "device_type": "desktop",
        "browser": "Chrome",
        "browser_version": "62.0.3202.94",
        "os": "Mac",
        "event_type": "viewed",
        "timestamp": "2017-12-03T10:52:40.000+00:00",
        "message": "Document was viewed by Alyssa French <alyssa@example.com> from IP address 22.11.33.44 in Chrome 62.0.3202.94 browser for Mac 10.12.0 running on desktop"
      },
      {
        "user_id_from": "cb2dc3edd0a34a36",
        "user_id_to": null,
        "user_ip": "22.11.33.44",
        "device_type": "desktop",
        "browser": "Chrome",
        "browser_version": "62.0.3202.94",
        "os": "Mac",
        "event_type": "viewed",
        "timestamp": "2017-12-03T10:53:46.000+00:00",
        "message": "Document was viewed by Alyssa French <alyssa@example.com> from IP address 22.11.33.44 in Chrome 62.0.3202.94 browser for Mac 10.12.0 running on desktop"
      },
      {
        "user_id_from": "cb2dc3edd0a34a36",
        "user_id_to": null,
        "user_ip": "22.11.33.44",
        "device_type": "desktop",
        "browser": "Chrome",
        "browser_version": "62.0.3202.94",
        "os": "Mac",
        "event_type": "signed",
        "timestamp": "2017-12-03T10:56:39.000+00:00",
        "message": "Document was signed by Alyssa French <alyssa@example.com> from IP address 22.11.33.44 in Chrome 62.0.3202.94 browser for Mac 10.12.0 running on desktop"
      },
      {
        "user_id_from": "2b45ecfa01363c9e",
        "user_id_to": null,
        "user_ip": "44.44.22.11",
        "device_type": "smartphone",
        "browser": "Mobile Safari",
        "browser_version": "11.0",
        "os": "iOS",
        "event_type": "viewed",
        "timestamp": "2017-12-03T11:05:23.000+00:00",
        "message": "Document was viewed by Super Company, Inc. <contracts@example.com> from IP address 44.44.22.11 in Mobile Safari 11.0 browser for iOS 11.2 running on smartphone"
      },
      {
        "user_id_from": "2b45ecfa01363c9e",
        "user_id_to": null,
        "user_ip": "44.44.22.11",
        "device_type": "smartphone",
        "browser": "Mobile Safari",
        "browser_version": "11.0",
        "os": "iOS",
        "event_type": "viewed",
        "timestamp": "2017-12-03T15:51:46.000+00:00",
        "message": "Document was viewed by Super Company, Inc. <contracts@example.com> from IP address 44.44.22.11 in Mobile Safari 11.0 browser for iOS 11.2 running on smartphone"
      },
      {
        "user_id_from": "2b45ecfa01363c9e",
        "user_id_to": null,
        "user_ip": "44.44.22.11",
        "device_type": "smartphone",
        "browser": "Mobile Safari",
        "browser_version": "11.0",
        "os": "iOS",
        "event_type": "signed",
        "timestamp": "2017-12-03T15:52:26.000+00:00",
        "message": "Document was signed by Super Company, Inc. <contracts@example.com> from IP address 44.44.22.11 in Mobile Safari 11.0 browser for iOS 11.2 running on smartphone"
      },
      {
        "user_id_from": null,
        "user_id_to": null,
        "user_ip": null,
        "device_type": null,
        "browser": null,
        "browser_version": null,
        "os": null,
        "event_type": "document_completed",
        "timestamp": "2017-12-03T15:52:39.000+00:00",
        "message": "Finalized the document"
      }
    ]
  }
}

Params

Param name Description
id
required

Document id

  • Must be a String