v1
latestOpenAPI 3.0.22026-07-2441902.6 MBReturns one or more contacts matching the given criteria.
Query parameters
The number of elements to skip in contacts collection
The maximum number of elements in contacts collection
The contact member_id. Include only contacts whose member_id matches the criteria.
The contact first name. Include only contacts whose name matches the criteria.
The contact last name. Include only contacts whose name ends with the criteria.
The contact birthdate. Include only contacts whose birthdate matches the criteria.
The contact phone number. Include only contacts whose phone number (HOME, MOBILE or other) matches the criteria.
The contact internet banking login identifier. Include only contacts whose internet banking login identifier matches the criteria.
The number of an account. Include only contacts which contain an account whose number matches the criteria.
The number of a card. Include only contacts which contain a card whose number matches the criteria.
The last digits of a card number. Include all the contacts which contain cards whose numbers end with the criteria.
The contact social security number. Include only contacts whose social security number matches the criteria.
The last digits of a social security number. Include only contacts which have a social security number ending with the criteria.
Query based on custom fields, please note that this field is a JSON string that needs to be escaped. For example {"eag":"3322"} -> %7B%22eag%22:%223322%22%7D
The interaction id
Response
The list of contacts.
Example response
{
"_embedded": {
"contacts": [
{
"custom_fields": [
{
"key": "Job",
"value": "Engineer"
},
{
"key": "Nationality",
"value": "American"
}
]
}
]
}
}