Get a survey text variable value

Overview

This endpoint retrieves a text variable value for a specific survey.

Authentication

This request requires an Authorization header with a valid token.

URL: GET https://api3.blocksurvey.io/v1/survey/text_variable_value

Query Parameters

Parameter
Type
Optional
Description

surveyId

String

No

The ID of the survey.

textVariableName

String

No

The name of the text variable.

teamId

String

Yes

The team ID.

cURL Example

curl --request GET \
 --url 'https://api3.blocksurvey.io/v1/survey/text_variable_value?surveyId=YOUR_SURVEY_ID&textVariableName=YOUR_TEXT_VARIABLE_NAME&teamId=YOUR_TEAM_ID' \
 --header  'Authorization: Bearer user_api_token'

Remember to replace YOUR_SURVEY_ID, YOUR_TEXT_VARIABLE_NAME, and YOUR_TEAM_ID with actual values when testing or using this API endpoint.

Response

Successful Response

{
  "status": "success",
  "textVariableValue": "abc"
}

Last updated