Retrieve a list of cases

Request

Retrieve a list of cases.

Security

OAuth2(Required scopes: cases.read)

Query

projectIdsArray of strings

Used to retrieve cases belonging to specific projects only. Multiple project identifiers can be provided. By default, cases from all accessible projects are returned.

offsetinteger, >= 0

A zero-based offset of the first item in the data collection to return.

limitinteger, [ 0 .. 50 ]

Limit the amount of items returned in the response. If the value exceeds the maximum, then the maximum value will be used.

Default:20

sortstring

The field to sort reponse items by.

Default:"-createdAt"

Enum:"createdAt""-createdAt""+createdAt""updatedAt""-updatedAt""+updatedAt"

stateArray of strings(CaseState)

Used to retrieve cases that are in specific states only. Multiple states can be used for this filtering. By default, cases in all states are returned.

Items Enum:"done""doneAutomatically""failed""inCompletion""new""processing""rejected""reviewRequired""transferFailed""transferred"

fileBatchIdstring

File batch identifier to retrieve cases that were created from that file batch.

curl -i -X GET \
  'https://api.cloud.hypatos.ai/v2/cases?projectIds=string&offset=0&limit=20&sort=createdAt&state=done&fileBatchId=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

List of cases

Bodyapplication/json

dataArray of objects(CaseResponse)required

limitinteger

The limit used for this page of results. This will be the same as the limit query parameter unless it exceeds the maximum allowed value.

Example:20

offsetinteger

The offset used for this page of results. This will be the same as the offset query parameter.

Example:0

totalCountinteger

The total number of elements in the data attribute.

Example:1000

Response

{
  "data": [
    { … }
  ],
  "limit": 20,
  "offset": 0,
  "totalCount": 1000
}