GET
/
v1
/
family
/
{familyId}
curl --request GET \
  --url https://qa-api.sbx.solidfi.com/v1/family/{familyId} \
  --header 'Content-Type: application/json' \
  --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"
}

Headers

​
sd-api-key
string
Example:

"{{sd-api-key}}"

​
sd-person-id
string
Example:

"{{sd-person-id}}"

Path Parameters

​
familyId
string
required

Body

application/json · any

The body is of type any.

Response

200 - application/json
Retrieve a Family
​
address
object
​
createdAt
string
Example:

"2023-11-20T06:16:16Z"

​
createdPersonId
string
Example:

"per-e6553324-1db8-49a8-a0d3-29132280b838"

​
email
string
Example:

"test@solidfi.com"

​
id
string
Example:

"fam-9a44d253-f866-440c-a5ad-6fd204eaeee5"

​
metadata
any | null
​
modifiedAt
string
Example:

"2023-11-20T06:17:59Z"

​
name
string
Example:

"Doe Fam"

​
phone
string
Example:

"+15555555555"

​
programId
string
Example:

"prg-ffa511da-1adc-4603-b845-173b895a33f6"

​
status
string
Example:

"active"

Create a FamilyUpdate a Family