Skip to content
sgp
API Reference
Questions

Get a question

questions.retrieve(strquestion_id) -> Question
GET/v5/questions/{question_id}

Retrieve a single question in the caller’s account by its ID.

Both active and archived questions are returned; the archived state is conveyed by the archived_at field on the response. The lookup is scoped to the caller’s account, and a question that does not exist within that account results in a not-found error.

ParametersExpand Collapse
question_id: str
ReturnsExpand Collapse
One of the following:
class CategoricalQuestion: …
id: str

Unique identifier of the entity

choices: List[str]

Categorical answer choices (must contain at least one entry)

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

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

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"]]

Get a question

import os
from scale_gp_beta import SGPClient

client = SGPClient(
    api_key=os.environ.get("SGP_API_KEY"),  # This is the default and can be omitted
)
question = client.questions.retrieve(
    "question_id",
)
print(question)
{
  "id": "id",
  "configuration": {
    "choices": [
      "string"
    ],
    "dropdown": true,
    "multi": true
  },
  "created_at": "2019-12-27T18:11:19.117Z",
  "created_by": {
    "id": "id",
    "type": "user",
    "object": "identity"
  },
  "name": "name",
  "prompt": "prompt",
  "archived_at": "2019-12-27T18:11:19.117Z",
  "conditions": [
    {
      "foo": "bar"
    }
  ],
  "object": "question",
  "question_type": "categorical"
}
Returns Examples
{
  "id": "id",
  "configuration": {
    "choices": [
      "string"
    ],
    "dropdown": true,
    "multi": true
  },
  "created_at": "2019-12-27T18:11:19.117Z",
  "created_by": {
    "id": "id",
    "type": "user",
    "object": "identity"
  },
  "name": "name",
  "prompt": "prompt",
  "archived_at": "2019-12-27T18:11:19.117Z",
  "conditions": [
    {
      "foo": "bar"
    }
  ],
  "object": "question",
  "question_type": "categorical"
}