Contact Info
19524 Nordhoff St, Suite 3A
Los Angeles, CA 91324
info@synthesisvr.com
+1 (818) 858 1282
Follow Us

Reading Customers Data Through API

You are here:
  • Main
  • API
  • Reading Customers Data Through API
< All Topics

1. Create a new API rule (similarly to https://synthesisvr.com/knowledge-base/reading-leaderboard-through-api/) 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


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

  • http://api.synthesisvr.com/data/customers/<API_KEY>/json

Example:

  • http://api.synthesisvr.com/data/customers/11111111-1111-1111-1111-111111111111/json

JSON SEARCH:
To obtain the JSON data, prepare the following URL:

  • http://api.synthesisvr.com/data/customers/<API_KEY>/search/<SEARCH>

Example:

  • http://api.synthesisvr.com/data/customers/11111111-1111-1111-1111-111111111111/search/email@domain.com

CSV:
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:

  • http://api.synthesisvr.com/data/customers/<API_KEY>/csv/<PARAMETERS>

Example:

  • http://api.synthesisvr.com/data/customers/11111111-1111-1111-1111-111111111111/csv/fullname,email,phone

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 info@synthesisvr.com

Table of Contents