JavaScript
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);curl --request POST \
--url https://api.getivy.de/api/service/customer/search \
--header 'Content-Type: application/json' \
--header 'X-Ivy-Api-Key: <api-key>' \
--data '
{
"email": "<string>",
"phone": "<string>",
"limit": 1,
"skip": 1
}
'import requests
url = "https://api.getivy.de/api/service/customer/search"
payload = {
"email": "<string>",
"phone": "<string>",
"limit": 1,
"skip": 1
}
headers = {
"X-Ivy-Api-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.getivy.de/api/service/customer/search",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'email' => '<string>',
'phone' => '<string>',
'limit' => 1,
'skip' => 1
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Ivy-Api-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.getivy.de/api/service/customer/search"
payload := strings.NewReader("{\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"limit\": 1,\n \"skip\": 1\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Ivy-Api-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.getivy.de/api/service/customer/search")
.header("X-Ivy-Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"limit\": 1,\n \"skip\": 1\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getivy.de/api/service/customer/search")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Ivy-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"limit\": 1,\n \"skip\": 1\n}"
response = http.request(request)
puts response.read_body{
"items": [
{
"id": "<string>",
"bankAccounts": [
{
"last4digits": "<string>",
"bank": {
"id": "<string>",
"name": "<string>",
"logo": "<string>"
}
}
],
"email": "<string>",
"emailAddress": "<string>",
"phone": "<string>",
"fullName": "<string>",
"dateOfBirth": "<string>",
"address": {
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"zipCode": "<string>"
},
"deleted": true,
"deletedAt": "2023-11-07T05:31:56Z",
"metadata": {}
}
],
"count": 123,
"skip": 123,
"hasNext": true
}Customer
Search Customers
Search for customers you have previously created using filters, e.g. by email.
POST
/
api
/
service
/
customer
/
search
JavaScript
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);curl --request POST \
--url https://api.getivy.de/api/service/customer/search \
--header 'Content-Type: application/json' \
--header 'X-Ivy-Api-Key: <api-key>' \
--data '
{
"email": "<string>",
"phone": "<string>",
"limit": 1,
"skip": 1
}
'import requests
url = "https://api.getivy.de/api/service/customer/search"
payload = {
"email": "<string>",
"phone": "<string>",
"limit": 1,
"skip": 1
}
headers = {
"X-Ivy-Api-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.getivy.de/api/service/customer/search",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'email' => '<string>',
'phone' => '<string>',
'limit' => 1,
'skip' => 1
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Ivy-Api-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.getivy.de/api/service/customer/search"
payload := strings.NewReader("{\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"limit\": 1,\n \"skip\": 1\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Ivy-Api-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.getivy.de/api/service/customer/search")
.header("X-Ivy-Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"limit\": 1,\n \"skip\": 1\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getivy.de/api/service/customer/search")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Ivy-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"limit\": 1,\n \"skip\": 1\n}"
response = http.request(request)
puts response.read_body{
"items": [
{
"id": "<string>",
"bankAccounts": [
{
"last4digits": "<string>",
"bank": {
"id": "<string>",
"name": "<string>",
"logo": "<string>"
}
}
],
"email": "<string>",
"emailAddress": "<string>",
"phone": "<string>",
"fullName": "<string>",
"dateOfBirth": "<string>",
"address": {
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"zipCode": "<string>"
},
"deleted": true,
"deletedAt": "2023-11-07T05:31:56Z",
"metadata": {}
}
],
"count": 123,
"skip": 123,
"hasNext": true
}Authorizations
API key for authentication
Body
application/json
Response
200 - application/json
Successful response
Was this page helpful?
⌘I