API Reference

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Questions

Create a question

questions.create(QuestionCreateParams**kwargs) -> Question

POST/v5/questions

List questions

questions.list(QuestionListParams**kwargs) -> SyncCursorPage[Question]

GET/v5/questions

Get a question

questions.retrieve(strquestion_id) -> Question

GET/v5/questions/{question_id}

Update a question

questions.update(strquestion_id, QuestionUpdateParams**kwargs) -> Question

PATCH/v5/questions/{question_id}

Archive a question

questions.archive(strquestion_id) -> Question

DELETE/v5/questions/{question_id}

Restore an archived question

questions.restore(strquestion_id) -> Question

POST/v5/questions/{question_id}/restore

ModelsExpand Collapse

class CategoricalQuestion: …

id: str

Unique identifier of the entity

configuration: CategoricalQuestionConfiguration

choices: List[str]

Categorical answer choices (must contain at least one entry)

dropdown: Optional[bool]

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

multi: Optional[bool]

Whether the question allows multiple answers.

created_at: datetime

ISO-timestamp when the entity was created

formatdate-time

created_by: Identity

The identity that created the entity.

id: str

type: Literal["user", "service_account"]

One of the following:

"user"

"service_account"

object: Optional[Literal["identity"]]

name: str

prompt: str

user-facing question prompt

archived_at: Optional[datetime]

ISO-timestamp when the entity was archived

formatdate-time

conditions: Optional[List[Dict[str, object]]]

Conditions for the question to be shown

object: Optional[Literal["question"]]

question_type: Optional[Literal["categorical"]]

class CategoricalQuestionConfiguration: …

choices: List[str]

Categorical answer choices (must contain at least one entry)

dropdown: Optional[bool]

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

multi: Optional[bool]

Whether the question allows multiple answers.

class FormQuestion: …

id: str

Unique identifier of the entity

configuration: FormQuestionConfiguration

form_schema: Dict[str, object]

The JSON schema of the desired form object

created_at: datetime

ISO-timestamp when the entity was created

formatdate-time

created_by: Identity

The identity that created the entity.

id: str

type: Literal["user", "service_account"]

One of the following:

"user"

"service_account"

object: Optional[Literal["identity"]]

name: str

prompt: str

user-facing question prompt

archived_at: Optional[datetime]

ISO-timestamp when the entity was archived

formatdate-time

conditions: Optional[List[Dict[str, object]]]

Conditions for the question to be shown

object: Optional[Literal["question"]]

question_type: Optional[Literal["form"]]

class FormQuestionConfiguration: …

form_schema: Dict[str, object]

The JSON schema of the desired form object

class FreeTextQuestion: …

id: str

Unique identifier of the entity

created_at: datetime

ISO-timestamp when the entity was created

formatdate-time

created_by: Identity

The identity that created the entity.

id: str

type: Literal["user", "service_account"]

One of the following:

"user"

"service_account"

object: Optional[Literal["identity"]]

name: str

prompt: str

user-facing question prompt

archived_at: Optional[datetime]

ISO-timestamp when the entity was archived

formatdate-time

conditions: Optional[List[Dict[str, object]]]

Conditions for the question to be shown

configuration: Optional[FreeTextQuestionConfiguration]

max_length: Optional[int]

Maximum characters allowed

minimum1

min_length: Optional[int]

Minimum characters required

minimum0

object: Optional[Literal["question"]]

question_type: Optional[Literal["free_text"]]

class FreeTextQuestionConfiguration: …

max_length: Optional[int]

Maximum characters allowed

minimum1

min_length: Optional[int]

Minimum characters required

minimum0

class NumberQuestion: …

id: str

Unique identifier of the entity

created_at: datetime

ISO-timestamp when the entity was created

formatdate-time

created_by: Identity

The identity that created the entity.

id: str

type: Literal["user", "service_account"]

One of the following:

"user"

"service_account"

object: Optional[Literal["identity"]]

name: str

prompt: str

user-facing question prompt

archived_at: Optional[datetime]

ISO-timestamp when the entity was archived

formatdate-time

conditions: Optional[List[Dict[str, object]]]

Conditions for the question to be shown

configuration: Optional[NumberQuestionConfiguration]

max: Optional[float]

Maximum value for the number

min: Optional[float]

Minimum value for the number

object: Optional[Literal["question"]]

question_type: Optional[Literal["number"]]

class NumberQuestionConfiguration: …

max: Optional[float]

Maximum value for the number

min: Optional[float]

Minimum value for the number

Question

One of the following:

class CategoricalQuestion: …

id: str

Unique identifier of the entity

configuration: CategoricalQuestionConfiguration

choices: List[str]

Categorical answer choices (must contain at least one entry)

dropdown: Optional[bool]

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

multi: Optional[bool]

Whether the question allows multiple answers.

created_at: datetime

ISO-timestamp when the entity was created

formatdate-time

created_by: Identity

The identity that created the entity.

id: str

type: Literal["user", "service_account"]

One of the following:

"user"

"service_account"

object: Optional[Literal["identity"]]

name: str

prompt: str

user-facing question prompt

archived_at: Optional[datetime]

ISO-timestamp when the entity was archived

formatdate-time

conditions: Optional[List[Dict[str, object]]]

Conditions for the question to be shown

object: Optional[Literal["question"]]

question_type: Optional[Literal["categorical"]]

class RatingQuestion: …

id: str

Unique identifier of the entity

configuration: RatingQuestionConfiguration

max_label: str

