Questions

Create a question

POST/v5/questions

List questions

GET/v5/questions

Get a question

GET/v5/questions/{question_id}

Update a question

PATCH/v5/questions/{question_id}

Archive a question

DELETE/v5/questions/{question_id}

Restore an archived question

POST/v5/questions/{question_id}/restore

ModelsExpand Collapse

CategoricalQuestion object { id, configuration, created_at, 7 more }

id: string

Unique identifier of the entity

configuration: CategoricalQuestionConfiguration { choices, dropdown, multi }

choices: array of string

Categorical answer choices (must contain at least one entry)

multi: optional boolean

Whether the question allows multiple answers.

created_at: string

ISO-timestamp when the entity was created

formatdate-time

created_by: Identity { id, type, object }

The identity that created the entity.

id: string

type: "user" or "service_account"

One of the following:

"user"

"service_account"

object: optional "identity"

prompt: string

user-facing question prompt

archived_at: optional string

ISO-timestamp when the entity was archived

formatdate-time

conditions: optional array of map[unknown]

Conditions for the question to be shown

object: optional "question"

question_type: optional "categorical"

CategoricalQuestionConfiguration object { choices, dropdown, multi }

choices: array of string

Categorical answer choices (must contain at least one entry)

multi: optional boolean

Whether the question allows multiple answers.

FormQuestion object { id, configuration, created_at, 7 more }

id: string

Unique identifier of the entity

configuration: FormQuestionConfiguration { form_schema }

form_schema: map[unknown]

The JSON schema of the desired form object

created_at: string

ISO-timestamp when the entity was created

formatdate-time

created_by: Identity { id, type, object }

The identity that created the entity.

id: string

type: "user" or "service_account"

One of the following:

"user"

"service_account"

object: optional "identity"

prompt: string

user-facing question prompt

archived_at: optional string

ISO-timestamp when the entity was archived

formatdate-time

conditions: optional array of map[unknown]

Conditions for the question to be shown

object: optional "question"

question_type: optional "form"

FormQuestionConfiguration object { form_schema }

form_schema: map[unknown]

The JSON schema of the desired form object

FreeTextQuestion object { id, created_at, created_by, 7 more }

id: string

Unique identifier of the entity

created_at: string

ISO-timestamp when the entity was created

formatdate-time

created_by: Identity { id, type, object }

The identity that created the entity.

id: string

type: "user" or "service_account"

One of the following:

"user"

"service_account"

object: optional "identity"

prompt: string

user-facing question prompt

archived_at: optional string

ISO-timestamp when the entity was archived

formatdate-time

conditions: optional array of map[unknown]

Conditions for the question to be shown

configuration: optional FreeTextQuestionConfiguration { max_length, min_length }

max_length: optional number

Maximum characters allowed

minimum1

min_length: optional number

Minimum characters required

minimum0

object: optional "question"

question_type: optional "free_text"

FreeTextQuestionConfiguration object { max_length, min_length }

max_length: optional number

Maximum characters allowed

minimum1

min_length: optional number

Minimum characters required

minimum0

NumberQuestion object { id, created_at, created_by, 7 more }

id: string

Unique identifier of the entity

created_at: string

ISO-timestamp when the entity was created

formatdate-time

created_by: Identity { id, type, object }

The identity that created the entity.

id: string

type: "user" or "service_account"

One of the following:

"user"

"service_account"

object: optional "identity"

prompt: string

user-facing question prompt

archived_at: optional string

ISO-timestamp when the entity was archived

formatdate-time

conditions: optional array of map[unknown]

Conditions for the question to be shown

configuration: optional NumberQuestionConfiguration { max, min }

max: optional number

Maximum value for the number

min: optional number

Minimum value for the number

object: optional "question"

question_type: optional "number"

NumberQuestionConfiguration object { max, min }

max: optional number

Maximum value for the number

min: optional number

Minimum value for the number

Question = CategoricalQuestion { id, configuration, created_at, 7 more } or RatingQuestion { id, configuration, created_at, 7 more } or NumberQuestion { id, created_at, created_by, 7 more } or 3 more

One of the following:

CategoricalQuestion object { id, configuration, created_at, 7 more }

id: string

Unique identifier of the entity

configuration: CategoricalQuestionConfiguration { choices, dropdown, multi }

choices: array of string

Categorical answer choices (must contain at least one entry)

multi: optional boolean

Whether the question allows multiple answers.

created_at: string

ISO-timestamp when the entity was created

formatdate-time

created_by: Identity { id, type, object }

The identity that created the entity.

id: string

type: "user" or "service_account"

One of the following:

"user"

"service_account"

object: optional "identity"

prompt: string

user-facing question prompt

archived_at: optional string

ISO-timestamp when the entity was archived

formatdate-time

conditions: optional array of map[unknown]

Conditions for the question to be shown

object: optional "question"

question_type: optional "categorical"

RatingQuestion object { id, configuration, created_at, 7 more }

id: string

Unique identifier of the entity

configuration: RatingQuestionConfiguration { max_label, min_label, steps }

max_label: string

Label shown for the maximum rating

min_label: string

Label shown for the minimum rating

steps: number

Number of discrete points on the scale (e.g., 5 for a 1–5 scale)

