List Question Sets

get https://api.egp.scale.com/v4/question-sets

Description

Lists all question sets accessible to the user.

Details

This API can be used to list question sets. If a user has access to multiple accounts, all question sets from all accounts the user is associated with will be returned.

Responses

Response body

object

items

array of objects

required

The data returned for the current page.

Paginated list of QuestionSetResponseWithViews*

object

questions

array of objects

Questions

object

type

string

required

The type of question

categorical free_text rating number

title

string

required

prompt

string

required

choices

array of objects

List of choices for the question. Required for CATEGORICAL questions.

Choices

object

label

string

required

value

required

audit_required

boolean

Defaults to false

ratingOptions

object

Options for rating questions.

numberOptions

object

Options for number questions.

freeTextOptions

object

Options for free text questions.

multi

boolean

Whether the question allows multiple answers.

dropdown

boolean

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

required

boolean

[To be deprecated in favor of question set question_id_to_config] Whether the question is required.

conditions

array of objects

Conditions for the question to be shown.

Conditions

object

default

string

The default value for the question.

string

required

The unique identifier of the entity.

created_at

date-time

required

The date and time when the entity was created in ISO format.

account_id

string

required

The ID of the account that owns the given entity.

created_by_user_id

string

required

The user who originally created the entity.

name

string

required

question_id_to_config

object

Specifies additional configurations to use for specific questions in the context of the question set. For example, {<question_a_id>: {required: true}, <question_b_id>: {required: true}} sets two questions as required.

instructions

string

Instructions to answer questions

string

required

The unique identifier of the entity.

created_at

date-time

required

The date and time when the entity was created in ISO format.

account_id

string

required

The ID of the account that owns the given entity.

created_by_user_id

string

required

The user who originally created the entity.

archived_at

date-time

The date and time when the entity was archived in ISO format.

total_item_count

integer

required

The total number of items of the query

current_page

integer

required

The current page number.

items_per_page

integer

required

The number of items per page.

Language

Credentials

Header

Request


xxxxxxxxxx
1
curl --request GET \
2
     --url 'https://api.egp.scale.com/v4/question-sets?page=1&limit=100&include_archived=false' \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successful Response

422Validation Error