List Beneficiaries

GET /beneficiaries

cURL

cURL

curl --request GET \
  --url https://sandbox.withclasp.com/beneficiaries

200

{
  "next": "<string>",
  "previous": "<string>",
  "results": [
    {
      "id": "<string>",
      "full_name": "<string>",
      "member_relationship": "spouse",
      "member": "<string>",
      "tin_last_four": "<string>",
      "address": {
        "line1": "<string>",
        "city": "<string>",
        "state": "AL",
        "zip_code": "<string>",
        "line2": "<string>"
      },
      "phone_number": "<string>",
      "dob": "2023-12-25"
    }
  ]
}

Query Parameters

cursor · string

The pagination cursor value.

member · string

page_size · integer

Number of results to return per page.

Response

200 - application/json

next · string | null

previous · string | null

results · object[]

Show child attributes