SurveyTale Docs

API Reference

Browse SurveyTale API operations.

Health Check

Check the health status of critical application dependencies including database and cache.

Get roles

Gets roles from the database.

Me

Fetches the workspaces and organizations associated with the API key.

Get responses

Gets responses from the database.

Create a response

Creates a response in the database. This will trigger the response pipeline, including webhooks, integrations, follow-up emails, and other configured actions.

Get a response

Gets a response from the database.

Delete a response

Deletes a response from the database.

Update a response

Updates a response in the database. This will trigger the response pipeline, including webhooks, integrations, follow-up emails (if the response is marked as finished), and other configured actions.

Upload Bulk Contacts

Uploads contacts in bulk. This endpoint expects the bulk request shape: `contacts` must be an array, and each contact item must contain an `attributes` array of `{ attributeKey, value }` objects. Unlike `POST /management/contacts`, this endpoint does not accept a top-level `attributes` object. Each contact must include an `email` attribute in its `attributes` array, and that email must be valid.

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.

Get contact attribute keys

Gets contact attribute keys from the database.

Create a contact attribute key

Creates a contact attribute key in the database.

Get a contact attribute key

Gets a contact attribute key from the database.

Delete a contact attribute key

Deletes a contact attribute key from the database.

Update a contact attribute key

Updates a contact attribute key in the database.

Get personalized survey link for a contact

Retrieves a personalized link for a specific survey.

Get survey links for contacts in a segment

Generates personalized survey links for contacts in a segment.

Get webhooks

Gets webhooks from the database.

Create a webhook

Creates a webhook in the database.

Get a webhook

Gets a webhook from the database.

Delete a webhook

Deletes a webhook from the database.

Update a webhook

Updates a webhook in the database.

Get teams

Gets teams from the database.

Create a team

Creates a team in the database.

Get a team

Gets a team from the database.

Delete a team

Deletes a team from the database.

Update a team

Updates a team in the database.

Get workspace teams

Gets workspaceTeams from the database.

Create a workspaceTeam

Creates a workspace team in the database.

Delete a workspace team

Deletes a workspace team from the database.

Update a workspace team

Updates a workspace team in the database.

Get users

Gets users from the database.<br />Only available for self-hosted SurveyTale.

Create a user

Create a new user in the database.<br />Only available for self-hosted SurveyTale.

Update a user

Updates an existing user in the database.<br />Only available for self-hosted SurveyTale.

Introduction

Start here for base URL, authentication, and the generated SurveyTale API reference.

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.