Questions

questions

Methods

Create Question ->
post/v5/questions

Create Question

List Questions -> CursorPage<>
get/v5/questions

List Questions

query Parameters
ending_before: string
Optional
ids: Array<string>
Optional
include_archived: boolean
Optional
limit: number
Optional
(maximum: 10000, minimum: 1, default: 100)
sort_by: string
Optional
sort_order:
Optional
starting_after: string
Optional
Response fields
has_more: boolean

Whether there are more items left to be fetched.

items: Array<>
total: number

The total of items that match the query. This is greater than or equal to the number of items returned.

limit: number
Optional
(default: 100)

The maximum number of items to return.

object: "list"
Optional
(default: "list")
Request example
200Example
Get Question ->
get/v5/questions/{question_id}

Get Question

Update Question ->
patch/v5/questions/{question_id}

Update Question

Archive Question ->
delete/v5/questions/{question_id}

Archive a question by setting archived_at in the db

Restore Archived Question ->
post/v5/questions/{question_id}/restore

Restore Archived Question

Domain types

CategoricalQuestion = { id, configuration, created_at, 7 more... }
CategoricalQuestionConfiguration = { choices, dropdown, multi }
FormQuestion = { id, configuration, created_at, 7 more... }
FormQuestionConfiguration = { form_schema }
FreeTextQuestion = { id, created_at, created_by, 7 more... }
FreeTextQuestionConfiguration = { max_length, min_length }
NumberQuestion = { id, created_at, created_by, 7 more... }
NumberQuestionConfiguration = { max, min }
RatingQuestion = { id, configuration, created_at, 7 more... }
RatingQuestionConfiguration = { max_label, min_label, steps }
TimestampQuestion = { id, created_at, created_by, 7 more... }
TimestampQuestionConfiguration = { multi }