Get a survey draft
curl --request GET \
--url https://app.usertick.com/api/public/v1/surveys/{surveyId}/draft \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://app.usertick.com/api/public/v1/surveys/{surveyId}/draft', 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}/draft"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"id": "11111111-1111-4111-8111-111111111111",
"name": "Checkout NPS",
"status": "draft",
"channel": "website",
"site": {
"id": "22222222-2222-4222-8222-222222222222",
"domain": "shop.example.com"
},
"draftVersion": 1,
"editable": true,
"editorUrl": "https://app.usertick.com/surveys?edit=11111111-1111-4111-8111-111111111111&org=3c9e4e1a-5b7d-4f20-9a61-0c2d8e4f6a10",
"defaultLanguage": "en",
"languages": [
"en"
],
"displayMode": "steps",
"position": "bottom-right",
"texts": {},
"targeting": {
"pages": null,
"trigger": {
"type": "delay",
"seconds": 5
},
"devices": [
"desktop",
"tablet",
"mobile"
],
"frequency": {
"type": "until_response",
"cooldownDays": 30,
"maxDisplays": 0,
"afterDismissDays": 0
},
"extraSettings": false
},
"questions": [
{
"id": "a0000000-0000-4000-8000-000000000005",
"ref": "q1",
"type": "nps",
"text": "How likely are you to recommend Usertick?",
"required": true,
"lowLabel": "Not likely",
"highLabel": "Very likely",
"logic": [],
"aiGenerated": false,
"aiGeneratedAt": null
}
],
"publishChecks": [],
"createdAt": "2026-11-03T10:00:00.000Z",
"updatedAt": "2026-11-03T10:00:00.000Z",
"aiGenerated": false,
"aiGeneratedAt": null
}
Get a survey draft
A survey in the typed shape with its draft revision (draftVersion), its editor link (editorUrl) and what publishing would refuse now (publishChecks). Any status: editable is true only for a survey in draft status, the one kind the API edits. A question that holds settings the typed shape doesn’t show says extraSettings: true, and an edit keeps them.
Scopes: surveys:read.
GET
/
surveys
/
{surveyId}
/
draft
Get a survey draft
curl --request GET \
--url https://app.usertick.com/api/public/v1/surveys/{surveyId}/draft \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://app.usertick.com/api/public/v1/surveys/{surveyId}/draft', 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}/draft"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"id": "11111111-1111-4111-8111-111111111111",
"name": "Checkout NPS",
"status": "draft",
"channel": "website",
"site": {
"id": "22222222-2222-4222-8222-222222222222",
"domain": "shop.example.com"
},
"draftVersion": 1,
"editable": true,
"editorUrl": "https://app.usertick.com/surveys?edit=11111111-1111-4111-8111-111111111111&org=3c9e4e1a-5b7d-4f20-9a61-0c2d8e4f6a10",
"defaultLanguage": "en",
"languages": [
"en"
],
"displayMode": "steps",
"position": "bottom-right",
"texts": {},
"targeting": {
"pages": null,
"trigger": {
"type": "delay",
"seconds": 5
},
"devices": [
"desktop",
"tablet",
"mobile"
],
"frequency": {
"type": "until_response",
"cooldownDays": 30,
"maxDisplays": 0,
"afterDismissDays": 0
},
"extraSettings": false
},
"questions": [
{
"id": "a0000000-0000-4000-8000-000000000005",
"ref": "q1",
"type": "nps",
"text": "How likely are you to recommend Usertick?",
"required": true,
"lowLabel": "Not likely",
"highLabel": "Very likely",
"logic": [],
"aiGenerated": false,
"aiGeneratedAt": null
}
],
"publishChecks": [],
"createdAt": "2026-11-03T10:00:00.000Z",
"updatedAt": "2026-11-03T10:00:00.000Z",
"aiGenerated": false,
"aiGeneratedAt": null
}
Authorizations
bearerAuthapiKeyHeader
Response
The draft.
Last modified on November 8, 2026