Scale API | Question Sets › List Question Sets

Question Sets

question_sets

Methods

Create Question Set ->

QuestionSet

post/v4/question-sets

Description

Creates a question set

Details

This API can be used to create a question set. To use this API, review the request schema and pass in all fields that are required to create a question set.

Delete Question Set ->

GenericDeleteResponse

delete/v4/question-sets/{question_set_id}

Description

Deletes a question set

Details

This API can be used to delete a question set by ID. To use this API, pass in the id that was returned from your Create Question Set API call as a path parameter.

List Question Sets -> PageResponse<{ id, account_id, created_at, 6 more... }>

get/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.

Security

API Key Header

Example: x-api-key: My API Key

Parameters

account_id: string

Optional

include_archived: boolean

Optional

limit: number

Optional

Maximum number of artifacts to be returned by the given endpoint. Defaults to 100 and cannot be greater than 10k.

page: number

Optional

Page number for pagination to be returned by the given endpoint. Starts at page 1

view: Array<

Optional

"Questions"

Response fields

PaginatedQuestionSets

Request example

curl https://api.egp.scale.com/v4/question-sets \
    -H "x-api-key: $SGP_API_KEY"

200Example

{
  "current_page": 0,
  "items": [
    {
      "id": "id",
      "account_id": "account_id",
      "created_at": "2019-12-27T18:11:19.117Z",
      "created_by_user_id": "created_by_user_id",
      "name": "name",
      "archived_at": "2019-12-27T18:11:19.117Z",
      "instructions": "instructions",
      "question_id_to_config": {
        "foo": {
          "required": true
        }
      },
      "questions": [
        {
          "id": "id",
          "account_id": "account_id",
          "created_at": "2019-12-27T18:11:19.117Z",
          "created_by_user_id": "created_by_user_id",
          "prompt": "prompt",
          "title": "title",
          "type": "categorical",
          "choices": [
            {
              "label": "label",
              "value": "string",
              "audit_required": true
            }
          ],
          "conditions": [
            {}
          ],
          "dropdown": true,
          "multi": true,
          "numberOptions": {
            "max": 0,
            "min": 0
          },
          "ratingOptions": {
            "maxLabel": "maxLabel",
            "minLabel": "minLabel",
            "scaleSteps": 0
          },
          "required": true
        }
      ]
    }
  ],
  "items_per_page": 0,
  "total_item_count": 0
}

Get Question Set ->

QuestionSetWithQuestions

get/v4/question-sets/{question_set_id}

Get Question Set

Update Question Set ->

QuestionSet

patch/v4/question-sets/{question_set_id}

Description

Updates a question set

Details

This API can be used to update the question set that matches the ID that was passed in as a path parameter. To use this API, pass in the id that was returned from your Create Question Set API call as a path parameter.

Review the request schema to see the fields that can be updated.

Domain types

PaginatedQuestionSets = { current_page, items, items_per_page, 1 more... }

QuestionSet = { id, account_id, created_at, 5 more... }

QuestionSetWithQuestions = { id, account_id, created_at, 6 more... }