API ReferenceDocumentsList Documents

List Documents

GET /api/v1/documents/

Returns a paginated list of documents belonging to your organization.

Authentication

Requires an API key with documents:read scope. Pass via the X-API-Key header.

Response

Status: 200 OK

{
  "count": 42,
  "next": "https://api.parsifyhq.com/api/v1/documents/?page=2",
  "previous": null,
  "results": [
    {
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "filename": "payroll_journal_march.pdf",
      "file_size": 1048576,
      "checksum": "sha256:e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855",
      "created_at": "2026-03-16T12:00:00Z"
    }
  ]
}

Response Fields

FieldTypeDescription
countintegerTotal number of documents.
nextstring or nullURL for the next page of results.
previousstring or nullURL for the previous page of results.
resultsarrayList of document objects.

Document Object

FieldTypeDescription
idstring (UUID)Unique identifier for the document.
filenamestringOriginal filename of the uploaded document.
file_sizeintegerFile size in bytes.
checksumstringSHA-256 checksum of the file.
created_atstring (ISO 8601)Timestamp when the document was created.

Errors

StatusDescription
401Missing or invalid API key.
403API key does not have documents:read scope.

Code Examples

curl https://api.parsifyhq.com/api/v1/documents/ \
  -H "X-API-Key: YOUR_API_KEY"