Skip to main content
GET
/
cases
/
{case_id}
/
persons
List interested persons
curl --request GET \
  --url https://api.example.com/v1/cases/{case_id}/persons \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "01K5XD09EJ7T44HRYE78AN7JKL",
      "first_name": "John",
      "middle_name": "Jonas",
      "last_name": "Johnson",
      "suffix": null,
      "relationship": "daughter",
      "email": "alice@example.com",
      "phone": "+11112223333",
      "is_beneficiary": true,
      "possible_dispute": false,
      "is_deceased": false,
      "waiver_status": "no_waiver_needed",
      "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.

Path Parameters

case_id
string
required

Unique case identifier (ULID format).

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
is_beneficiary
boolean
possible_dispute
boolean
is_deceased
boolean
relationship
string

Response

List of persons.

data
object[]
meta
object