searchCustomers

Purpose:

This method used to get the number of leads in Apptivo based on the email address.

Request URL:

https://api.apptivo.com/app/dao/v6/customers?a=getAllByAdvancedSearch&numRecords=NUM_OF_RECORDS&searchData={SEARCH_DATA}&multiSelectData={}&apiKey=API_KEY&accesKey=ACCESS_KEY

Request Parameters:

Parameter Data Type Description
SEARCH_DATA search data with Json format please see the sample request URL
NUM_OF_RECORDS number of records to return
SESSION_KEY Apptivo session key from username and password

* – Mandatory parameters

Output:

This will return the number of customers with JSON format.

Sample Request URL:

https://www.apptivo.com/app/dao/v6/customers?a=getAllByAdvancedSearch
&startIndex=0
&numRecords=50
&iDisplayLength=50
&iDisplayStart=0
&searchData={"customerName":"","customerNumber":"test","assigneeObjectRefName":null,"assigneeObjectId":null,"assigneeObjectRefId":null,"description":"","followUpDescription":"","phoneNumbers":[],"emailAddresses":[],"skypeName":"","parentCustomerName":"","parentCustomerId":null,"website":"","tickerSymbol":"","campaignName":"","campaignId":null,"creditRating":"","territoryName":"","territoryId":null,"ownership":"","faceBookURL":"","twitterURL":"","linkedInURL":"","isUnsubscribed":null,"isBounced":null,"isResponded":null,"creationOnStartDate":"","creationOnEndDate":"","creationDateDuration":"","creationDateDurationTypeId":"","creationDateRangeTypeId":"","lastUpdateOnStartDate":"","lastUpdateOnEndDate":"","lastUpdateDateDuration":"","lastUpdateDateDurationTypeId":"","lastUpdateDateRangeTypeId":"","customAttributes":[],"addresses":[{"addressAttributeId":"address_section_attr_id","addressGroupName":"Address1","addressType":"","state":"","stateCode":"","stateId":null,"stateName":""}]}
multiSelectData:{"marketIds":[],"categoryIds":[],"statusIds":[],"employeeRangeIds":[],"paymentTermIds":[],"slaIds":[],"industryIds":[],"segmentIds":[]}
&objectId=3
&territoryType=MULTIPLE