---
title: "List cases"
method: GET
path: "/cases"
tags: ["Cases"]
---

# List cases

`GET /cases`

## Request

- Base URL: `https://api.example.com/v1`
- URL: `https://api.example.com/v1/cases`
- Auth: none declared

Retrieve a paginated list of estate cases with optional filtering.

## Query parameters

- `page` integer
- `per_page` integer
- `sort_by` 'created_at' | 'updated_at' | 'estate_value'
- `sort_order` 'asc' | 'desc'
- `queue_assignment` string
- `flow_position` string
- `possible_dispute` 'no_dispute_expected' | 'possible_dispute' | 'active_dispute'
- `search` string

## Response `200`

List of cases.

- object
  - `data` Case[]
    - `id` string
    - `onboarding_id` string
    - `queue_assignment` string, nullable
    - `flow_position` string
    - `estate_value` 'unknown' | 'under_25k' | '25k_to_100k' | '100k_to_500k' | '500k_to_1m' | 'over_1m'
    - `progress` 'no_clue' | 'just_started' | 'making_progress' | 'almost_done' | 'completed'
    - `possible_dispute` 'no_dispute_expected' | 'possible_dispute' | 'active_dispute'
    - `pending_searches` string[]
    - `date_of_sign_up` string, date-time
    - `terms_accepted_at` string, date-time
    - `created_at` string, date-time
    - `updated_at` string, date-time
  - `meta` PaginationMeta
    - `page` integer
    - `per_page` integer
    - `total_count` integer
    - `total_pages` integer
    - `next_cursor` string, nullable: Opaque cursor for fetching the next page. Pass as the `cursor` query parameter. Null when on the last page.
    - `has_more` boolean: Whether more results exist beyond this page.

---

[API](https://skmtc.dev/hellosunset/apis/sunset-api.md) - [All operations](https://skmtc.dev/hellosunset/apis/sunset-api/llms.txt) - [OpenAPI document](https://skmtc.dev/hellosunset/apis/sunset-api/revisions/f128e5526efe?raw)