Scale API

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.

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... }