Skip to main content
GET
Get a survey's share link

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.

Query Parameters

language
string

One of the survey's languages: the link opens the survey in it (?lang= on the link). Another value is 400 PUB-009-001.

Maximum string length: 35
qr
enum<string>

svg adds the QR code of the link as SVG text. Another value is 400 PUB-009-002.

Available options:
svg

Response

The share link.

surveyId
string<uuid>
required
status
enum<string>
required
Available options:
draft,
active,
paused,
archived
channel
enum<string>
required
Available options:
website,
link,
email

Whether the survey's link is on. A person turns it on in Usertick; the API never changes it.

answering
boolean
required

True only while the link is on, the survey is live and Usertick hasn't suspended it.

url
string<uri> | null
required

The address people open to answer; null while link sharing is off or the survey has no link yet.

host
enum<string>
required

custom when the link is on the organization's own domain, usertick otherwise.

Available options:
custom,
usertick
customDomain
object | null
required

The custom domain the survey picked for its link, whatever its state.

language
string | null
required

The language the link opens in (the language parameter); null for the respondent's own.

languages
string[]
required

Every language the survey is written in.

qr
object | null
required

With qr=svg, the QR code of url; null otherwise and while url is null.

Last modified on November 8, 2026