Skip to main content
GET
/
v1
/
documents
List documents
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.factify.com/v1/documents', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
{
  "documents": [
    {
      "id": "doc_01h2xcejqtf2nbrexx3vqjhp41",
      "org_id": "org_01h2xcejqtf2nbrexx3vqjhp41",
      "title": "Q4 Financial Report",
      "is_demo": false,
      "created_at": "2025-01-15T10:30:00Z",
      "updated_at": "2025-01-15T10:35:00Z",
      "created_by": {
        "id": "usr_01h2xcejqtf2nbrexx3vqjhp41",
        "name": "Alice Chen"
      },
      "url": "https://app.factify.com/documents/doc_01h2xcejqtf2nbrexx3vqjhp41",
      "description": "<string>",
      "current_version": {
        "id": "ver_01h2xcejqtf2nbrexx3vqjhp41",
        "created_at": "2025-01-15T10:30:00Z"
      },
      "trashed_at": "2023-11-07T05:31:56Z",
      "last_viewed_at": "2023-11-07T05:31:56Z",
      "shared_at": "2023-11-07T05:31:56Z",
      "thumbnail_url": "<string>",
      "capabilities": {
        "attach_policy": true,
        "comment_private": true,
        "comment_public": true,
        "copy_content": true,
        "create_version": true,
        "export": true,
        "grant_access": true,
        "list_versions": true,
        "manage_access": true,
        "open": true,
        "screenshot": true,
        "trash": true,
        "view": true,
        "view_analytics": true,
        "view_leads": true,
        "view_timeline": true
      },
      "current_version_full": {
        "id": "ver_01h2xcejqtf2nbrexx3vqjhp41",
        "document_id": "doc_01h2xcejqtf2nbrexx3vqjhp41",
        "created_at": "2025-01-15T10:30:00Z",
        "created_by": {
          "id": "usr_01h2xcejqtf2nbrexx3vqjhp41",
          "name": "Alice Chen"
        },
        "status_error": "unsupported file format"
      }
    }
  ],
  "next": "https://api.factify.com/v1/documents?page_size=20&page_token=doc_01h2xcejqtf2nbrexx3vqjhp41"
}

Documentation Index

Fetch the complete documentation index at: https://developers.factify.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Bearer authentication using a factapi-issued API key (ffy_<env>_<base32_uuid><base62_random>). Cookie-based sessions are accepted automatically by user-facing endpoints but are not surfaced as an OpenAPI auth scheme.

Query Parameters

​
page_size
integer<int64>
default:20

Items per page

Required range: 1 <= x <= 100
Example:

20

​
page_token
string

Cursor for next page

​
processing_status
enum<string>[]

Filter by processing status. Repeat the parameter to match any of several statuses. Alias: status (deprecated, prefer processing_status).

Lifecycle state of a document version's ingestion pipeline.

Available options:
pending,
processing,
ready,
failed
Example:
["ready"]
​
status
enum<string>[]

Deprecated alias for processing_status. When both are supplied, values are merged.

Lifecycle state of a document version's ingestion pipeline.

Available options:
pending,
processing,
ready,
failed
​
sort
string

Sort order. Prefix with - for descending. Supported fields: created_at (default descending), title. Example: title sorts by title ascending, -created_at sorts by creation time descending.

Example:

"-created_at"

​
query
string

Free-text search across document titles. Case-insensitive substring match (ILIKE).

Maximum string length: 200
Example:

"quarterly report"

​
ownership
enum<string>[]

Filter by document ownership relative to the caller. Repeat to combine values (OR semantics). mine returns documents created by the caller; shared returns documents the caller can view but did not create; org returns all documents in the organization (default when omitted).

Ownership filter for listDocuments. mine = created by the caller; shared = accessible to the caller but not created by them; org = all documents in the organization (no ownership filter).

Available options:
mine,
shared,
org
​
trashed
boolean
default:false

Include trashed documents alongside non-trashed ones. Ignored when trashed_only=true.

Example:

false

​
trashed_only
boolean
default:false

Return only trashed documents. Overrides trashed.

Example:

false

Response

OK

​
documents
object[]
required
​
next
string<uri>

Absolute URL of the next page, opaque to the client. Issue a GET against this URL with the same authentication to fetch the next page; absent or empty when there are no more results. SDK iterators read this field via x-speakeasy-pagination on the operation. URL-based pagination per FOLLOWUPS #12 — the cursor and any preserved filter query params are encoded in the URL.

Example:

"https://api.factify.com/v1/documents?page_size=20&page_token=doc_01h2xcejqtf2nbrexx3vqjhp41"