Skip to main content
GET
Get a survey draft

Authorizations

Authorization
string
header
required

An API key (utk_live_...) or an app's OAuth access token (uto_...).

Path Parameters

surveyId
string<uuid>
required

A survey id.

Response

The draft.

id
string<uuid>
required
name
string
required
status
enum<string>
required
Available options:
draft,
active,
paused,
archived
channel
enum<string>
required
Available options:
website,
link,
email
site
object | null
required
draftVersion
integer
required

Send it back as expectedDraftVersion.

editable
boolean
required

True only for a survey in draft status: the API edits nothing else.

editorUrl
string<uri>
required

The survey in the Usertick editor, where a person publishes it. Give it to the person.

defaultLanguage
string
required
languages
string[]
required
displayMode
enum<string>
required
Available options:
steps,
all,
chat
position
string
required
texts
object
required
targeting
object
required
questions
object[]
required
publishChecks
object[]
required

What publishing would refuse now: a report for the person who publishes. Nothing here blocks saving a draft.

createdAt
string<date-time>
required
Example:

"2026-09-30T10:00:00.000Z"

updatedAt
string<date-time>
required
Example:

"2026-09-30T10:00:00.000Z"

aiGenerated
boolean
required

True when Usertick AI wrote text in the survey's own fields; each question has its own. Read only.

aiGeneratedAt
string<date-time> | null
required

When text Usertick AI wrote was first stored here; null when people wrote all of it.

Example:

"2026-09-30T10:00:00.000Z"

Last modified on November 8, 2026