List all Contacts

Retrieves list of all contacts that based on an account ID or other parameter
Contacts
List all Contacts
 last updated: 
November 22, 2022

ENDPOINT

  1. GET v1/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
achRoutingNumber 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
metadata.query string searches for a string in the metadata


RESPONSE

  1. {
  2.     "total": 1,
  3.     "data": [
  4.         {
  5.             "id": "con-ab8e4ddc-cf09-448d-aa19-f71527b8393c",
  6.             "accountId": "acc-63d656eb-fedc-4250-8111-48a5ff0faed9",
  7.             "name": "Bright Might LLC",
  8.             "email": "dwightmight@gmail.com",
  9.             "phone": "+18467051333",
  10.             "status": "active",
  11.             "intrabank": {
  12.                 "accountNumber": "9990001149517700"
  13.             },
  14.             "ach": {
  15.                 "accountNumber": "1098324502",
  16.                 "routingNumber": "121042882",
  17.                 "accountType": "businessChecking",
  18.                 "bankName": "Wells Fargo"
  19.             },
  20.             "createdAt": "2021-12-16T05:48:21Z",
  21.             "modifiedAt": "2021-12-16T06:07:10Z",
  22.             "wire": {
  23.                 "domestic": {
  24.                     "accountNumber": "1098324502",
  25.                     "routingNumber": "121042882",
  26.                     "accountType": "businessChecking",
  27.                     "bankName": "Wells Fargo",
  28.                     "address": {
  29.                         "addressType": "wire",
  30.                         "line1": "123 Main St",
  31.                         "line2": "",
  32.                         "city": "New York",
  33.                         "state": "NY",
  34.                         "country": "US",
  35.                         "postalCode": "10001"
  36.                     }
  37.                 },
  38.                 "international": null
  39.             },
  40.             "check": {
  41.                 "address": {
  42.                     "addressType": "check",
  43.                     "line1": "123 Main St",
  44.                     "line2": "",
  45.                     "city": "New York",
  46.                     "state": "NY",
  47.                     "country": "US",
  48.                     "postalCode": "10001"
  49.                 }
  50.             },
  51.             "card": {
  52.                 "address": {
  53.                     "addressType": "card",
  54.                     "line1": "123 Main St",
  55.                     "line2": "",
  56.                     "city": "New York",
  57.                     "state": "NY",
  58.                     "country": "US",
  59.                     "postalCode": "10001"
  60.                 }
  61.             },
  62.             "type": "others",
  63.             "metadata": null,
  64.             "programId": "prg-b9f17601-4717-460e-bda5-9598f6f6db28",
  65.             "debitCard": null
  66.         }
  67.     ]
  68. }