API Guide

The ShopSurvey REST API is available to you to manage your account programmatically. Here are a few things you can do with the API:

• Manage respondents

• Manage audiences

• Add and remove respondents from your audiences

• Send invites

• Manage webhooks

• Pull survey response data

Getting Started

To start using the ShopSurvey API, go to API Keys & Webhooks and create a new API Key. Next, you will want to choose the permissions that restrict access to just what you intend to use the API Key for.

API Keys are like passwords for your account. Please store them securely and never commit them to your source code. Only use them on the server side to avoid exposing them to unauthorized users.

Once you've obtained the API Key, you can make requests to our Public API URL endpoint:

https://api.shopsurvey.app/v1

You must send your API Key to the API using the following Auth Headers:

X-SHOPSURVEY-TOKEN: ******************e99e45

Here's an example of how you'd request to get a list of surveys from your account:

curl -X 'GET' \
  'https://api.shopsurvey.app/v1/surveys' \
  -H 'accept: application/json' \
  -H 'X-SHOPSURVEY-TOKEN: ******************e99e45'

REST API Reference

Please refer to our Interactive REST API Reference to browse through our available endpoints and test making requests to them directly in the browser.

Rate Limits

We impose a 6 requests/second rate limit on our API. If you exceed this limit, our API will return 429 Too Many Requests error. This helps us keep our services reliable for all of our customers. If you regularly exceed this limit, don't hesitate to contact us.