Get documents

Use this endpoint to retrieve a list of all of your documents.

Each document result will have the following fields:

  • document id - this is the document id as a GUID
  • fileName - this is the file name of the document
  • status - the analysis status. Can be “NOT_ANALYZED” or “ANALYSIS_COMPLETE”
  • numberOfPages - the number of pages
  • uploadedDate - the UTC timestamp of the document uploaded datetime.

Endpoint

GET https://app.pdfdodo.com/api/documents
Retrieves all of your documents
Header
X-API-Key
string
Your API key. You can find this from the "Settings" page

Response

The response will be a JSON array of objects with HTTP response code 200.

[
    {
        "documentId": "a251b4c8-2373-4e52-823e-8a5717c01fd0",
        "fileName": "your file 01.pdf",
        "status": "NOT_ANALYZED",
        "numberOfPages": 12,
        "uploadedDate": "2023-10-20T22:34:52.984442+00:00"
    },
    {
        "documentId": "c45ba106-35dd-4e60-9330-8ed58676eb53",
        "fileName": "your file 02.pdf",
        "status": "NOT_ANALYZED",
        "numberOfPages": 37,
        "uploadedDate": "2023-10-20T22:34:37.772522+00:00"
    },
    {
        "documentId": "732190d7-ee68-4563-9659-1a2e87d98b3c",
        "fileName": "your file 03.pdf",
        "status": "ANALYSIS_COMPLETE",
        "numberOfPages": 3,
        "uploadedDate": "2023-10-20T12:52:11.886819+00:00"
    }    
]

Example request in curl

curl -X GET \
     -H "x-api-key: YOUR_API_KEY_HERE" \
     -H "Content-Type: application/json" \
     "https://app.pdfdodo.com/api/documents"