Sign in
Documents

List documents

List documents with cursor-based pagination.

get/v1beta/documents

Query parameters

page_tokenstring

Opaque pagination token from a previous response. Pass next_page_token or prev_page_token from a previous response to continue pagination. Empty or omitted for the first page.

Example:eyJpZCI6ImRvY18wMWgyeGNlanF0ZjJuYnJleHgzdnFqaHA0MSIsImQiOiJuZXh0In0

Opaque pagination token from a previous response. Pass next_page_token or prev_page_token from a previous response to continue pagination. Empty or omitted for the first page.

page_sizeinteger

Maximum number of items to return per page (1-100). Default: 50.

Maximum number of items to return per page (1-100). Default: 50.

created_by_idstring[]

Filter by creator ID(s) (user or bot). Returns documents matching ANY of the specified IDs. REST: ?created_by_id=user_01h2xcejqtf2nbrexx3vqjhp41 or ?created_by_id=user_xxx&created_by_id=bot_yyy

Filter by creator ID(s) (user or bot). Returns documents matching ANY of the specified IDs. REST: ?created_by_id=user_01h2xcejqtf2nbrexx3vqjhp41 or ?created_by_id=user_xxx&created_by_id=bot_yyy

access_levelAccessLevel[]

Filter by access level(s). Returns documents matching ANY of the specified levels. REST: ?access_level=private or ?access_level=private&access_level=organization

Filter by access level(s). Returns documents matching ANY of the specified levels. REST: ?access_level=private or ?access_level=private&access_level=organization

processing_statusProcessingStatus[]

Filter by processing status(es). Returns documents matching ANY of the specified statuses. REST: ?processing_status=ready or ?processing_status=processing&processing_status=ready

Filter by processing status(es). Returns documents matching ANY of the specified statuses. REST: ?processing_status=ready or ?processing_status=processing&processing_status=ready

sortstring

Sort field and direction. Prefix with - for descending order. Allowed values: created_at, updated_at, name, last_viewed_at, last_shared_at. Default (omitted): created_at descending. REST: ?sort=last_viewed_at or ?sort=-name

Sort field and direction. Prefix with - for descending order. Allowed values: created_at, updated_at, name, last_viewed_at, last_shared_at. Default (omitted): created_at descending. REST: ?sort=last_viewed_at or ?sort=-name

querystring

Full-text search filter. Case-insensitive substring match on document name and description. REST: ?query=budget

Full-text search filter. Case-insensitive substring match on document name and description. REST: ?query=budget

ownershipDocumentOwnership[]

Ownership filter. Returns documents matching the specified ownership state. REST: ?ownership=owned or ?ownership=not_owned

Ownership filter. Returns documents matching the specified ownership state. REST: ?ownership=owned or ?ownership=not_owned

trash_stateDocumentTrashState[]

Trash state filter. Returns documents matching the specified trash state. REST: ?trash_state=active or ?trash_state=trashed or ?trash_state=active&trash_state=trashed Default (omitted): active documents only.

Trash state filter. Returns documents matching the specified trash state. REST: ?trash_state=active or ?trash_state=trashed or ?trash_state=active&trash_state=trashed Default (omitted): active documents only.

organization_scopeboolean

Organization scope filter. When true, restrict to documents within the user's organization. REST: ?organization_scope=true

Organization scope filter. When true, restrict to documents within the user's organization. REST: ?organization_scope=true

created.afterstring date-time

Filter by created.after (RFC 3339 format, e.g., 2024-01-15T09:30:00Z)

Response

Success

Example response

{
  "items": [
    {
      "created_by": {
        "id": "user_01h2xcejqtf2nbrexx3vqjhp41"
      },
      "current_version": {
        "id": "ver_01h2abcd1234efgh5678jkmnpt"
      },
      "description": "Quarterly financial report for Q4 2024",
      "id": "doc_01h2xcejqtf2nbrexx3vqjhp41",
      "title": "Q4 2024 Financial Report",
      "url": "https://app.factify.com/d/01h2xcejqtf2nbrexx3vqjhp41"
    }
  ],
  "pagination": {
    "next_page_token": "eyJpZCI6ImRvY18wMWgyeGNlanF0ZjJuYnJleHgzdnFqaHA0MSIsImQiOiJuZXh0In0",
    "prev_page_token": "eyJpZCI6ImRvY18wMWgyeGNlanF0ZjJuYnJleHgzdnFqaHA0MSIsImQiOiJwcmV2In0"
  }
}

Changes