List all Families (Program)

Retrieves list of all the families in a program
List all Families (Program)
 last updated: 
September 6, 2022

ENDPOINT

  1. GET /v1/program/:id/family

FILTERS

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

Filter Type Description
offset int start index (default = 0)
limit int number of records to return (default = 25, max = 100)
id string family ID
phone string Phone number in e.164 format
email string email address
createdPersonId string ID of person who created the family
status enum active, inactive, deactivated, or dormant
startTime string Created time in ISO UTC format (YYYY-MM-DDThh:mm:ssZ)
endTime string Created time in ISO UTC format (YYYY-MM-DDThh:mm:ssZ)
modifiedStartTime string Modified time in ISO UTC format (YYYY-MM-DDThh:mm:ssZ)
modifiedEndTime string Modified time in ISO UTC format (YYYY-MM-DDThh:mm:ssZ)


RESPONSE

  1. {
  2.     "total": 2,
  3.     "data": [
  4.         {
  5.             "id": "fam-1ef21512-fdc1-479c-96aa-db5a173c7af5",
  6.             "programId": "prg-ddb08641-6565-465d-ba94-ed199497299f",
  7.             "createdPersonId": "per-141f3e85-995e-4acf-bd63-98e4d8d4a520",
  8.             "status": "active",
  9.             "name": "Solid Family",
  10.             "email": "justin@solidfi.com",
  11.             "phone": "+15555555555",
  12.             "address": {
  13.                 "addressType": "mailing",
  14.                 "line1": "123 S Main St",
  15.                 "line2": "",
  16.                 "city": "Los Angeles",
  17.                 "state": "CA",
  18.                 "country": "US",
  19.                 "postalCode": "90012"
  20.             },
  21.             "createdAt": "2022-06-29T18:34:09Z",
  22.             "modifiedAt": "2022-06-29T18:34:09Z",
  23.             "metadata": null
  24.         },
  25.         {
  26.             "id": "fam-d8b5d10e-9bc0-4c5d-9ecd-3ef95bf8f2fa",
  27.             "programId": "prg-ddb08641-6565-465d-ba94-ed199497299f",
  28.             "createdPersonId": "per-c1df28cb-a889-41ea-9ab3-6b33c8985c0f",
  29.             "status": "active",
  30.             "name": "Doe Family",
  31.             "email": "justin@solidfi.com",
  32.             "phone": "+15555555555",
  33.             "address": {
  34.                 "addressType": "mailing",
  35.                 "line1": "1 Broadway",
  36.                 "line2": "",
  37.                 "city": "Los Gatos",
  38.                 "state": "CA",
  39.                 "country": "US",
  40.                 "postalCode": "95030"
  41.             },
  42.             "createdAt": "2022-06-15T22:57:37Z",
  43.             "modifiedAt": "2022-06-15T23:09:25Z",
  44.             "metadata": null
  45.         }
  46.     ]
  47. }