EndpointsExtract

List Extract Runs

List all extract runs.

Returns a summary of each run. Use GET /extract_runs/{id} to retrieve the full object including output and config.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Headers

x-extend-api-version"2026-02-09"Optional

API version to use for the request. If you’re using an SDK, you can ignore this parameter. If you are not using an SDK and do not specify a version, you will either receive a 400 Bad Request or be set to a previous legacy version. See API Versioning for more details.

Query parameters

statusenumOptional
The status of a processor run (extract, classify, or split): * `"PROCESSING"` - The run is in progress * `"PROCESSED"` - The run completed successfully * `"FAILED"` - The run failed * `"CANCELLED"` - The run was cancelled
Allowed values:
extractorIdstringOptional

Filters extract runs by the extractor ID. If not provided, all extract runs are returned.

Example: "ex_BMdfq_yWM3sT-ZzvCnA3f"

sourceIdstringOptional
Filters runs by the source ID.
sourceenumOptional
Filters runs by the source that created them. If not provided, runs from all sources are returned.
fileNameContainsstringOptional

Filters runs by the name of the file. Only returns runs where the file name contains this string.

Example: "invoice"

sortByenumOptionalDefaults to updatedAt
Sort by the given field.
Allowed values:
sortDirenumOptionalDefaults to desc
Sort in ascending or descending order. Ascending order means the earliest result is returned first.
Allowed values:
nextPageTokenstringOptional

The token used to fetch the page of results from a previous request. We use cursor based pagination and will return a nextPageToken in the response if there are more results.

Note that if other parameters are changed in subsequent requests, you may receive inconsistent data.

maxPageSizeintegerOptional1-1000Defaults to 10
The maximum number of results to return in the response. You may receive less than this number if there are fewer results than the maximum.

Response

You will get a list of summaries for each extract run. These are shortened versions of the full extract run object.

To get the full object, use the Get Extract Run endpoint.

objectenum
Allowed values:
datalist of objects
nextPageTokenstring or null

The token used to fetch the page of results from a previous request. We use cursor based pagination and will return a nextPageToken in the response if there are more results.

Note that if other parameters are changed in subsequent requests, you may receive inconsistent data.

Errors