Get a survey
curl --request GET \
--url https://app.usertick.com/api/public/v1/surveys/{surveyId} \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://app.usertick.com/api/public/v1/surveys/{surveyId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://app.usertick.com/api/public/v1/surveys/{surveyId}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"status": "draft",
"channel": "website",
"site": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"domain": "<string>"
},
"counts": {
"responses": 123,
"last7Days": 123,
"lastResponseAt": "2026-09-30T10:00:00.000Z"
},
"url": "<string>",
"createdAt": "2026-09-30T10:00:00.000Z",
"updatedAt": "2026-09-30T10:00:00.000Z",
"defaultLanguage": "en",
"languages": [
"<string>"
],
"settings": {
"position": "bottom_right",
"displayMode": "all",
"linkSharing": true,
"variants": 123
},
"questions": [
{
"id": "<string>",
"position": 123,
"type": "nps",
"text": "<string>",
"required": true,
"choices": [
{
"id": "<string>",
"label": "<string>"
}
],
"scale": {
"min": 123,
"max": 123,
"step": 123,
"minLabel": "<string>",
"maxLabel": "<string>"
}
}
]
}Surveys
Get a survey
One survey with its published questions (type, required, options, scale), its languages and a settings summary.
Scopes: surveys:read.
GET
/
surveys
/
{surveyId}
Get a survey
curl --request GET \
--url https://app.usertick.com/api/public/v1/surveys/{surveyId} \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://app.usertick.com/api/public/v1/surveys/{surveyId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://app.usertick.com/api/public/v1/surveys/{surveyId}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"status": "draft",
"channel": "website",
"site": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"domain": "<string>"
},
"counts": {
"responses": 123,
"last7Days": 123,
"lastResponseAt": "2026-09-30T10:00:00.000Z"
},
"url": "<string>",
"createdAt": "2026-09-30T10:00:00.000Z",
"updatedAt": "2026-09-30T10:00:00.000Z",
"defaultLanguage": "en",
"languages": [
"<string>"
],
"settings": {
"position": "bottom_right",
"displayMode": "all",
"linkSharing": true,
"variants": 123
},
"questions": [
{
"id": "<string>",
"position": 123,
"type": "nps",
"text": "<string>",
"required": true,
"choices": [
{
"id": "<string>",
"label": "<string>"
}
],
"scale": {
"min": 123,
"max": 123,
"step": 123,
"minLabel": "<string>",
"maxLabel": "<string>"
}
}
]
}Authorizations
bearerAuthapiKeyHeader
An API key (utk_live_...) or an app's OAuth access token (uto_...).
Path Parameters
A survey id.
Response
The survey.
Available options:
draft, active, paused, archived Available options:
website, link, email Show child attributes
Show child attributes
Responses the plan shows, from its retention window; null when they could not be read.
Show child attributes
Show child attributes
The survey in the dashboard.
Example:
"2026-09-30T10:00:00.000Z"
Example:
"2026-09-30T10:00:00.000Z"
Example:
"en"
Every language the survey is written in.
Show child attributes
Show child attributes
Show child attributes
Show child attributes