Skip to main content
GET
/
v1
/
documents
Get Documents
curl --request GET \
  --url https://api.simplicity.ai/v1/documents \
  --header 'X-API-Key: <api-key>'
{
  "page": 123,
  "total_pages": 123,
  "documents": [
    {
      "document_id": "<string>",
      "file_key": "<string>",
      "extension": "<string>",
      "original_filename": "<string>",
      "document_type": "SOURCE_DOCUMENT",
      "original_document_url": "<string>",
      "presigned_url": "<string>",
      "metadata": {
        "title": "<string>",
        "keywords": [
          "<string>"
        ],
        "total_pages": 123,
        "file_size": 123,
        "file_type": "PDF"
      },
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ]
}

Authorizations

​
X-API-Key
string
header
required

Query Parameters

​
page
integer
default:1
Required range: x >= 1
​
page_size
integer
default:10
Required range: 1 <= x <= 100
​
document_type
string | null
​
file_type
string | null
​
start_date
string<date-time> | null
​
end_date
string<date-time> | null
​
search
string | null
​
include_form_documents
boolean
default:false
​
order
string
default:desc

Response

Successful Response

​
page
integer
required
​
total_pages
integer
required
​
documents
DocumentResponse · object[]
required