GET
/
v1
/
family
curl --request GET \
  --url https://qa-api.sbx.solidfi.com/v1/family \
  --header 'Content-Type: application/json' \
  --data '""'
{
  "data": [
    {
      "address": {
        "addressType": "mailing",
        "city": "Los Gatos",
        "country": "US",
        "line1": "1 Broadway",
        "line2": "",
        "postalCode": "00603",
        "state": "CA"
      },
      "createdAt": "2023-11-20T06:16:16Z",
      "createdPersonId": "per-e6553324-1db8-49a8-a0d3-29132280b838",
      "email": "test@solidfi.com",
      "id": "fam-9a44d253-f866-440c-a5ad-6fd204eaeee5",
      "metadata": null,
      "modifiedAt": "2023-11-20T06:17:59Z",
      "name": "Doe Fam",
      "phone": "+15555555555",
      "programId": "prg-ffa511da-1adc-4603-b845-173b895a33f6",
      "status": "active"
    }
  ],
  "total": 1
}

Headers

​
sd-api-key
string
Example:

"{{sd-api-key}}"

​
sd-person-id
string
Example:

"{{sd-person-id}}"

Body

application/json · any

The body is of type any.

Response

200 - application/json
List all Families
​
data
object[]
Example:
[
  {
    "address": {
      "addressType": "mailing",
      "city": "Los Gatos",
      "country": "US",
      "line1": "1 Broadway",
      "line2": "",
      "postalCode": "00603",
      "state": "CA"
    },
    "createdAt": "2023-11-20T06:16:16Z",
    "createdPersonId": "per-e6553324-1db8-49a8-a0d3-29132280b838",
    "email": "test@solidfi.com",
    "id": "fam-9a44d253-f866-440c-a5ad-6fd204eaeee5",
    "metadata": null,
    "modifiedAt": "2023-11-20T06:17:59Z",
    "name": "Doe Fam",
    "phone": "+15555555555",
    "programId": "prg-ffa511da-1adc-4603-b845-173b895a33f6",
    "status": "active"
  }
]
​
total
number
Example:

1

Get Document Download URLCreate a Family