List all Families

ENDPOINT

1. GET /v1/family

FILTERS

The table below describes various filters that can be passed as query parameters to narrow the response.

RESPONSE

1. {
2.     "total": 1,
3.     "data": [
4.         {
5.             "id": "fam-6988065d-5a54-4d0c-b83b-d3190a93e52e",
6.             "programId": "prg-b9f17601-4717-460e-bda5-9598f6f6db28",
7.             "createdPersonId": "per-d0309a56-a71f-449b-8d1b-105f926dcfc0",
8.             "status": "active",
9.             "name": "Doe Fam",
10.             "email": "test@solidfi.com",
11.             "phone": "+14815220744",
12.             "address": {
13.                 "addressType": "mailing",
14.                 "line1": "1 Broadway",
15.                 "line2": "",
16.                 "city": "Los Gatos",
17.                 "state": "CA",
18.                 "country": "US",
19.                 "postalCode": "95030"
20.             },
21.             "createdAt": "2022-03-31T21:01:35Z",
22.             "modifiedAt": "2022-03-31T21:03:15Z",
23.             "metadata": null
24.         }
25.     ]
26. }

‍