Get OCR tasks

GET
/ocr_tasks

Headers

Auth
AuthorizationstringRequired
Bearer authentication of the form Bearer <token>, where token is your auth token.
x-monite-versionstringRequired
x-monite-entity-idstringRequired

The ID of the entity that owns the requested resource.

Query parameters

orderenumOptional

Sort order (ascending by default). Typically used together with the sort parameter.

Allowed values: ascdesc
limitintegerOptional>=1<=100Defaults to 100

The number of items (0 .. 100) to return in a single page of the response. The response may contain fewer items if it is the last or only page.

pagination_tokenstringOptional

A pagination token obtained from a previous call to this endpoint. Use it to get the next or previous page of results for your initial query. If pagination_token is specified, all other query parameters are ignored and inferred from the initial query.

If not specified, the first page of results will be returned.

sortenumOptional

The field to sort the results by. Typically used together with the order parameter.

Allowed values: idcreated_at
created_at__gtdatetimeOptional

Return only ocr tasks created after the specified date and time. The value must be in the ISO 8601 format YYYY-MM-DDThh:mm[:ss[.ffffff]][Z|±hh:mm].

created_at__ltdatetimeOptional

Return only ocr tasks created in Monite before the specified date and time.

created_at__gtedatetimeOptional

Return only ocr tasks created on or after the specified date and time.

created_at__ltedatetimeOptional

Return only ocr tasks created before or on the specified date and time.

statusenumOptional

Return only ocr tasks that have the specified status.

Allowed values: processingsuccesserror
document_typeenumOptional

Return only OCR tasks related to documents of a specific type.

Allowed values: invoicecredit_notereceipt
id__instringOptionalformat: "uuid"

Return only ocr tasks with specified IDs. Valid but nonexistent IDs do not raise errors but produce no results.

To specify multiple IDs, repeat this parameter for each value: id__in=<id1>&id__in=<id2>

Response

Successful Response

datalist of objects
prev_pagination_tokenstringOptional

A token that can be sent in the pagination_token query parameter to get the previous page of results, or null if there is no previous page (i.e. you’ve reached the first page).

next_pagination_tokenstringOptional

A token that can be sent in the pagination_token query parameter to get the next page of results, or null if there is no next page (i.e. you’ve reached the last page).

Errors