POST
/
api
/
service
/
customer
/
search
curl --request POST \
  --url https://api.sand.getivy.de/api/service/customer/search \
  --header 'Content-Type: application/json' \
  --header 'X-Ivy-Api-Key: <api-key>' \
  --data '{
  "email": "<string>",
  "limit": 123,
  "skip": 123
}'
{
  "items": [
    {
      "id": "<string>",
      "emailAddress": "<string>",
      "bankAccounts": [
        {
          "last4digits": "<string>",
          "bank": {
            "id": "<string>",
            "name": "<string>",
            "logo": "<string>"
          }
        }
      ]
    }
  ],
  "skip": 123,
  "count": 123,
  "hasNext": true
}

Authorizations

X-Ivy-Api-Key
string
header
required

Body

application/json
email
string
required

Search for customers by email

limit
number

A limit on the number of objects to be returned.

skip
number

The number of items to skip

Response

200 - application/json
Successful response
items
object[]
required
skip
number
required

The number of items skipped

count
number
required

The total number of items

hasNext
boolean
required

Whether there are more items to retrieve