Contact Info
303 N Glenoaks Blvd, Ste 200
Burbank, CA 91502
+1 (818) 858 1282
Follow Us

Reading Customers Data Through API

You are here:
< All Topics

1. Create a new API rule (similarly to or edit an existing one and assign the “customers” permission.

2. The customers data is available in both – JSON and CSV (comma separated) formats.

3. You can call search queries and fetch JSON results

The result is suitable for automation in third party tools and backends.
To obtain the JSON data, prepare the following URL:




To obtain the JSON data, prepare the following URL:




As long the JSON provides all the customer information, the CSV can be formatted to a file, ready for manual important into a third party systems (e.g. email lists).
The request URL will be of the type:




The output file will be ordered according to your web request.

Possible parameters:

  • id = the Synthesis account id
  • email = customer’s email address in lowercase
  • fullname = capitalized customer’s name
  • phone = self explanatory
  • balance = any customer balance held by Synthesis
  • widget = the widget used by the customer to subscribe
  • sessions = the number of sessions for the current customer (combines previous and upcoming)
  • regdate < or = or >  = extract customers based on date of registration. The date format is YYYY-MM-DD
  • [ANY custom field] = the identifier of the custom fields defined for the location

To request more parameters, please shoot us an email to

Previous Online Waivers
Next Reading Leaderboard Through API
Table of Contents