Skip to main content
GET
/
cases
List cases
curl --request GET \
  --url https://api.example.com/v1/cases \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "01K5WF06MJ6T99HRYE78AN7XM8",
      "onboarding_id": "01K5WET89VJ8HKBTMP3PS6KFBF",
      "queue_assignment": "John's Queue",
      "flow_position": "Closure - Decisions - Initial",
      "estate_value": "unknown",
      "progress": "no_clue",
      "possible_dispute": "no_dispute_expected",
      "pending_searches": [
        "irs"
      ],
      "date_of_sign_up": "2025-09-23T10:30:00Z",
      "terms_accepted_at": "2025-09-23T10:30:00Z",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "meta": {
    "page": 1,
    "per_page": 25,
    "total_count": 142,
    "total_pages": 6,
    "next_cursor": "eyJpZCI6IjAxSzVXRjA2TUo2VDk5SFJZRTQ4QU43WE04In0=",
    "has_more": true
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
page
integer
default:1

Page number for pagination.

Required range: x >= 1
​
per_page
integer
default:25

Number of items per page.

Required range: 1 <= x <= 100
​
sort_by
enum<string>
default:created_at
Available options:
created_at,
updated_at,
estate_value
​
sort_order
enum<string>
default:desc

Sort direction.

Available options:
asc,
desc
​
queue_assignment
string

Filter by queue assignment.

​
flow_position
string

Filter by flow position.

​
possible_dispute
enum<string>
Available options:
no_dispute_expected,
possible_dispute,
active_dispute
​
search
string

Full-text search across case metadata.

Response

200 - application/json

List of cases.

​
data
object[]
​
meta
object