HomeGuidesAPI Reference
API Reference
  1. SS Public API
  2. Surveys

Print Survey

get
https://{host}/v2/surveys//print

Render the survey as HTML, Word, or PDF based on the output type specified in the query string

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
int32
required

The survey id of the survey you want to print

Query Params
int32
enum
required

The output type you want to print the survey as.

Options: 1: Word doc | 2: HTML | 3: PDF

Allowed:
int32

The survey translation id to print the survey in.

boolean

Whether to include the title of the survey. (default: true)

boolean

Whether to include the logo. (default: true)

boolean

Whether to include question numbers. (default: true)

boolean

Whether to include page numbers. (default: true)

boolean

Whether to include page headings. (default: true)

boolean

Whether to include page descriptions. (default: true)

boolean

Whether to include page breaks. (default: true)

boolean

Whether to prevent breaking questions across pages. (default: true)

boolean

Whether to strip HTML tags from all questions. (default: false)

boolean

Whether to strip HTML tags from all answer choices. (default: false)

string
^#?(?:[0-9a-fA-F]{3}|[0-9a-fA-F]{6})$

The background color of the survey title. (default: #1170a8 - dark blue)

A 3- or 6-digit hex colour, with or without a leading # (sent URL-encoded as %23), for example ff0000, %23ff0000 or %23f00.

string
^#?(?:[0-9a-fA-F]{3}|[0-9a-fA-F]{6})$

The color of the survey title text. (default: #FFFFFF - white)

A 3- or 6-digit hex colour, with or without a leading # (sent URL-encoded as %23), for example ff0000, %23ff0000 or %23f00.

string
^#?(?:[0-9a-fA-F]{3}|[0-9a-fA-F]{6})$

The background color of the survey logo. (default: #FFFFFF - white)

A 3- or 6-digit hex colour, with or without a leading # (sent URL-encoded as %23), for example ff0000, %23ff0000 or %23f00.

string
^#?(?:[0-9a-fA-F]{3}|[0-9a-fA-F]{6})$

The background color of the page title. (default: #424242 - dark gray/black)

A 3- or 6-digit hex colour, with or without a leading # (sent URL-encoded as %23), for example ff0000, %23ff0000 or %23f00.

string
^#?(?:[0-9a-fA-F]{3}|[0-9a-fA-F]{6})$

The color of the page title text. (default: #FFFFFF - white)

A 3- or 6-digit hex colour, with or without a leading # (sent URL-encoded as %23), for example ff0000, %23ff0000 or %23f00.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Responses

Updated 5 months ago

Language
Credentials
Basic
base64
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/html
application/msword
application/pdf
text/plain
application/json
text/json

Updated 5 months ago