import Ivy from '@getivy/node-sdk';
const client = new Ivy({
apiKey: process.env['IVY_API_KEY'], // This is the default and can be omitted
});
const response = await client.customers.search();
console.log(response.count);{
"items": [
{
"id": "<string>",
"bankAccounts": [
{
"last4digits": "<string>",
"bank": {
"id": "<string>",
"name": "<string>",
"logo": "<string>"
}
}
],
"email": "<string>",
"emailAddress": "<string>",
"phone": "<string>",
"fullName": "<string>",
"dateOfBirth": "<string>",
"address": {
"country": "AF",
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"region": "02",
"zipCode": "<string>"
},
"deleted": true,
"deletedAt": "2023-11-07T05:31:56Z",
"metadata": {}
}
],
"count": 123,
"skip": 123,
"hasNext": true
}Search for customers you have previously created using filters, e.g. by email.
import Ivy from '@getivy/node-sdk';
const client = new Ivy({
apiKey: process.env['IVY_API_KEY'], // This is the default and can be omitted
});
const response = await client.customers.search();
console.log(response.count);{
"items": [
{
"id": "<string>",
"bankAccounts": [
{
"last4digits": "<string>",
"bank": {
"id": "<string>",
"name": "<string>",
"logo": "<string>"
}
}
],
"email": "<string>",
"emailAddress": "<string>",
"phone": "<string>",
"fullName": "<string>",
"dateOfBirth": "<string>",
"address": {
"country": "AF",
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"region": "02",
"zipCode": "<string>"
},
"deleted": true,
"deletedAt": "2023-11-07T05:31:56Z",
"metadata": {}
}
],
"count": 123,
"skip": 123,
"hasNext": true
}API key for authentication
Successful response
Array of customer objects matching the search criteria
Show child attributes
The id of the customer
Array of bank accounts remembered by user
Show child attributes
Last 4 digits of remembered account number
The email address of the customer
Deprecated. Use the customer.email instead
The phone number of the customer
The full name or business name of the customer
Customer's date of birth in ISO 8601 datetime format. Example: '2025-09-05'. Reference: https://en.wikipedia.org/wiki/ISO_8601
The registered address of the customer
Show child attributes
ISO 3166-1 alpha-2 country code (e.g. DE)
AF, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BA, BW, BV, BR, IO, BN, BG, BF, BI, KH, CM, CA, CV, KY, CF, TD, CL, CN, CX, CC, CO, KM, CG, CD, CK, CR, CI, HR, CU, CY, CZ, DK, DJ, DM, DO, EC, EG, SV, GQ, ER, EE, ET, FK, FO, FJ, FI, FR, GF, PF, TF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GP, GU, GT, GN, GW, GY, HT, HM, VA, HN, HK, HU, IS, IN, ID, IR, IQ, IE, IL, IT, JM, JP, JO, KZ, KE, KI, KP, KR, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MO, MG, MW, MY, MV, ML, MT, MH, MQ, MR, MU, YT, MX, FM, MD, MC, MN, MS, MA, MZ, MM, NA, NR, NP, NL, NC, NZ, NI, NE, NG, NU, NF, MP, MK, NO, OM, PK, PW, PS, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, RE, RO, RU, RW, SH, KN, LC, PM, VC, WS, SM, ST, SA, SN, SC, SL, SG, SK, SI, SB, SO, ZA, GS, ES, LK, SD, SR, SJ, SZ, SE, CH, SY, TW, TJ, TZ, TH, TL, TG, TK, TO, TT, TN, TR, TM, TC, TV, UG, UA, AE, GB, US, UM, UY, UZ, VU, VE, VN, VG, VI, WF, EH, YE, ZM, ZW, AX, BQ, CW, GG, IM, JE, ME, BL, MF, RS, SX, SS, XK Address line 1
Address line 2
Full name of the city
The second part of the subdivision ISO 3166-2 country code (e.g. BE)
02, 03, 04, 05, 06, 07, 08, AJ, AZ, DU, FU, RK, SH, UQ, BAL, BAM, BDG, BDS, BGL, DAY, FRA, FYB, GHA, GHO, HEL, HER, JOW, KAB, KAN, KAP, KDZ, KHO, KNR, LAG, LOG, NAN, NIM, NUR, PAN, PAR, PIA, PKA, SAM, SAR, TAK, URU, WAR, ZAB, 10, 11, 01, 09, 12, AG, AR, AV, ER, GR, KT, LO, SU, TV, VD, BGO, BGU, BIE, CAB, CCU, CNN, CNO, CUS, HUA, HUI, LNO, LSU, LUA, MAL, MOX, NAM, UIG, ZAI, A, B, C, D, E, F, G, H, J, K, L, M, N, P, Q, R, S, T, U, V, W, X, Y, Z, 1, 2, 3, 4, 5, 6, 7, 8, 9, ACT, NSW, NT, QLD, SA, TAS, VIC, WA, ABS, AGA, AGC, AGM, AGS, AGU, AST, BA, BAB, BAR, BEY, BIL, CAL, CUL, DAS, FUZ, GA, GAD, GOR, GOY, GYG, HAC, IMI, ISM, KAL, KUR, LA, LAC, LAN, LER, MAS, MI, NA, NEF, NV, NX, OGU, ORD, QAB, QAX, QAZ, QBA, QBI, QOB, QUS, SAB, SAD, SAH, SAK, SAL, SAT, SBN, SIY, SKR, SM, SMI, SMX, SR, SUS, TAR, TOV, UCA, XA, XAC, XCI, XIZ, XVD, YAR, YE, YEV, ZAN, ZAQ, ZAR, BIH, BRC, SRP, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 64, BRU, VAN, VBR, VLG, VLI, VOV, VWV, WAL, WBR, WHT, WLG, WLX, WNA, BAN, BAZ, BGR, BLG, BLK, COM, GAN, GNA, GOU, HOU, IOB, KAD, KEN, KMD, KMP, KOP, KOS, KOT, KOW, LOR, MOU, NAO, NAY, NOU, OUB, OUD, PAS, PON, SEN, SIS, SMT, SNG, SOM, SOR, TAP, TUI, YAG, YAT, ZIR, ZON, ZOU, BB, BL, BM, BR, CA, CI, GI, KI, KR, KY, MA, MU, MW, MY, NG, RM, RT, RY, AK, AL, AQ, BO, CO, DO, KO, LI, MO, OU, PL, ZO, BE, TE, TU, O, SE, AC, AM, AP, CE, DF, ES, GO, MG, MS, MT, PA, PB, PE, PI, PR, RJ, RN, RO, RR, RS, SC, SP, TO, BI, BP, BY, CK, CS, EG, EX, FP, GC, HI, HT, IN, MC, NE, NO, NP, NS, RC, RI, SO, SS, SW, WG, TY, CH, FR, GH, JW, KG, KL, KW, NW, ST, HM, HO, HR, VI, BZ, CY, CZL, OW, TOL, AB, BC, MB, NB, NL, NU, ON, QC, SK, YT, BU, EQ, HK, HL, HU, IT, KC, KE, KN, KS, LU, MN, NK, TA, BGF, BK, HS, KB, LB, MP, NM, OP, UK, VK, BZV, AI, BS, GE, GL, JU, SG, SZ, TG, TI, UR, VS, ZG, ZH, CM, DN, GD, LC, LG, SV, VB, WR, YM, ZZ, AN, AT, LL, LR, ML, AD, EN, LT, AH, BJ, CQ, FJ, GS, GX, GZ, HA, HB, HE, HN, JL, JS, JX, LN, QH, SD, SN, SX, TJ, TW, XJ, XZ, YN, ZJ, AMA, ANT, ARA, ATL, BOL, BOY, CAQ, CAS, CAU, CES, CHO, COR, CUN, DC, GUA, GUV, MAG, MET, NAR, NSA, PUT, QUI, RIS, SAN, SAP, SUC, VAC, VAU, VID, SJ, 99, BV, CF, CR, PN, RB, RG, SF, SL, TS, 201, 202, 203, 204, 205, 206, 207, 208, 209, 20A, 20B, 20C, 311, 312, 313, 314, 315, 316, 317, 321, 322, 323, 324, 325, 326, 327, 411, 412, 413, 421, 422, 423, 424, 425, 426, 427, 511, 512, 513, 514, 521, 522, 523, 524, 525, 531, 532, 533, 534, 631, 632, 633, 634, 635, 641, 642, 643, 644, 645, 646, 647, 71, 711, 712, 713, 714, 715, 72, 721, 722, 723, 724, 80, 801, 802, 803, 804, 805, 806, BW, HH, MV, NI, RP, TH, AS, DI, DJ, OB, 015, 020, 025, 030, 035, 040, 042, 050, 055, 060, 065, 070, 076, 080, 101, 147, 81, 82, 83, 84, 85, I, 130, 141, 142, 171, 184, 191, 198, 214, 245, 247, 251, 255, 272, 283, 284, 291, 293, 296, 303, 305, 338, 353, 430, 431, 432, 441, 442, 446, 478, 480, 486, 503, 528, 557, 567, 586, 615, 618, 622, 624, 638, 651, 653, 661, 663, 668, 68, 689, 698, 708, 719, 726, 732, 735, 74, 784, 79, 792, 793, 796, 809, 824, 834, 855, 87, 890, 897, 899, 901, 903, 907, 917, 919, 928, ALX, ASN, BH, BNS, DK, DT, FYM, IS, KFS, LX, MNF, PTS, SHG, SHR, SIN, SUZ, WAD, GB, CB, CC, CL, CN, CT, CU, GU, IB, LE, MD, NC, OR, PM, PO, PV, TF, VA, VC, ZA, AA, AF, DD, SI, KSA, PNI, TRK, YAP, 20R, 2A, 2B, 65, 66, 67, 69, 69M, 6AE, 70, 73, 75C, 76, 77, 78, 86, 88, 89, 90, 91, 92, 93, 94, 95, 971, 972, 973, 974, 976, BFC, BRE, CP, CVL, GES, HDF, IDF, MF, NAQ, NOR, OCC, PAC, PDL, PF, WF, ABC, ABD, ABE, AGB, AGY, AND, ANN, ANS, BAS, BBD, BCP, BDF, BEN, BEX, BFS, BGE, BGW, BIR, BKM, BNE, BNH, BPL, BRD, BRY, BST, BUR, CAM, CAY, CBF, CCG, CGN, CHE, CHW, CLD, CLK, CMA, CMD, CMN, CON, COV, CRF, CRY, CWY, DAL, DBY, DEN, DER, DEV, DGY, DNC, DND, DOR, DRS, DUD, DUR, EAL, EAW, EAY, EDH, EDU, ELN, ELS, ENF, ENG, ERW, ERY, ESS, ESX, FAL, FIF, FLN, FMO, GAT, GBN, GLG, GLS, GRE, GWN, HAL, HAM, HAV, HCK, HEF, HIL, HLD, HMF, HNS, HPL, HRT, HRW, HRY, IOS, IOW, ISL, IVC, KEC, KHL, KIR, KTT, KWL, LBC, LBH, LCE, LDS, LEC, LEW, LIN, LIV, LND, LUT, MAN, MDB, MDW, MEA, MIK, MLN, MON, MRT, MRY, MTY, MUL, NBL, NEL, NET, NFK, NGM, NIR, NLK, NLN, NMD, NNH, NSM, NTL, NTT, NTY, NWM, NWP, NYK, OLD, ORK, OXF, PEM, PKN, PLY, POR, POW, PTE, RCC, RCH, RCT, RDB, RDG, RFW, RIC, ROT, RUT, SAW, SAY, SCB, SCT, SFK, SFT, SGC, SHF, SHN, SKP, SLF, SLG, SLK, SND, SOL, SOS, SRY, STE, STG, STH, STN, STS, STT, STY, SWA, SWD, SWK, TAM, TFW, THR, TOB, TOF, TRF, TWH, UKM, VGL, WBK, WDU, WFT, WGN, WIL, WKF, WLL, WLN, WLS, WLV, WND, WNH, WNM, WOK, WOR, WRL, WRT, WRX, WSM, WSX, YOR, ZET, IM, KA, KK, MM, RL, TB, EP, OT, UE, UW, WN, WP, KU, QE, QT, BF, DB, DL, FA, FO, KD, NZ, YO, BN, OI, QU, DE, EB, PT, UD, UT, FM, LP, OC, OL, SB, ND, FE, GY, HV, JN, KM, KV, NY, PS, VE, VM, ZE, BT, JA, JB, JI, JK, JT, PP, CW, LD, LH, LK, LM, LS, MH, OY, WD, WH, WW, WX, JM, DH, GJ, HP, JH, MZ, PY, TN, TR, UP, WB, BG, DA, DQ, QA, 00, AKN, AKU, ARN, ASA, BLA, BOG, DAB, DAV, EOM, EYF, FJD, FJL, FLA, FLR, GAR, GOG, GRN, GRU, GRY, HAF, HRG, HRU, HUG, HUV, HVA, HVE, ISA, KJO, MOS, MYR, RGE, RGY, RHH, RKN, RKV, SBT, SDN, SDV, SEL, SFA, SKF, SKG, SKO, SNF, SOG, SSS, STR, SVG, TAL, THG, TJO, VEM, VER, VOP, 75, CZ, FC, FG, FI, ME, PC, PD, PG, PU, PZ, RA, RE, TP, VR, VT, VV, IR, KH, PH, XE, XI, XS, GG, GK, GP, MR, VL, EC, RD, WI, 002, 007, 011, 016, 022, 026, 033, 041, 047, 052, 054, 056, 058, 059, 062, 067, 068, 073, 077, 087, 088, 089, 091, 094, 097, 099, 102, 106, 111, 112, 113, DGV, JEL, JUR, LPX, REZ, RIX, VEN, DR, GT, JG, KF, MJ, MQ, NQ, WS, AGD, AOU, ASZ, AZI, BEM, BER, BES, BOD, BOM, BRR, CHI, CHT, DRI, ERR, ESI, ESM, FAH, FES, FIG, FQH, GUE, GUF, HAJ, HAO, HOC, IFR, INE, JDI, JRA, KES, KHE, KHN, LAA, LAR, MAR, MDF, MED, MEK, MID, MOH, NAD, OUA, OUJ, OUZ, RAB, REH, SAF, SEF, SET, SIB, SIF, SIK, SIL, SKH, TAF, TAI, TAO, TAT, TAZ, TET, TIN, TIZ, TNG, TNT, YUS, ZAG, JE, BD, ED, FL, IA, UN, ALK, ALL, AUR, EBO, ENI, JAB, JAL, KIL, KWA, LAE, LIB, LIK, MAJ, MEJ, MIL, NMK, NMU, RON, UJA, UTI, WTH, WTJ, 103, 104, 105, 107, 108, 109, 210, 211, 301, 304, 307, 308, 310, 401, 402, 403, 404, 405, 406, 407, 408, 409, 410, 501, 502, 504, 505, 506, 507, 508, 509, 601, 602, 603, 604, 605, 606, 607, 608, 609, 701, 702, 703, 704, 705, 706, 807, 808, 810, 811, 812, 813, 814, 815, 816, 817, BKO, 037, 039, 043, 046, 049, 051, 053, 057, 061, 063, 064, 069, 071, PW, MLE, RU, BCN, BCS, CHH, CHP, CMX, COA, COL, GRO, HID, MEX, MIC, MOR, NLE, OAX, PUE, QUE, ROO, SLP, SON, TAB, TLA, YUC, ZAC, MPM, OD, OH, OS, EK, OG, AW, BQ1, BQ2, BQ3, NH, OV, P1, P2, P3, P4, P5, P6, P7, AUK, BOP, CAN, CIT, GIS, HKB, MBH, MWT, NSN, OTA, STL, TKI, WKO, WTC, WU, ZU, EM, ANC, APU, ARE, AYA, CAJ, HUC, ICA, JUN, LAL, LAM, LIM, LMA, MDD, MOQ, PIU, PUN, TAC, TUM, CPK, CPM, EBR, EHG, EPW, ESW, GPK, HLA, JWK, MBA, MPL, MRL, NCD, NIK, NPP, NSB, SHM, WHM, WPD, ABR, AGN, AKL, ALB, APA, BOH, BTG, BTN, BUK, BUL, CAG, CAP, CAT, CAV, CEB, DAO, DIN, DVO, EAS, GUI, IFU, ILI, ILN, ILS, LAS, LEY, LUN, MAD, MDC, MDR, MSC, MSR, NCO, NEC, NER, NUE, NUV, PAM, PLW, RIZ, ROM, SCO, SIG, SLE, SLU, SUK, SUN, SUR, TAW, WSA, ZAS, ZMB, ZSI, KP, BTH, DEB, GZA, HBN, JEM, JEN, JRH, KYS, NBS, NGZ, QQA, RBH, RFH, SLT, TBS, TKM, 004, 010, 100, 150, 212, 218, 222, 224, 226, 227, 228, 350, 370, ASU, US, CJ, CV, HD, IF, IL, TL, TM, VN, VO, ALT, AMU, ARK, BEL, CHU, IRK, IVA, KAM, KDA, KEM, KGD, KGN, KHA, KHM, KLU, KRS, KYA, LEN, LIP, MOW, MUR, NEN, NGR, NIZ, NVS, OMS, ORE, ORL, PER, PNZ, PRI, PSK, ROS, RYA, SMO, SPE, STA, SVE, TOM, TUL, TVE, TYU, ULY, VGG, VLA, VOR, YAN, MK, WE, DS, DW, NR, 001, 003, 005, 006, 008, 009, 012, 013, 014, 017, 018, 019, 021, 023, 024, 027, 028, 029, 031, 032, 034, 036, 038, 044, 045, 048, 066, 072, 074, 075, 078, 079, 081, 082, 083, 084, 085, 086, 090, 092, 093, 095, 096, 098, 110, 114, 115, 116, 117, 118, 119, 120, 121, 122, 123, 124, 125, 126, 127, 128, 129, 131, 132, 133, 134, 135, 136, 137, 138, 139, 140, 143, 144, 146, 148, 149, 151, 152, 153, 154, 155, 156, 157, 158, 159, 160, 161, 162, 163, 164, 165, 166, 167, 168, 169, 170, 172, 173, 174, 175, 176, 177, 178, 179, 180, 181, 182, 183, 185, 186, 187, 188, 189, 190, 192, 193, 194, 195, 196, 197, 199, 200, 213, TC, ZI, FK, JD, WO, EE, EW, UY, DY, ID, EO, 96, OE, ARI, CHA, CTT, DMN, MRC, PED, POS, PRT, PTF, SFO, SGE, SIP, SJL, TUP, FUN, NIT, NKF, NKL, NMA, NMG, NUI, VAI, CYI, CYQ, HSQ, HSZ, ILA, KEE, KHH, KIN, LIE, MIA, NWT, PEN, PIF, TNN, TPE, TTT, TXG, YUN, 215, 216, 217, 219, 220, 221, 223, 225, 229, 230, 231, 232, 233, 234, 235, 236, 237, 302, 306, 309, 318, 319, 320, 328, 329, 330, 331, 332, 333, 334, 335, 336, 337, 414, 415, 416, 417, 418, 419, 420, 428, 429, 433, 434, 435, NJ, OK, TX, UM, WV, WY, FD, FS, RV, TT, QR, TK, XO, MAP, SEE, TAE, UV, VF, HJ, KZN, WC The zip or postal code
Indicates whether the customer was deleted
The customer deletion timestamp
A collection of key-value pairs that can be associated with an object to store custom data in a structured manner. This allows you to attach arbitrary information to enhance the object with additional context or properties. To clear the metadata, send an empty object.
Show child attributes
The total number of items
The number of items skipped
Whether there are more items to retrieve
Was this page helpful?