Survey Tale provides two REST APIs designed for flexibility in both client-side and server-side integrations.
Each API serves a specific purpose, with distinct authentication and data-access scopes.
Public Client API
The Public Client API powers our SDKs and is designed for browser- or app-based interactions.
It does not require authentication, allowing you to collect responses securely without exposing sensitive keys.
Typical use cases:
Display a survey or mark it as shown on a page.
Create and update survey responses from your website or app.
Available Client API Methods
Displays API – mark a survey as displayed, or link a display to a response for a visitor or contact.
Responses API – create and update a response for any active survey.
Client endpoints are fully CORS-enabled and safe for public usage.
Management API
The Management API provides full programmatic access to your Survey Tale account.
It requires a personal API key that you can generate and manage from your Survey Tale dashboard under Settings → API Keys.
This API is intended for secure backend servers or integrations (for example, Zapier, Make, or internal analytics pipelines).
Available Management API Methods
| Area | Description |
|---|---|
| Action Class API | Create, list, and delete custom action classes used for automations. |
| Attribute Class API | Create, list, and delete attribute classes for segmenting contacts or responses. |
| Me API | Retrieve account and environment information associated with your API key. |
| People API | List and delete people or contacts within an environment. |
| Response API | List all responses, list by survey, update, or delete existing responses. |
| Survey API | List, create, update, generate single-use links, and delete surveys. |
| Webhook API | List, create, and delete webhooks for response events. |
Authentication
All Management API calls require your API key to be sent in the header:
x-api-key: YOUR_API_KEY
Example:
curl -H "x-api-key: YOUR_API_KEY" https://app.surveytale.com/api/v1/management/me
Base URL
All endpoints use the same root:
https://app.surveytale.com/api/v1
Was this article helpful?
That’s Great!
Thank you for your feedback
Sorry! We couldn't be helpful
Thank you for your feedback
Feedback sent
We appreciate your effort and will try to fix the article