Extractions

List extractions

Your extractions, newest first, as slim summary items with cursor pagination. For the full record of one extraction use getExtractionDetails; for its rows, getExtractionResults.

Rate limit: 60 requests per minute per API key.

get/extractions

Request

  • Base URL: https://api.invoicedataextraction.com/v1
  • URL: https://api.invoicedataextraction.com/v1/extractions
  • Auth: HTTP bearer

Query parameters

status'processing' | 'input_required' | 'completed' | 'failed' | 'cancelled'
submission_method'api' | 'web_app'
created_afterstring date-time

Inclusive lower bound on created_at, ISO 8601 with a timezone.

created_beforestring date-time

Inclusive upper bound on created_at, ISO 8601 with a timezone.

scope'own' | 'team'

own or team. Team admins default to team and see every team member's extractions; everyone else defaults to own, and a non-admin passing team gets 403 FORBIDDEN. Under team, items carry submitted_by.

limitinteger
cursorstring

The next_cursor of the previous page. Opaque; never construct one.

Response

One page of extractions.

successtrue required
has_moreboolean required
next_cursorstring nullable required

Changes

No recorded changes to this operation across all 1 revision of this API.