List extractions

Returns a page of extraction summaries. Use Get extraction for full output.

Filter with labels[key]=value; multiple labels use AND. See Filter by labels for examples.

Authentication

Authorizationstring

Use the API key format: api-key <token>.

Query parameters

pageintegerOptional>=0Defaults to 0

Zero-based page index. Defaults to 0.

sizeintegerOptional1-100Defaults to 50
Page size between 1 and 100. Defaults to 50.
statusenumOptional
Filter by extraction status.
Allowed values:
fromdatetimeOptional

Return extractions created at or after this UTC ISO-8601 timestamp.

todatetimeOptional

Return extractions created at or before this UTC ISO-8601 timestamp.

sortByenumOptional
Field used to sort the list. Defaults to createdAt.
Allowed values:
sortenumOptional
Sort direction. Defaults to desc.
Allowed values:
labelsmap from strings to stringsOptional
Filter with `labels[key]=value`. - An empty value matches extractions that contain the label. - Multiple labels are combined with AND. - Example: `?labels[docType]=YOUR_CONFIGURED_DOCUMENT_TYPE&labels[customerDocumentId]=doc-42`.

Response

One page of extractions, without the full output.

datalist of objectsOptional
Items on the requested page.
pageInfoobjectOptional
Paging details for this result set.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
405
Method Not Allowed Error
406
Not Acceptable Error
409
Conflict Error
429
Too Many Requests Error
500
Internal Server Error
502
Bad Gateway Error