SurveyTale DocsOverview
The SurveyTale REST API — manage surveys, contacts, and responses programmatically.
Overview
The SurveyTale REST API lets you manage surveys, contacts, and responses programmatically and integrate SurveyTale with your own systems. This reference is generated from the checked-in OpenAPI 3.1 specification, so it always reflects the current API.
Authentication
API requests are authenticated with an API key. Create one in your SurveyTale workspace settings, then include it in your request headers as shown on each endpoint page.
Endpoints
Browse the endpoints in the sidebar — each one documents its method, path, parameters, request body, and response schema. Select an endpoint to see the full details and example payloads.
Slack
Send SurveyTale response notifications to Slack.
Create a contact
Creates a single contact in the database. This endpoint expects a top-level `attributes` object. For bulk uploads, use `PUT /management/contacts/bulk`, which expects `contacts[].attributes[]` instead. Each contact must have a valid email address in the attributes. All attribute keys must already exist in the environment. The email is used as the unique identifier along with the environment.