API Reference

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Questions

Create a question

client.questions.create(QuestionCreateParams { question } params, RequestOptionsoptions?): Question

POST/v5/questions

List questions

client.questions.list(QuestionListParams { ending_before, ids, include_archived, 4 more } query?, RequestOptionsoptions?): CursorPage<Question>

GET/v5/questions

Get a question

client.questions.retrieve(stringquestionID, RequestOptionsoptions?): Question

GET/v5/questions/{question_id}

Update a question

client.questions.update(stringquestionID, QuestionUpdateParams { name } body, RequestOptionsoptions?): Question

PATCH/v5/questions/{question_id}

Archive a question

client.questions.archive(stringquestionID, RequestOptionsoptions?): Question

DELETE/v5/questions/{question_id}

Restore an archived question

client.questions.restore(stringquestionID, RequestOptionsoptions?): Question

POST/v5/questions/{question_id}/restore

ModelsExpand Collapse

CategoricalQuestion { id, configuration, created_at, 7 more }

id: string

Unique identifier of the entity

configuration: CategoricalQuestionConfiguration { choices, dropdown, multi }

choices: Array<string>

Categorical answer choices (must contain at least one entry)

dropdown?: boolean

Whether the question is displayed as a dropdown in the UI.

multi?: 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" | "service_account"

One of the following:

"user"

"service_account"

object?: "identity"

name: string

prompt: string

user-facing question prompt

archived_at?: string

ISO-timestamp when the entity was archived

formatdate-time

conditions?: Array<Record<string, unknown>>

Conditions for the question to be shown

object?: "question"

question_type?: "categorical"

CategoricalQuestionConfiguration { choices, dropdown, multi }

choices: Array<string>

Categorical answer choices (must contain at least one entry)

dropdown?: boolean

Whether the question is displayed as a dropdown in the UI.

multi?: boolean

Whether the question allows multiple answers.

FormQuestion { id, configuration, created_at, 7 more }

id: string

Unique identifier of the entity

configuration: FormQuestionConfiguration { form_schema }

form_schema: Record<string, 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" | "service_account"

One of the following:

"user"

"service_account"

object?: "identity"

name: string

prompt: string

user-facing question prompt

archived_at?: string

ISO-timestamp when the entity was archived

formatdate-time

conditions?: Array<Record<string, unknown>>

Conditions for the question to be shown

object?: "question"

question_type?: "form"

FormQuestionConfiguration { form_schema }

form_schema: Record<string, unknown>

The JSON schema of the desired form object

