GET
/
v1.0.1
/
file
/
jobs
curl --request GET \
  --url https://api.readfile.io/v1.0.1/file/jobs \
  --header 'X-API-KEY: <api-key>'
[
  {
    "strategy": "<string>",
    "job_id": "<string>",
    "file_name": "<string>",
    "status": "<string>",
    "timestamp": "2023-11-07T05:31:56Z",
    "elapsed_time_ms": 123
  }
]

Authorizations

​
X-API-KEY
string
header
required

Query Parameters

​
limit
integer
default:10
required

The number of jobs to return, sorted in timestamp order.

Response

200
application/json
Successfully retrieved jobs list
​
job_id
string
required

The identifier of your task on ReadFile.

​
status
string
required

The current state of your task on ReadFile.

​
strategy
string

The processing strategy used for the extraction.

​
file_name
string

The name of the file processed.

​
timestamp
string

The time the job was initiated

​
elapsed_time_ms
integer

The length of time the job took to complete, in milliseconds