User Manual >> Documentation >> Developer API >> Customers API Reference >> AdvancedsearchCustomers

AdvancedsearchCustomers

Purpose:

This method used to search the number of Customers in Apptivo using the Advanced Search.

https://api.apptivo.com/app/dao/v6/customers?a=getAllBySearchText&startIndex=startIndex&numRecords=numRecords&searchText={SEARCH_DATA}Id=3&apiKey=API_KEY&accessKey=ACCESS_KEY

Request Parameters:

Parameter Data Type Values Description
BaseURL https://api.apptivo.com/app/dao/v6/customers customer ‘s app API Base URL
a getAllByAdvancedSearch Action
startIndex 0 Starting index of total records
numRecords 50 Total records which we want to retrieve
searchData JSON {“customerName”:”ABC”} Text which we want to search
apiKey* String ZMQYFZTzBXAW-DoPSURDtNVBUEY-518d51ae-ab26-4c04-9f7b-8d26a586e90e Apptivo API Key
accessKey* String SqQxOzQZDvUT-fTsOrItIVDUGyV-5c90b8a3-4683-4145-8584-1ed40de970b9 Apptivo Access Key

* – Mandatory parameters

Output:

This will return the customers with JSON format.

Sample Request URL:

https://api.apptivo.com/app/dao/v6/customers?a=getAllByAdvancedSearch&startIndex=0&numRecords=50&searchData={"customerName":"ABC"}&apiKey=ZMQYFZTzBXAW-DoPSURDtNVBUEY-518d51ae-ab26-4c04-9f7b-8d26a586e90e&accessKey=SqQxOzQZDvUT-fTsOrItIVDUGyV-5c90b8a3-4683-4145-8584-1ed40de970b9

Sample Response

{"data":[{recordDetails},{recordDetails},{recordDetails},{recordDetails},{recordDetails}],"countOfRecords":5}