List Extractions

Endpoint

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

Authentication

Requires extractions:read scope.

Query Parameters

Parameter	Type	Description
`skip`	integer	Number of items to skip (default: 0)
`limit`	integer	Maximum items to return (default: 100, max: 1000)
`document_id`	string (UUID)	Filter by document ID
`needs_review`	boolean	Filter by review status
`is_reviewed`	boolean	Filter by reviewed state
`created_after`	string (ISO date)	Filter by creation date
`created_before`	string (ISO date)	Filter by creation date
`sort_by`	string	Field to sort by (default: `created_at`)
`sort_order`	string	Sort order: `asc` or `desc` (default: `desc`)

Response

{
  "items": [
    {
      "id": "extraction-id",
      "document_id": "doc-id",
      "results": {...},
      "results_metadata": {
        "batch_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
      },
      "status": "completed",
      "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}
)

// Get all extractions
const response = await axios.get(
  'https://api.documind.cloud/api/v1/data/extractions',
  {
    headers: { 'X-API-Key': API_KEY },
    params: { limit: 50 }
  }
);

Next Steps

Extract Data

Create new extractions

Batch Extract

Submit asynchronous batch extraction jobs

Understanding Reviews

Learn about the review workflow

Introduction

Core Endpoints

Data & Querying

Review

Documents

API Keys

User Settings

Usage & Credits

Endpoint

Authentication

Query Parameters

Response

Examples

Next Steps

Extract Data

Batch Extract

Understanding Reviews

​Endpoint

​Authentication

​Query Parameters

​Response

​Examples

​Next Steps

Extract Data

Batch Extract

Understanding Reviews

Endpoint

Authentication

Query Parameters

Response

Examples

Next Steps