FreeTextQuestion { 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" | "service_account"

One of the following:

"user"

"service_account"

object?: "identity"

name: string

prompt: string

user-facing question prompt

archived_at?: string

ISO-timestamp when the entity was archived

formatdate-time

conditions?: Array<Record<string, unknown>>

Conditions for the question to be shown

configuration?: FreeTextQuestionConfiguration { max_length, min_length }

max_length?: number

Maximum characters allowed

minimum1

min_length?: number

Minimum characters required

minimum0

object?: "question"

question_type?: "free_text"

FreeTextQuestionConfiguration { max_length, min_length }

max_length?: number

Maximum characters allowed

minimum1

min_length?: number

Minimum characters required

minimum0

NumberQuestion { 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" | "service_account"

One of the following:

"user"

"service_account"

object?: "identity"

name: string

prompt: string

user-facing question prompt

archived_at?: string

ISO-timestamp when the entity was archived

formatdate-time

conditions?: Array<Record<string, unknown>>

Conditions for the question to be shown

configuration?: NumberQuestionConfiguration { max, min }

max?: number

Maximum value for the number

min?: number

Minimum value for the number

object?: "question"

question_type?: "number"

NumberQuestionConfiguration { max, min }

max?: number

Maximum value for the number

min?: number

Minimum value for the number

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

One of the following:

CategoricalQuestion { id, configuration, created_at, 7 more }

id: string

Unique identifier of the entity

configuration: CategoricalQuestionConfiguration { choices, dropdown, multi }

choices: Array<string>

Categorical answer choices (must contain at least one entry)

dropdown?: boolean

Whether the question is displayed as a dropdown in the UI.

multi?: 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" | "service_account"

One of the following:

"user"

"service_account"

object?: "identity"

name: string

prompt: string

user-facing question prompt

archived_at?: string

ISO-timestamp when the entity was archived

formatdate-time

conditions?: Array<Record<string, unknown>>

Conditions for the question to be shown

object?: "question"

question_type?: "categorical"

RatingQuestion { 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" | "service_account"

One of the following:

"user"

"service_account"

object?: "identity"

name: string

prompt: string

user-facing question prompt

archived_at?: string

ISO-timestamp when the entity was archived

formatdate-time

conditions?: Array<Record<string, unknown>>

Conditions for the question to be shown

object?: "question"

question_type?: "rating"

NumberQuestion { 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" | "service_account"

One of the following:

"user"

"service_account"

object?: "identity"

name: string

prompt: string

user-facing question prompt

archived_at?: string

ISO-timestamp when the entity was archived

formatdate-time

conditions?: Array<Record<string, unknown>>

Conditions for the question to be shown

configuration?: NumberQuestionConfiguration { max, min }

max?: number

Maximum value for the number

min?: number

Minimum value for the number

object?: "question"

question_type?: "number"

FreeTextQuestion { 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" | "service_account"

One of the following:

"user"

"service_account"

object?: "identity"

name: string

prompt: string

user-facing question prompt

archived_at?: string

ISO-timestamp when the entity was archived

formatdate-time

conditions?: Array<Record<string, unknown>>

Conditions for the question to be shown

configuration?: FreeTextQuestionConfiguration { max_length, min_length }

max_length?: number

Maximum characters allowed

minimum1

min_length?: number

Minimum characters required

minimum0

object?: "question"

question_type?: "free_text"

FormQuestion { id, configuration, created_at, 7 more }

id: string

Unique identifier of the entity

configuration: FormQuestionConfiguration { form_schema }

form_schema: Record<string, 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" | "service_account"

One of the following:

"user"

"service_account"

object?: "identity"

name: string

prompt: string

user-facing question prompt

archived_at?: string

ISO-timestamp when the entity was archived

formatdate-time

conditions?: Array<Record<string, unknown>>

Conditions for the question to be shown

object?: "question"

question_type?: "form"

TimestampQuestion { 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" | "service_account"

One of the following:

"user"

"service_account"

object?: "identity"

name: string

prompt: string

user-facing question prompt

archived_at?: string

ISO-timestamp when the entity was archived

formatdate-time

conditions?: Array<Record<string, unknown>>

Conditions for the question to be shown

configuration?: TimestampQuestionConfiguration { multi }

multi?: boolean

Whether to allow multiple timestamps

object?: "question"

question_type?: "timestamp"

RatingQuestion { 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" | "service_account"

One of the following:

"user"

"service_account"

object?: "identity"

name: string

prompt: string

user-facing question prompt

archived_at?: string

ISO-timestamp when the entity was archived

formatdate-time

conditions?: Array<Record<string, unknown>>

Conditions for the question to be shown

object?: "question"

question_type?: "rating"

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

TimestampQuestion { 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" | "service_account"

One of the following:

"user"

"service_account"

object?: "identity"

name: string

prompt: string

user-facing question prompt

archived_at?: string

ISO-timestamp when the entity was archived

formatdate-time

conditions?: Array<Record<string, unknown>>

Conditions for the question to be shown

configuration?: TimestampQuestionConfiguration { multi }

multi?: boolean

Whether to allow multiple timestamps

object?: "question"

question_type?: "timestamp"

TimestampQuestionConfiguration { multi }

multi?: boolean

Whether to allow multiple timestamps