POST /contacts/v1/addresses/search/{attributeName}

Overview

Fetches all contacts and associated addresses based on search criteria

URL Parameters

Name	Type		Description
attributeName	string	Required	The attribute used in the search criteria: ContactKeyLastModfiedDateSourceChannelStatusAudienceID

JSON Parameters

Name	Type		Description
filterConditionOperator	string	Required	Filter condition operator name. Currently supports only the "Is" operator
filterConditionValue	string	Required	Value for attribute used in search criteria for contacts and associated addresses. When using the "LastModfiedDate" attributeName, separate the values for start and end date in the filterconditionValue with an "AND" The "Channel" attributeName supports these values: MOBILE PUSH LINE EMAIL

Responses

Status	Name	Type	Description
200			Successfully retrieved contacts and associated addresses
	pageNumber	integer	Page number of results retrieved
	pageSize	integer	Page size of results retrieved
	addresses	array	Array of all address objects retrieved
	addresses.contactID	object	Type-value object specifying ContactID tied to given address
	addresses.contactKey	object	Type-value object specifying ContactKey tied to given address
	addresses.addressTypeID	integer	Type of the retrieved address: EMAIL: 1 MOBILE: 4 PUSH: 9 LINE: 10
	addresses.addressID	object	Type-value object specifying the AddressID for retrieved address
	addresses.addressKey	object	Type-value object specifying the AddressKey for retrieved address
	addresses.status	integer	Status value of retrieved address
	addresses.ordinal	integer	Ordinal value of retrieved address
	addresses.source	integer	Source value of retrieved address
	addresses.modifiedDate	string	Last modified date value of retrieved address
	addresses.valueSets	array	Object array containing value set information of pertinent attributes retrieved for address
	addresses.valueSets.definitionID	guid	Default ID assigned to represent the Set Definition of value Set information for retrieved address
	addresses.valueSets.definitionKey	string	Default key assigned to represent the Set Definition of value Set information for retrieved address
	addresses.valueSets.definitionName	string	Default name assigned to represent the Set Definition of value Set information for retrieved address
	addresses.valueSets.values	array	Object array containing property definition and actual value information of attributes retrieved for address
	addresses.valueSets.values.definitionID	guid	The value definition ID of a retrieved attribute for retrieved address
	addresses.valueSets.values.definitionKey	string	The value definition key of a retrieved attribute for retrieved address
	addresses.valueSets.values.definitionName	string	The value definition name of a retrieved attribute for retrieved address
	addresses.valueSets.values.valueID	guid	An auto-generated guid representing a retrieved attribute value for the retrieved address
	addresses.valueSets.values.innerValue	string	Actual value of a retrieved attribute for the retrieved address
	requestServiceMessageID	guid	Service message ID value of the request
	resultMessages	array	Array of returned messages generated while processing the request
	serviceMessageID	guid	Service message ID value of the response

default			Unexpected error
	pageNumber	integer	Page number of results retrieved
	pageSize	integer	Page size of results retrieved
	hasErrors	boolean	Indicates errors occured while processing the request
	requestServiceMessageID	guid	Service message ID value of request
	resultMessages	array	Array of returned error messages generated while processing request
	serviceMessageID	guid	Service message ID value of response