Reading Customers Data Through API

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 GET) https://api.synthesisvr.com/data/customers/<API_KEY>/json

Example:

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

————————

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

• (HTTP GET) https://api.synthesisvr.com/data/customers/<API_KEY>/search/<SEARCH>

Example:

• https://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 GET) https://api.synthesisvr.com/data/customers/<API_KEY>/csv/<PARAMETERS>

Example:

• https://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

————————

Profile Update (2022-11-18):

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

• (HTTP POST) https://api.synthesisvr.com/data/customers/<API_KEY>/<CUSTOMER_ID>

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
Host: api.synthesisvr.com
Content-Type: application/x-www-form-urlencoded
Content-Length: 43

values=%7B%22language%22%3A%22english%22%7D

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