GET
/
v1
/
program
/
{programId}
/
family
curl --request GET \
  --url https://qa-api.sbx.solidfi.com/v1/program/{programId}/family
{
  "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"
    },
    {
      "address": {
        "addressType": "mailing",
        "city": "New York",
        "country": "US",
        "line1": "123 Main St",
        "line2": "# 134",
        "postalCode": "10001",
        "state": "NY"
      },
      "createdAt": "2023-11-15T03:58:54Z",
      "createdPersonId": "per-d134301f-0498-41c8-ad16-9ffacc405439",
      "email": "Tevin@solid.com",
      "id": "fam-4eb8d87e-4e59-4316-ba1e-457d0b2a449f",
      "metadata": {
        "description": "random value",
        "email": "usrTestupdated@solidfi.com",
        "familyField": "Test metadata",
        "userId": "usrTestupdated"
      },
      "modifiedAt": "2023-11-15T03:58:54Z",
      "name": "famGreyson",
      "phone": "+17840306508",
      "programId": "prg-ffa511da-1adc-4603-b845-173b895a33f6",
      "status": "active"
    },
    {
      "address": {
        "addressType": "mailing",
        "city": "New York",
        "country": "US",
        "line1": "123 Main St",
        "line2": "# 134",
        "postalCode": "10001",
        "state": "NY"
      },
      "createdAt": "2023-10-25T09:53:14Z",
      "createdPersonId": "per-758131cc-d700-4e94-8da6-040ebf333340",
      "email": "Melody@solid.com",
      "id": "fam-f60e1a9a-f075-4309-a6b0-c8a1d58ef42a",
      "metadata": {
        "description": "random value",
        "email": "usrTestupdated@solidfi.com",
        "familyField": "Test metadata",
        "userId": "usrTestupdated"
      },
      "modifiedAt": "2023-10-25T09:53:14Z",
      "name": "famLisa",
      "phone": "+15555555555",
      "programId": "prg-ffa511da-1adc-4603-b845-173b895a33f6",
      "status": "active"
    },
    {
      "address": {
        "addressType": "mailing",
        "city": "New York",
        "country": "US",
        "line1": "123 Main St",
        "line2": "# 134",
        "postalCode": "10001",
        "state": "NY"
      },
      "createdAt": "2023-10-25T09:13:55Z",
      "createdPersonId": "per-d134301f-0498-41c8-ad16-9ffacc405439",
      "email": "Jaime@solid.com",
      "id": "fam-14f3124c-8dfc-49d1-a9d9-f7563f04fae4",
      "metadata": {
        "description": "random value",
        "email": "usrTestupdated@solidfi.com",
        "familyField": "Test metadata",
        "userId": "usrTestupdated"
      },
      "modifiedAt": "2023-10-25T09:13:55Z",
      "name": "famMaryam",
      "phone": "+15555555555",
      "programId": "prg-ffa511da-1adc-4603-b845-173b895a33f6",
      "status": "active"
    },
    {
      "address": {
        "addressType": "mailing",
        "city": "New York",
        "country": "US",
        "line1": "123 Main St",
        "line2": "# 134",
        "postalCode": "10001",
        "state": "NY"
      },
      "createdAt": "2023-10-18T07:22:43Z",
      "createdPersonId": "per-470007c5-8e0b-44f0-b63c-6f0dbba8a6c7",
      "email": "Issac@solid.com",
      "id": "fam-4a576a1b-5336-4c40-8bce-fca0aff3ac47",
      "metadata": {
        "description": "random value",
        "email": "usrTestupdated@solidfi.com",
        "familyField": "Test metadata",
        "userId": "usrTestupdated"
      },
      "modifiedAt": "2023-10-18T07:22:43Z",
      "name": "famDexter",
      "phone": "+17881001745",
      "programId": "prg-ffa511da-1adc-4603-b845-173b895a33f6",
      "status": "active"
    }
  ],
  "total": 5
}

