Skip to content
docstack-ocr

List Reviews Endpoint

GET
/v1/reviews
 
curl --request GET \
  --url 'http://localhost:8080/v1/reviews?limit=50&offset=0'

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters ”
status
Any of:
string
Allowed values: pending in_review approved overridden reprocessed closed_by_delete
batch_id
Any of:
string
limit
Limit
integer
default: 50
offset
Offset
integer
0

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful Response

Media type application/json
ReviewListResponse
object
items
required
Items
Array<object>
ReviewSummary
object
review_id
required
Review Id
string
job_id
required
Job Id
string
job_status
required
Job Status
string
batch_id
required
Any of:
string
original_filename
Any of:
string
status
required
Status
string
Allowed values: pending in_review approved overridden reprocessed closed_by_delete
reasons
required
Reasons
Array<string>
created_at
required
Created At
string
updated_at
required
Updated At
string
resolved_at
required
Any of:
string
resolved_by
required
Any of:
string
resolution
required
Any of:
string
resolution_note
required
Any of:
string
total
required
Total
integer
limit
required
Limit
integer
offset
required
Offset
integer
Example 
{
  "items": [
    {
      "status": "pending"
    }
  ]
}

422

Section titled “422 ”

Validation Error

Media type application/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object
Example generated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}