Skip to content

Get Survey

GET
/feedback/surveys/{survey_id}

Read one survey definition.

Authorizations

Parameters

Path Parameters

survey_id
required

Survey id (UUID) — from GET /feedback/surveys

string

Survey id (UUID) — from GET /feedback/surveys

Header Parameters

X-Target-Org-Id
Any of:
string

Responses

200

Successful Response

object
data
required
object
comment_mode
Any of:
string
created_at
Any of:
string format: date-time
delivery_channel
required
string
id
required
string
is_active
required
boolean
name
required
string
question_text
required
string
scale_max
required
integer
scale_min
required
integer
score_field_column_id
Any of:
string
template_id
Any of:
integer
thank_you_copy
Any of:
string
type
required
string
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string