Headers

sd-api-key
string
Example:

"{{sd-api-key}}"

Path Parameters

programId
string
required

Response

200 - application/json
List all Family
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"
  },
  {
    "address": {
      "addressType": "mailing",
      "city": "New York",
      "country": "US",
      "line1": "123 Main St",
      "line2": "# 134",
      "postalCode": "10001",
      "state": "NY"
    },
    "createdAt": "2023-11-15T03:58:54Z",
    "createdPersonId": "per-d134301f-0498-41c8-ad16-9ffacc405439",
    "email": "Tevin@solid.com",
    "id": "fam-4eb8d87e-4e59-4316-ba1e-457d0b2a449f",
    "metadata": {
      "description": "random value",
      "email": "usrTestupdated@solidfi.com",
      "familyField": "Test metadata",
      "userId": "usrTestupdated"
    },
    "modifiedAt": "2023-11-15T03:58:54Z",
    "name": "famGreyson",
    "phone": "+17840306508",
    "programId": "prg-ffa511da-1adc-4603-b845-173b895a33f6",
    "status": "active"
  },
  {
    "address": {
      "addressType": "mailing",
      "city": "New York",
      "country": "US",
      "line1": "123 Main St",
      "line2": "# 134",
      "postalCode": "10001",
      "state": "NY"
    },
    "createdAt": "2023-10-25T09:53:14Z",
    "createdPersonId": "per-758131cc-d700-4e94-8da6-040ebf333340",
    "email": "Melody@solid.com",
    "id": "fam-f60e1a9a-f075-4309-a6b0-c8a1d58ef42a",
    "metadata": {
      "description": "random value",
      "email": "usrTestupdated@solidfi.com",
      "familyField": "Test metadata",
      "userId": "usrTestupdated"
    },
    "modifiedAt": "2023-10-25T09:53:14Z",
    "name": "famLisa",
    "phone": "+15555555555",
    "programId": "prg-ffa511da-1adc-4603-b845-173b895a33f6",
    "status": "active"
  },
  {
    "address": {
      "addressType": "mailing",
      "city": "New York",
      "country": "US",
      "line1": "123 Main St",
      "line2": "# 134",
      "postalCode": "10001",
      "state": "NY"
    },
    "createdAt": "2023-10-25T09:13:55Z",
    "createdPersonId": "per-d134301f-0498-41c8-ad16-9ffacc405439",
    "email": "Jaime@solid.com",
    "id": "fam-14f3124c-8dfc-49d1-a9d9-f7563f04fae4",
    "metadata": {
      "description": "random value",
      "email": "usrTestupdated@solidfi.com",
      "familyField": "Test metadata",
      "userId": "usrTestupdated"
    },
    "modifiedAt": "2023-10-25T09:13:55Z",
    "name": "famMaryam",
    "phone": "+15555555555",
    "programId": "prg-ffa511da-1adc-4603-b845-173b895a33f6",
    "status": "active"
  },
  {
    "address": {
      "addressType": "mailing",
      "city": "New York",
      "country": "US",
      "line1": "123 Main St",
      "line2": "# 134",
      "postalCode": "10001",
      "state": "NY"
    },
    "createdAt": "2023-10-18T07:22:43Z",
    "createdPersonId": "per-470007c5-8e0b-44f0-b63c-6f0dbba8a6c7",
    "email": "Issac@solid.com",
    "id": "fam-4a576a1b-5336-4c40-8bce-fca0aff3ac47",
    "metadata": {
      "description": "random value",
      "email": "usrTestupdated@solidfi.com",
      "familyField": "Test metadata",
      "userId": "usrTestupdated"
    },
    "modifiedAt": "2023-10-18T07:22:43Z",
    "name": "famDexter",
    "phone": "+17881001745",
    "programId": "prg-ffa511da-1adc-4603-b845-173b895a33f6",
    "status": "active"
  }
]
total
number
Example:

5