Label shown for the maximum rating

min_label: str

Label shown for the minimum rating

steps: int

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

minimum1

created_at: datetime

ISO-timestamp when the entity was created

formatdate-time

created_by: Identity

The identity that created the entity.

id: str

type: Literal["user", "service_account"]

One of the following:

"user"

"service_account"

object: Optional[Literal["identity"]]

name: str

prompt: str

user-facing question prompt

archived_at: Optional[datetime]

ISO-timestamp when the entity was archived

formatdate-time

conditions: Optional[List[Dict[str, object]]]

Conditions for the question to be shown

object: Optional[Literal["question"]]

question_type: Optional[Literal["rating"]]

class NumberQuestion: …

id: str

Unique identifier of the entity

created_at: datetime

ISO-timestamp when the entity was created

formatdate-time

created_by: Identity

The identity that created the entity.

id: str

type: Literal["user", "service_account"]

One of the following:

"user"

"service_account"

object: Optional[Literal["identity"]]

name: str

prompt: str

user-facing question prompt

archived_at: Optional[datetime]

ISO-timestamp when the entity was archived

formatdate-time

conditions: Optional[List[Dict[str, object]]]

Conditions for the question to be shown

configuration: Optional[NumberQuestionConfiguration]

max: Optional[float]

Maximum value for the number

min: Optional[float]

Minimum value for the number

object: Optional[Literal["question"]]

question_type: Optional[Literal["number"]]

class FreeTextQuestion: …

id: str

Unique identifier of the entity

created_at: datetime

ISO-timestamp when the entity was created

formatdate-time

created_by: Identity

The identity that created the entity.

id: str

type: Literal["user", "service_account"]

One of the following:

"user"

"service_account"

object: Optional[Literal["identity"]]

name: str

prompt: str

user-facing question prompt

archived_at: Optional[datetime]

ISO-timestamp when the entity was archived

formatdate-time

conditions: Optional[List[Dict[str, object]]]

Conditions for the question to be shown

configuration: Optional[FreeTextQuestionConfiguration]

max_length: Optional[int]

Maximum characters allowed

minimum1

min_length: Optional[int]

Minimum characters required

minimum0

object: Optional[Literal["question"]]

question_type: Optional[Literal["free_text"]]

class FormQuestion: …

id: str

Unique identifier of the entity

configuration: FormQuestionConfiguration

form_schema: Dict[str, object]

The JSON schema of the desired form object

created_at: datetime

ISO-timestamp when the entity was created

formatdate-time

created_by: Identity

The identity that created the entity.

id: str

type: Literal["user", "service_account"]

One of the following:

"user"

"service_account"

object: Optional[Literal["identity"]]

name: str

prompt: str

user-facing question prompt

archived_at: Optional[datetime]

ISO-timestamp when the entity was archived

formatdate-time

conditions: Optional[List[Dict[str, object]]]

Conditions for the question to be shown

object: Optional[Literal["question"]]

question_type: Optional[Literal["form"]]

class TimestampQuestion: …

id: str

Unique identifier of the entity

created_at: datetime

ISO-timestamp when the entity was created

formatdate-time

created_by: Identity

The identity that created the entity.

id: str

type: Literal["user", "service_account"]

One of the following:

"user"

"service_account"

object: Optional[Literal["identity"]]

name: str

prompt: str

user-facing question prompt

archived_at: Optional[datetime]

ISO-timestamp when the entity was archived

formatdate-time

conditions: Optional[List[Dict[str, object]]]

Conditions for the question to be shown

configuration: Optional[TimestampQuestionConfiguration]

multi: Optional[bool]

Whether to allow multiple timestamps

object: Optional[Literal["question"]]

question_type: Optional[Literal["timestamp"]]

class RatingQuestion: …

id: str

Unique identifier of the entity

configuration: RatingQuestionConfiguration

max_label: str

Label shown for the maximum rating

min_label: str

Label shown for the minimum rating

steps: int

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

minimum1

created_at: datetime

ISO-timestamp when the entity was created

formatdate-time

created_by: Identity

The identity that created the entity.

id: str

type: Literal["user", "service_account"]

One of the following:

"user"

"service_account"

object: Optional[Literal["identity"]]

name: str

prompt: str

user-facing question prompt

archived_at: Optional[datetime]

ISO-timestamp when the entity was archived

formatdate-time

conditions: Optional[List[Dict[str, object]]]

Conditions for the question to be shown

object: Optional[Literal["question"]]

question_type: Optional[Literal["rating"]]

class RatingQuestionConfiguration: …

max_label: str

Label shown for the maximum rating

min_label: str

Label shown for the minimum rating

steps: int

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

minimum1

class TimestampQuestion: …

id: str

Unique identifier of the entity

created_at: datetime

ISO-timestamp when the entity was created

formatdate-time

created_by: Identity

The identity that created the entity.

id: str

type: Literal["user", "service_account"]

One of the following:

"user"

"service_account"

object: Optional[Literal["identity"]]

name: str

prompt: str

user-facing question prompt

archived_at: Optional[datetime]

ISO-timestamp when the entity was archived

formatdate-time

conditions: Optional[List[Dict[str, object]]]

Conditions for the question to be shown

configuration: Optional[TimestampQuestionConfiguration]

multi: Optional[bool]

Whether to allow multiple timestamps

object: Optional[Literal["question"]]

question_type: Optional[Literal["timestamp"]]

class TimestampQuestionConfiguration: …

multi: Optional[bool]

Whether to allow multiple timestamps