Reading Customers Data Through API

Table of Contents

How Can We Help?

Reading Customers Data Through API

You are here:

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:

  • (HTTP GET)<API_KEY>/json




To obtain the JSON data, prepare the following URL:

  • (HTTP GET)<API_KEY>/search/<SEARCH>




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


Profile Update (2022-11-18):

You can update customer profiles by performing HTTP POST request against the following URL:


All the new data should be in JSON format. The final JSON object is stringified and included in the request’s BODY with the “values” parameter.

Example raw HTTP POST request:

POST /data/customers/11111111-1111-1111-1111-111111111111/123456789 HTTP/1.1
Content-Type: application/x-www-form-urlencoded
Content-Length: 43


You can include as many JSON key-value pairs as needed.

Sign Up For Your Trial