HEhellosunset
Persons

List interested persons

List all interested persons and beneficiaries for a case.

get/cases/{case_id}/persons

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.

is_beneficiaryboolean
possible_disputeboolean
is_deceasedboolean
relationshipstring

Response

List of persons.

Example response

{
  "data": [
    {
      "id": "01K5XD09EJ7T44HRYE78AN7JKL",
      "first_name": "John",
      "middle_name": "Jonas",
      "last_name": "Johnson",
      "relationship": "daughter",
      "email": "alice@example.com",
      "phone": "+11112223333",
      "is_beneficiary": true,
      "waiver_status": "no_waiver_needed"
    }
  ],
  "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.