HEhellosunset
Cases

List cases

Retrieve a paginated list of estate cases with optional filtering.

get/cases

Request

  • Base URL
    https://api.example.com/v1
  • Auth
    none declared

Query parameters

pageinteger

Page number for pagination.

per_pageinteger

Number of items per page.

sort_by'created_at' | 'updated_at' | 'estate_value'
sort_order'asc' | 'desc'

Sort direction.

queue_assignmentstring

Filter by queue assignment.

flow_positionstring

Filter by flow position.

possible_dispute'no_dispute_expected' | 'possible_dispute' | 'active_dispute'
searchstring

Full-text search across case metadata.

Response

List of cases.

Example response

{
  "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"
    }
  ],
  "meta": {
    "page": 1,
    "per_page": 25,
    "total_count": 142,
    "total_pages": 6,
    "next_cursor": "eyJpZCI6IjAxSzVXRjA2TUo2VDk5SFJZRTQ4QU43WE04In0=",
    "has_more": true
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.