Document AI — Import & Migration

List import files

Return the paginated file list for an import job.

post/import/import-files

Request

  • Base URL: https://api.paperoffice.ai/latest
  • URL: https://api.paperoffice.ai/latest/import/import-files
  • Auth: HTTP bearer

Request body

job_idinteger required

Import job ID whose file list is returned.

skipinteger

0-based offset into the merged live + snapshot file list. When set (including 0), skip wins over page.

limitinteger

Page size (default 50, max 500).

pageinteger

1-based page (used when skip is omitted). Offset = (page-1)*limit.

status'pending' | 'downloading' | 'processing' | 'completed' | 'failed' | 'skipped' | 'imported'

Optional file-status filter: pending, downloading, processing, completed, failed, skipped. Alias imported = completed.

Response

Success

status'success' | 'error'

Request status (ok/error)

messagestring

Status message

processing_timestring

Request processing time (e.g. "123.45ms")

datastring

Data

totalstring

Total

pagestring

Page

limitstring

Limit

total_pagesstring

Total pages

job_idstring

Job id

files_skippedstring

Files skipped

retried_filesstring

Retried files

Changes

No recorded changes to this operation across all 1 revision of this API.