List all Contacts (Program)

Retrieves list of all contacts that belong to a program
List all Contacts (Program)
 last updated: 
August 15, 2022

ENDPOINT

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

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 contact ID
status enum active, deleted
type enum others, selfAch, selfIntrabank
accountId string account ID
intrabankAccountNumber string intrabank account number
achAccountNumber string ACH account number
achRoutingtNumber string ACH routing number
wireDomesticAccountNumber string domestic wire account number
wireDomesticRoutingNumber string domestic wire routing number
wireInternationalAccountNumber string international wire account number
wireInternationalBankIdentifierCode string international wire SWIFT code
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)
externalId string Matches the externalId key if set in the object's metadata


RESPONSE

  1. {
  2.     "total": 2,
  3.     "data": [
  4.         {
  5.             "id": "con-4175535f-00ba-4d04-a0bb-176cedf86e0a",
  6.             "accountId": "acc-a8e09c2c-d2e1-487a-9bfd-e4e58dfebbd2",
  7.             "name": "Kate Lynn",
  8.             "email": "katelynnarcher@icloud.com",
  9.             "phone": "+14065958594",
  10.             "status": "active",
  11.             "intrabank": null,
  12.             "ach": {
  13.                 "accountNumber": "2200001397946",
  14.                 "routingNumber": "092900613",
  15.                 "accountType": "personalChecking",
  16.                 "bankName": "First Security Bank"
  17.             },
  18.             "createdAt": "2021-12-19T19:05:38Z",
  19.             "modifiedAt": "2021-12-19T20:22:30Z",
  20.             "wire": {
  21.                 "domestic": {
  22.                     "accountNumber": "547109638312",
  23.                     "routingNumber": "041215663",
  24.                     "accountType": "personalChecking",
  25.                     "bankName": "Albert",
  26.                     "address": {
  27.                         "addressType": "wire",
  28.                         "line1": "802 N Grand Ave",
  29.                         "line2": "Apt 3A11",
  30.                         "city": "Bozeman",
  31.                         "state": "MT",
  32.                         "country": "US",
  33.                         "postalCode": "59715"
  34.                     }
  35.                 },
  36.                 "international": null
  37.             },
  38.             "check": null,
  39.             "card": {
  40.                 "address": {
  41.                     "addressType": "card",
  42.                     "line1": "890 Hidden Valley Road 39",
  43.                     "line2": "",
  44.                     "city": "Bozeman",
  45.                     "state": "MT",
  46.                     "country": "US",
  47.                     "postalCode": "59718"
  48.                 }
  49.             },
  50.             "type": "others",
  51.             "metadata": null,
  52.             "programId": "prg-b9f17601-4717-460e-bda5-9598f6f6db28",
  53.             "debitCard": null
  54.         },
  55.         {
  56.             "id": "con-2a8a1add-2994-4c6c-b799-da63cdbdd515",
  57.             "accountId": "acc-a8e09c2c-d2e1-487a-9bfd-e4e58dfebbd2",
  58.             "name": "Secondary",
  59.             "email": "",
  60.             "phone": "",
  61.             "status": "active",
  62.             "intrabank": {
  63.                 "accountNumber": "9990001110720346"
  64.             },
  65.             "ach": null,
  66.             "createdAt": "2021-12-19T19:04:28Z",
  67.             "modifiedAt": "2021-12-19T19:04:28Z",
  68.             "wire": null,
  69.             "check": null,
  70.             "card": null,
  71.             "type": "selfIntrabank",
  72.             "metadata": null,
  73.             "programId": "prg-b9f17601-4717-460e-bda5-9598f6f6db28",
  74.             "debitCard": null
  75.         }
  76.     ]
  77. }