List Extractions
List extraction results with optional filters by document, schema, and status. Supports pagination for browsing large extraction sets.
An extraction is the result of applying a schema to a document. A single document can have multiple extractions if different schemas are applied to it.
Use this endpoint to browse extraction results across your organization. Filter by document, status, or time range to find specific results. Each extraction summary includes an overall confidence score and links to the full result.
Extractions are returned in descending order by
created_at by default. Use the after and before parameters to narrow results to a specific time window.GET
/v1/extractionsResponse
Response fields
dataarrayArray of extraction summary objects.
data[].idstringExtraction UUID.
data[].statusstringExtraction status: complete, processing, failed.
data[].document_idstringID of the source document.
data[].document_filenamestringFilename of the source document.
data[].confidence_overallnumberOverall confidence score (0–1) across all extracted fields.
data[].created_atstringISO 8601 creation timestamp.
data[].linksobjectRelated resource URLs: self, document.
pagination.totalintegerTotal number of extractions matching the query.
pagination.limitintegerMaximum results per page.
pagination.has_morebooleanWhether more results exist beyond this page.
pagination.next_cursorstring | nullCursor to fetch the next page. Null if no more results.
Response
{
"data": [
{
"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"status": "complete",
"document_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"document_filename": "invoice-0847.pdf",
"confidence_overall": 0.94,
"created_at": "2024-09-14T10:33:12.000Z",
"links": {
"self": "/v1/extractions/a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"document": "/v1/documents/a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}
}
],
"pagination": {
"total": 89,
"limit": 20,
"has_more": true,
"next_cursor": "eyJpZCI6ImExYjJjM2Q0IiwiY3JlYXRlZEF0IjoiMjAyNC0wOS0xNFQxMDozMzoxMloifQ=="
}
}Errors
Error responses
401unauthorizedMissing or invalid API key.
429rate_limitedToo many requests. Retry after the period indicated in the Retry-After header.