Document

Find Document Extractions By User

Return a list of users, based on given parameters.

get/api/v1/documents/extractions/user

Request

  • Base URL: https://api.gemina.co (the document declares no server; this is the origin it was published from)
  • URL: https://api.gemina.co/api/v1/documents/extractions/user
  • Auth: OAuth 2 (password, token URL token)

Query parameters

skipinteger

Number of items to skip

limitinteger

Number of items to retrieve

from_datestring date nullable

Return items with created_at >= this ISO 8601 date (YYYY-MM-DD)

to_datestring date nullable

Return items with created_at <= this ISO 8601 datetime (YYYY-MM-DD)

sort_fieldstring nullable

Field to sort by

sort_method'asc' | 'desc'

Sort method: asc or desc

external_idstring nullable

Filter for a given external identifier

end_user_idstring nullable

Filter for an End User ID

extraction_idstring uuid nullable

Filter for an exact document extraction ID — used to deep-link from the credit audit trail

with_purgedboolean nullable

Include purged document extractions

Response

Successful Response

servedAtstring date-time
servedAtTimestampnumber
createdAtstring date-time nullable
createdAtTimestampnumber nullable
status'pending' | 'in_process' | 'failed' | 'success' | 'partial' | 'empty' required
errorsobject[]

Changes

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