Skip to main content

​
Endpoint

GET https://api.documind.cloud/api/v1/data/extractions

​
Authentication

Requires read:extractions scope.

​
Query Parameters

ParameterTypeDescription
skipintegerNumber of items to skip (default: 0)
limitintegerMaximum items to return (default: 100, max: 1000)
document_idstring (UUID)Filter by document ID
needs_reviewbooleanFilter by review status
is_reviewedbooleanFilter by reviewed state
created_afterstring (ISO date)Filter by creation date
created_beforestring (ISO date)Filter by creation date
sort_bystringField to sort by (default: created_at)
sort_orderstringSort order: asc or desc (default: desc)

​
Response

{
  "items": [
    {
      "id": "extraction-id",
      "document_id": "doc-id",
      "results": {...},
      "needs_review": false,
      "is_reviewed": false,
      "created_at": "2024-01-15T10:30:00Z"
    }
  ],
  "total": 150,
  "skip": 0,
  "limit": 100
}

​
Examples

# Get extractions needing review
response = requests.get(
    "https://api.documind.cloud/api/v1/data/extractions",
    headers={"X-API-Key": API_KEY},
    params={"needs_review": True}
)

# Poll for specific document
response = requests.get(
    "https://api.documind.cloud/api/v1/data/extractions",
    headers={"X-API-Key": API_KEY},
    params={"document_id": document_id}
)

​
Next Steps

Extract Data

Create new extractions

Understanding Reviews

Learn about the review workflow