Using the SurveyTale API

SurveyTale provides a REST API so you can manage surveys, contacts, and responses programmatically and integrate SurveyTale with your own systems.

Full API reference

The complete, always up-to-date endpoint reference — every endpoint, parameter, and response schema — lives at docs.surveytale.com. It is generated directly from the API specification, so it is the single source of truth and never goes out of date.

Authentication

API requests are authenticated with an API key. See Generate API Key for how to create one, then pass it in the request headers as described in the reference.

The two API surfaces

• Client API — used by the SurveyTale SDK and in-app/website surveys (for example, identifying users and recording displays and responses).
• Management API — server-side, API-key authenticated. Use it to manage surveys, contacts, responses, webhooks, and other resources from your backend.

Getting started

1. Create an API key (see Generate API Key).
2. Open the full reference at docs.surveytale.com and pick the endpoint you need.
3. Make your request with the API key in the headers.

If you run into trouble, see our Troubleshooting & FAQ or contact support@surveytale.com.