API DOCUMENTATION Last Update: Apr 2022

Pre-Existing Report: Search Customers

Generate a report with all the customers who have a transaction between two date ranges in the selected campaigns, and whose information contains the search text.


The data to be submitted to the API is composed of the following fields:


  field   Example   Note
user_id john1970 Required
user_password 1959caadac9b13dcb3 Required
account_id greatwidgets Required
type reports Required
report customers_search Required
date_start 2010-01-01 Required
date_end 2011-12-31 Optional
selected_campaigns 123456789012,21987654321 Required
search_text Doe Required
include_transactions_search Y Optional
Output Format:
output JSON or XML Optional. If not provided, defaults to XML
callback someFunctionName Optional: JSONP format
condensed yes Optional (No white space)
Applies only to JSON(P) output



  • The date_start and date_end will restrict search results to only those customers that have had a transaction in that date range.
  • The date_start and date_end must be provided in ISO 8601 format: YYYY-MM-DD, where YYYY is the year in four-digit format, MM is the month in 2-digit format, and DD is the day of the month in two digit format. This avoids all sorts of confusion as to which part of the date is represented in which position and allows for better and more natural date-based sorting.
  • Separate each selected_campaigns with a comma (no spaces!)
  • The search_text will be searched across all customer's data, based on partial matching.
  • The include_transactions_search optional parameter allows searching across the customers' transactions data as well.


Example PHP Request:

If you are using PHP, the $data array would look like this:

  1. $data['user_id'] = 'john1970';
  2. $data['user_password'] = '1959caadac9b13dcb3';
  3. $data['account_id'] = 'greatwidgets';
  4. $data['type'] = 'reports';
  5. $data['report'] = 'customers_search';
  6. $data['search_text'] = 'cheese';
  7. $data['date_start'] = '2010-01-01';
  8. $data['date_end'] = '2011-12-31';
  9. $data['selected_campaigns'] = '123456789012,210987654321';


Success XML Response (New / Updated User):

  1. <response status="success">
  2. <customer>
  3. <first_name>Jane</first_name>
  4. <last_name>Doe</last_name>
  5. <phone>555-5555</phone>
  6. <email>jdoe@email.com</email>
  7. <address1>123 Main St.</address1>
  8. <address2>Apt 3G</address2>
  9. <city>Anytown</city>
  10. <state>ND</state>
  11. <zip>12345</zip>
  12. <country>NZ</country>
  13. <custom1>She likes cheese!</custom1>
  14. <custom_date>1970-07-14</custom_date>
  15. <customer_username>jdoe123</customer_username>
  16. <card_number>11111111</card_number>
  17. <customer_code>4137071924090694</customer_code>
  18. </customer>
  19. <customer>
  20. ...
  21. </customer>
  22. </response>


Error XML Response:

  1. <response status="error">
  2. <error>Error message</error>
  3. </response>