Question Sets
List Question Sets
Question Sets
Question Sets
List Question Sets
GET
/
v5
/
question-sets
curl --request GET \
--url https://api.egp.scale.com/v5/question-sets \
--header 'x-api-key: <api-key>'{
"object": "list",
"items": [
{
"name": "<string>",
"instructions": "<string>",
"id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"created_by_user_id": "<string>",
"archived_at": "2023-11-07T05:31:56Z",
"object": "question_set",
"questions": [
{
"type": "categorical",
"title": "<string>",
"prompt": "<string>",
"choices": [
{
"label": "<string>",
"value": "<string>",
"audit_required": false
}
],
"ratingOptions": {
"minLabel": "<string>",
"maxLabel": "<string>",
"scaleSteps": 123
},
"numberOptions": {
"min": 123,
"max": 123
},
"multi": true,
"dropdown": true,
"required": true,
"conditions": [
{}
],
"id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"created_by_user_id": "<string>",
"object": "question",
"override_config": {
"required": false
}
}
]
}
],
"limit": 100,
"total": 123,
"has_more": true
}Authorizations
Query Parameters
Available options:
questions Required range:
1 < x < 1000Response
200
application/json
Successful Response
Available options:
question_set Questions in the question set
Available options:
categorical, free_text, rating, number Available options:
question Specifies additional configurations to use for the question in the context of the question set. For example, {required: true} sets the question as required. Writes to the question_id_to_config field on the response
Whether the question is required. False by default.
The total of items that match the query. This is greater than or equal to the number of items returned.
Whether there are more items left to be fetched.
Available options:
list The maximum number of items to return.
curl --request GET \
--url https://api.egp.scale.com/v5/question-sets \
--header 'x-api-key: <api-key>'{
"object": "list",
"items": [
{
"name": "<string>",
"instructions": "<string>",
"id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"created_by_user_id": "<string>",
"archived_at": "2023-11-07T05:31:56Z",
"object": "question_set",
"questions": [
{
"type": "categorical",
"title": "<string>",
"prompt": "<string>",
"choices": [
{
"label": "<string>",
"value": "<string>",
"audit_required": false
}
],
"ratingOptions": {
"minLabel": "<string>",
"maxLabel": "<string>",
"scaleSteps": 123
},
"numberOptions": {
"min": 123,
"max": 123
},
"multi": true,
"dropdown": true,
"required": true,
"conditions": [
{}
],
"id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"created_by_user_id": "<string>",
"object": "question",
"override_config": {
"required": false
}
}
]
}
],
"limit": 100,
"total": 123,
"has_more": true
}