Skip to main content
GET
curl

Authorizations

Authorization
string
header
required

Partner API key sent as Authorization: Bearer . Test keys and live keys are separate.

Path Parameters

slug
string
required

The questionnaire slug.

Query Parameters

product_id
string

Pick the questionnaire variant for this product.

locale
string

Language for the labels: one of en, es, zh. Any other value falls back to English.

Response

Success.

slug
string
required

Questionnaire slug.

schema_version
string
required

Version of the questionnaire schema.

schema_hash
string
required

The hash of exactly the schema in this response (localized when locale is set). Send it back with the submission: the current version's hash is accepted with or without a locale and in any supported locale; a stale hash is refused with 409 schema_outdated.

locale
string | null
required

The locale the labels are written in: the requested one, or en when it is not supported. null when no locale was requested (labels carry message keys only).

answer_format
enum<string>
required

The answer format to submit: entries-v1.

Available options:
entries-v1
upload_answer
object
required

How to answer an upload question.

schema
object
required

The questionnaire: steps, questions, options and validation rules.