Javascript
import Ivy from '@getivy/node-sdk'; const client = new Ivy({ apiKey: 'My API Key', }); const response = await client.customers.search(); console.log(response.count);
{ "items": [ { "id": "<string>", "email": "<string>", "emailAddress": "<string>", "phone": "<string>", "fullName": "<string>", "dateOfBirth": "<string>", "address": { "line1": "<string>", "line2": "<string>", "city": "<string>", "region": "02", "zipCode": "<string>", "country": "AF" }, "bankAccounts": [ { "last4digits": "<string>", "bank": { "id": "<string>", "logo": "<string>", "name": "<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.
API key for authentication
Search for customers by email
Search for customers by phone
A limit on the number of objects to be returned.
x > 0
The number of items to skip
Successful response
Array of customer objects matching the search criteria
Show child attributes
The total number of items
The number of items skipped
Whether there are more items to retrieve
Was this page helpful?