minimum1

created_at: string

ISO-timestamp when the entity was created

formatdate-time

created_by: Identity { id, type, object }

The identity that created the entity.

id: string

type: "user" or "service_account"

One of the following:

"user"

"service_account"

object: optional "identity"

prompt: string

user-facing question prompt

archived_at: optional string

ISO-timestamp when the entity was archived

formatdate-time

conditions: optional array of map[unknown]

Conditions for the question to be shown

object: optional "question"

question_type: optional "rating"

NumberQuestion object { id, created_at, created_by, 7 more }

id: string

Unique identifier of the entity

created_at: string

ISO-timestamp when the entity was created

formatdate-time

created_by: Identity { id, type, object }

The identity that created the entity.

id: string

type: "user" or "service_account"

One of the following:

"user"

"service_account"

object: optional "identity"

prompt: string

user-facing question prompt

archived_at: optional string

ISO-timestamp when the entity was archived

formatdate-time

conditions: optional array of map[unknown]

Conditions for the question to be shown

configuration: optional NumberQuestionConfiguration { max, min }

max: optional number

Maximum value for the number

min: optional number

Minimum value for the number

object: optional "question"

question_type: optional "number"

FreeTextQuestion object { id, created_at, created_by, 7 more }

id: string

Unique identifier of the entity

created_at: string

ISO-timestamp when the entity was created

formatdate-time

created_by: Identity { id, type, object }

The identity that created the entity.

id: string

type: "user" or "service_account"

One of the following:

"user"

"service_account"

object: optional "identity"

prompt: string

user-facing question prompt

archived_at: optional string

ISO-timestamp when the entity was archived

formatdate-time

conditions: optional array of map[unknown]

Conditions for the question to be shown

configuration: optional FreeTextQuestionConfiguration { max_length, min_length }

max_length: optional number

Maximum characters allowed

minimum1

min_length: optional number

Minimum characters required

minimum0

object: optional "question"

question_type: optional "free_text"

FormQuestion object { id, configuration, created_at, 7 more }

id: string

Unique identifier of the entity

configuration: FormQuestionConfiguration { form_schema }

form_schema: map[unknown]

The JSON schema of the desired form object

created_at: string

ISO-timestamp when the entity was created

formatdate-time

created_by: Identity { id, type, object }

The identity that created the entity.

id: string

type: "user" or "service_account"

One of the following:

"user"

"service_account"

object: optional "identity"

prompt: string

user-facing question prompt

archived_at: optional string

ISO-timestamp when the entity was archived

formatdate-time

conditions: optional array of map[unknown]

Conditions for the question to be shown

object: optional "question"

question_type: optional "form"

TimestampQuestion object { id, created_at, created_by, 7 more }

id: string

Unique identifier of the entity

created_at: string

ISO-timestamp when the entity was created

formatdate-time

created_by: Identity { id, type, object }

The identity that created the entity.

id: string

type: "user" or "service_account"

One of the following:

"user"

"service_account"

object: optional "identity"

prompt: string

user-facing question prompt

archived_at: optional string

ISO-timestamp when the entity was archived

formatdate-time

conditions: optional array of map[unknown]

Conditions for the question to be shown

configuration: optional TimestampQuestionConfiguration { multi }

multi: optional boolean

Whether to allow multiple timestamps

object: optional "question"

question_type: optional "timestamp"

RatingQuestion object { id, configuration, created_at, 7 more }

id: string

Unique identifier of the entity

configuration: RatingQuestionConfiguration { max_label, min_label, steps }

max_label: string

Label shown for the maximum rating

min_label: string

Label shown for the minimum rating

steps: number

Number of discrete points on the scale (e.g., 5 for a 1–5 scale)

minimum1

created_at: string

ISO-timestamp when the entity was created

formatdate-time

created_by: Identity { id, type, object }

The identity that created the entity.

id: string

type: "user" or "service_account"

One of the following:

"user"

"service_account"

object: optional "identity"

prompt: string

user-facing question prompt

archived_at: optional string

ISO-timestamp when the entity was archived

formatdate-time

conditions: optional array of map[unknown]

Conditions for the question to be shown

object: optional "question"

question_type: optional "rating"

RatingQuestionConfiguration object { max_label, min_label, steps }

max_label: string

Label shown for the maximum rating

min_label: string

Label shown for the minimum rating

steps: number

Number of discrete points on the scale (e.g., 5 for a 1–5 scale)

minimum1

TimestampQuestion object { id, created_at, created_by, 7 more }

id: string

Unique identifier of the entity

created_at: string

ISO-timestamp when the entity was created

formatdate-time

created_by: Identity { id, type, object }

The identity that created the entity.

id: string

type: "user" or "service_account"

One of the following:

"user"

"service_account"

object: optional "identity"

prompt: string

user-facing question prompt

archived_at: optional string

ISO-timestamp when the entity was archived

formatdate-time

conditions: optional array of map[unknown]

Conditions for the question to be shown

configuration: optional TimestampQuestionConfiguration { multi }

multi: optional boolean

Whether to allow multiple timestamps

object: optional "question"

question_type: optional "timestamp"

TimestampQuestionConfiguration object { multi }

multi: optional boolean

Whether to allow multiple timestamps