Skip to main content
GET
/
cases
List all cases
curl --request GET \
  --url https://api.uk.veridox.ai/cases \
  --header 'x-api-key: <api-key>'
{
  "cases": [
    {
      "case_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "label": "<string>",
      "metadata": {},
      "is_locked": true,
      "locked_at": "2023-11-07T05:31:56Z",
      "file_analysis_status": "waiting_for_file_analysis",
      "file_analysis_completed_at": "2023-11-07T05:31:56Z",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "team_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "team_name": "<string>"
    }
  ],
  "total": 4503599627370495,
  "limit": 123,
  "offset": 4503599627370495
}

Documentation Index

Fetch the complete documentation index at: https://docs.veridox.ai/llms.txt

Use this file to discover all available pages before exploring further.

Retrieve a list of cases belonging to the authenticated user. Cases are returned in reverse chronological order (newest first).

​
Best Practices

  1. Use List for Overview: Use GET /cases for dashboards and case selection.
  2. Use Details for Specifics: Use GET /cases/{id} when you need file-level information.
  3. Monitor Status: Check file_analysis_status for processing updates.

Authorizations

​
x-api-key
string
header
required

Query Parameters

​
limit
integer
default:20

Maximum number of cases to return

Required range: 1 <= x <= 100
​
offset
integer
default:0

Number of cases to skip for pagination

Required range: 0 <= x <= 9007199254740991

Response

List of cases retrieved successfully

​
cases
object[]
required
​
total
integer
required
Required range: 0 <= x <= 9007199254740991
​
limit
integer
required
Required range: x <= 9007199254740991
​
offset
integer
required
Required range: 0 <= x <= 9007199254740991